com.google.appengine.api.search
Class SortOptions
- java.lang.Object
-
- com.google.appengine.api.search.SortOptions
-
public final class SortOptions extends java.lang.ObjectDefinition of how to sort documents. You may specify zero or more sort expressions and set a match scorer. If you have a large index, it is advisable to set a limit.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classSortOptions.BuilderA builder that constructsSortOptionss.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intgetLimit()MatchScorergetMatchScorer()java.util.List<SortExpression>getSortExpressions()static SortOptions.BuildernewBuilder()Creates and returns a SortOptions Builder.java.lang.StringtoString()
-
-
-
Method Detail
-
getSortExpressions
public java.util.List<SortExpression> getSortExpressions()
- Returns:
- a list of sort expressions representing a multi-dimensional sort
-
getMatchScorer
public MatchScorer getMatchScorer()
- Returns:
- a
MatchScorerused to score the documents
-
getLimit
public int getLimit()
- Returns:
- the limit on the number of documents to score or sort
-
newBuilder
public static SortOptions.Builder newBuilder()
Creates and returns a SortOptions Builder.- Returns:
- a new
SortOptions.Builder. Set the parameters for SortOptions on the Builder, and use theSortOptions.Builder.build()method to create a concrete instance of SortOptions
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-