FieldChecker(Google App Engine API for Java)

com.google.appengine.api.search.checkers

クラス FieldChecker

  • java.lang.Object
    • com.google.appengine.api.search.checkers.FieldChecker


  • public final class FieldChecker
    extends java.lang.Object
    フィールド名、言語コード、値(テキスト、HTML、Atom、日付)を確認します。
    • コンストラクタの概要

      コンストラクタ 
      コンストラクタと説明
      FieldChecker() 
    • メソッドの概要

      すべてのメソッド 静的メソッド 具象メソッド 
      修飾子と型 メソッドと説明
      static java.lang.String checkAtom(java.lang.String atom)
      Atom が有効かどうかを確認します。
      static java.util.Date checkDate(java.util.Date date)
      日付が範囲内にあるかどうかを確認します。
      static java.lang.String checkExpression(java.lang.String expression)
      フィールド式が null ではなく、解析可能かどうかを確認します。
      static java.lang.String checkFieldName(java.lang.String name)
      フィールド名が有効かどうかを確認します。
      static java.lang.String checkFieldName(java.lang.String name, java.lang.String fieldName)
      フィールド名が有効かどうかを確認します。
      static java.lang.String checkHTML(java.lang.String html)
      html が有効かどうかを確認します。
      static java.lang.Double checkNumber(java.lang.Double value)
      数字が有効かどうかを確認します。
      static java.lang.String checkPrefix(java.lang.String prefix)
      接頭辞フィールドが有効かどうかを確認します。
      static java.lang.String checkSortExpression(java.lang.String expression)
      並べ替えの式が null ではなく、解析可能かどうかを確認します。
      static java.lang.String checkText(java.lang.String text)
      テキストが有効かどうかを確認します。
      static DocumentPb.Field checkValid(DocumentPb.Field field) 
      static java.util.List<java.lang.Double> checkVector(java.util.List<java.lang.Double> vector)
      ベクトル フィールドが有効かどうかを確認します。
      static java.util.Locale parseLocale(java.lang.String locale)
      指定したロケール文字列から解析された Locale を返します。
      • クラス java.lang.Object から継承されたメソッド

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • コンストラクタの詳細

      • FieldChecker

        public FieldChecker()
    • メソッドの詳細

      • checkFieldName

        public static java.lang.String checkFieldName(java.lang.String name)
        フィールド名が有効かどうかを確認します。フィールド名の長さは、1~SearchApiLimits.MAXIMUM_NAME_LENGTH であり、SearchApiLimits.FIELD_NAME_PATTERN と一致する必要があります。
        パラメータ:
        name - 確認するフィールド名
        戻り値:
        確認されたフィールド名
        スロー:
        java.lang.IllegalArgumentException - フィールド名が null または空であるか、SearchApiLimits#MAXIMUM_NAME_LENGTH よりも長いか、または #FIELD_NAME_PATTERN と一致しない場合。
      • checkFieldName

        public static java.lang.String checkFieldName(java.lang.String name,
                                                      java.lang.String fieldName)
        フィールド名が有効かどうかを確認します。フィールド名の長さは、1~SearchApiLimits.MAXIMUM_NAME_LENGTH であり、SearchApiLimits.FIELD_NAME_PATTERN と一致する必要があります。
        パラメータ:
        name - 確認するフィールド名
        fieldName - 名前を確認するクラスの Java フィールドの名前
        戻り値:
        確認されたフィールド名
        スロー:
        java.lang.IllegalArgumentException - フィールド名が null または空であるか、Field.MAXIMUM_NAME_LENGTH よりも長いか、または #FIELD_NAME_PATTERN と一致しない場合。
      • checkText

        public static java.lang.String checkText(java.lang.String text)
        テキストが有効かどうかを確認します。テキストは null、または長さが 0~SearchApiLimits.MAXIMUM_TEXT_LENGTH の文字列にすることができます。
        パラメータ:
        text - 確認するテキスト
        戻り値:
        確認されたテキスト
        スロー:
        java.lang.IllegalArgumentException - テキストが長すぎる場合
      • checkHTML

        public static java.lang.String checkHTML(java.lang.String html)
        html が有効かどうかを確認します。html は null、または長さが 0~SearchApiLimits.MAXIMUM_TEXT_LENGTH の文字列にすることができます。
        パラメータ:
        html - 確認する html
        戻り値:
        確認された html
        スロー:
        java.lang.IllegalArgumentException - html が長すぎる場合
      • checkAtom

        public static java.lang.String checkAtom(java.lang.String atom)
        アトムが有効かどうかを確認します。アトムは null、または長さが 1~SearchApiLimits.MAXIMUM_ATOM_LENGTH の文字列にすることができます。
        パラメータ:
        atom - 確認するアトム
        戻り値:
        確認されたアトム
        スロー:
        java.lang.IllegalArgumentException - アトムが長すぎる場合
      • checkPrefix

        public static java.lang.String checkPrefix(java.lang.String prefix)
        接頭辞フィールドが有効かどうかを確認します。接頭辞フィールドは null、または長さが 1~SearchApiLimits.MAXIMUM_PREFIX_LENGTH の文字列にすることができます。
        パラメータ:
        prefix - 確認する接頭辞
        戻り値:
        確認された接頭辞
        スロー:
        java.lang.IllegalArgumentException - 接頭辞が長すぎる場合
      • checkVector

        public static java.util.List<java.lang.Double> checkVector(java.util.List<java.lang.Double> vector)
        ベクトル フィールドが有効かどうかを確認します。ベクトル フィールドはサイズが SearchApiLimits.VECTOR_FIELD_MAX_SIZE よりも小さい任意の数の配列にすることができます。
        パラメータ:
        vector - 確認するベクトル
        スロー:
        java.lang.IllegalArgumentException - ベクトルが長すぎる場合
      • checkNumber

        public static java.lang.Double checkNumber(java.lang.Double value)
        数字が有効かどうかを確認します。数字は null、または SearchApiLimits.MINIMUM_NUMBER_VALUE 以上 SearchApiLimits.MAXIMUM_NUMBER_VALUE 以下の値にすることができます。
        パラメータ:
        value - 確認する値
        戻り値:
        確認された数字
        スロー:
        java.lang.IllegalArgumentException - 数字が範囲外の場合
      • checkDate

        public static java.util.Date checkDate(java.util.Date date)
                                        throws java.lang.IllegalArgumentException
        日付が範囲内にあるかどうかを確認します。日付には null 値を指定できます。
        パラメータ:
        date - 確認する日付
        戻り値:
        確認された日付
        スロー:
        java.lang.IllegalArgumentException - 日付が範囲外の場合
      • checkExpression

        public static java.lang.String checkExpression(java.lang.String expression)
        フィールド式が null ではなく、解析可能かどうかを確認します。
        パラメータ:
        expression - 確認する式
        戻り値:
        確認された式
        スロー:
        java.lang.IllegalArgumentException - 式が null であるか、または解析できない場合
      • checkSortExpression

        public static java.lang.String checkSortExpression(java.lang.String expression)
        並べ替えの式が null ではなく、解析可能かどうかを確認します。
        パラメータ:
        expression - 確認する式
        戻り値:
        確認された式
        スロー:
        java.lang.IllegalArgumentException - 式が null であるか、または解析できない場合
      • checkValid

        public static DocumentPb.Field checkValid(DocumentPb.Field field)
      • parseLocale

        public static java.util.Locale parseLocale(java.lang.String locale)
        指定したロケール文字列から解析された Locale を返します。
        パラメータ:
        locale - Locale の文字列表現
        戻り値:
        指定したロケール文字列から解析された Locale
        スロー:
        java.lang.IllegalArgumentException - ロケールを解析できない場合
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境