QueryOptions(Google App Engine API for Java)

com.google.appengine.api.search

クラス QueryOptions

  • java.lang.Object
    • com.google.appengine.api.search.QueryOptions


  • public final class QueryOptions
    extends java.lang.Object
    返される検索結果の場所と内容を制御するオプションを表します。返されるドキュメント フィールドを指定されたフィールドに制限したり、結果をスコア付けして並べ替えたり、ページ設定をサポートしたりします。

    たとえば、次のオプションは、いくつかの指定されたクエリに対する検索結果からドキュメントを返し、「author」フィールドと「date-sent」フィールドの他に、スニペット フィールド「subject」と「body」のスニペット化されたフィールドを含む最大 20 件の結果を返します。この結果は「author」によって降順に並べ替えられ、以前に返された結果の responseCursor から次の 20 件の結果を取得し、その後に結果の次のバッチを取得するために Results にカーソルを 1 つ返ます。

     QueryOptions request = QueryOptions.newBuilder()
          .setLimit(20)
          .setFieldsToReturn("author", "date-sent")
          .setFieldsToSnippet("subject", "body")
          .setSortOptions(SortOptions.newBuilder().
              .addSortExpression(SortExpression.newBuilder()
                  .setExpression("author")
                  .setDirection(Scorer.SortDirection.DESCENDING)
                  .setDefaultValue("")))
    
          .setCursor(Cursor.newBuilder().build())
          .build();
     
    • メソッドの詳細

      • getLimit

        public int getLimit()
        戻り値:
        検索結果で返すドキュメント数の制限
      • getCursor

        public Cursor getCursor()
        戻り値:
        次の結果セットを取得する場合に、開始点として使用するため、前の検索結果セットで返されたカーソル。null の場合もあります。
      • getOffset

        public int getOffset()
        戻り値:
        返す最初の結果のオフセット。設定されていない場合は 0 を返します。
      • hasNumberFoundAccuracy

        public boolean hasNumberFoundAccuracy()
        精度要件が設定されている場合は true をします。
        戻り値:
        見つかった数の精度
      • getNumberFoundAccuracy

        public int getNumberFoundAccuracy()
        この設定を下回る Results.getNumberFound() は正確です。
        戻り値:
        見つかった数の精度
      • getSortOptions

        public SortOptions getSortOptions()
        戻り値:
        Results のドキュメントをソートする方法を指定する SortOptions
      • isReturningIdsOnly

        public boolean isReturningIdsOnly()
        戻り値:
        この検索リクエストで、結果のドキュメント ID のみを返すかどうか
      • getFieldsToReturn

        public java.util.List<java.lang.String> getFieldsToReturn()
        戻り値:
        検索結果で返される変更できないフィールドの名前のリスト
      • getFieldsToSnippet

        public java.util.List<java.lang.String> getFieldsToSnippet()
        戻り値:
        検索結果のスニペットの変更できないフィールドの名前のリスト
      • getExpressionsToReturn

        public java.util.List<FieldExpression> getExpressionsToReturn()
        戻り値:
        評価されて結果に返される、変更できない式のリスト
      • newBuilder

        public static QueryOptions.Builder newBuilder(QueryOptions request)
        指定されたリクエストからビルダーを作成します。
        パラメータ:
        request - ビルダーが別のリクエストを構築するために使用する検索リクエスト
        戻り値:
        指定したリクエストからの値を設定する新しいビルダー
      • toString

        public java.lang.String toString()
        オーバーライド:
        toString - クラス java.lang.Object
このページは役立ちましたか?評価をお願いいたします。

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

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