com.google.appengine.api.search
Class SortExpression
- java.lang.Object
-
- com.google.appengine.api.search.SortExpression
-
public final class SortExpression extends java.lang.Object
Sorting specification for a single dimension. Multi-dimensional sorting is supported by a collection of SortExpressions.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
SortExpression.Builder
A builder that constructsSortExpressions
.static class
SortExpression.SortDirection
The direction search results are sorted by, either ascending or descending.
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
DOCUMENT_ID_FIELD_NAME
The expression to be used if you wish to sort by document id fieldDocument.getId()
.static java.lang.String
LANGUAGE_FIELD_NAME
The expression to be used if you wish to sort by language code associated with the locale fieldDocument.getLocale()
.static java.lang.String
RANK_FIELD_NAME
The expression to be used if you wish to sort by rank field.static java.lang.String
SCORE_FIELD_NAME
The expression to be used if you wish to sort by document score.static java.lang.String
TIMESTAMP_FIELD_NAME
The expression to be used if you wish to sort by seconds since EPOCH that the document was written.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description java.lang.String
getDefaultValue()
java.util.Date
getDefaultValueDate()
java.lang.Double
getDefaultValueNumeric()
SortExpression.SortDirection
getDirection()
java.lang.String
getExpression()
static SortExpression.Builder
newBuilder()
Creates and returns a SortExpression Builder.java.lang.String
toString()
-
-
-
Field Detail
-
DOCUMENT_ID_FIELD_NAME
public static final java.lang.String DOCUMENT_ID_FIELD_NAME
The expression to be used if you wish to sort by document id fieldDocument.getId()
. You need to create a sort expression asSortExpression expr = SortExpression.newBuilder() .setExpression(SortExpression.DOCUMENT_ID_FIELD_NAME) .setDefaultValue("") .build();
- See Also:
- Constant Field Values
-
LANGUAGE_FIELD_NAME
public static final java.lang.String LANGUAGE_FIELD_NAME
The expression to be used if you wish to sort by language code associated with the locale fieldDocument.getLocale()
. You need to create a sort expression asSortExpression expr = SortExpression.newBuilder() .setExpression(SortExpression.LANGUAGE_FIELD_NAME) .setDefaultValue("") .build();
- See Also:
- Constant Field Values
-
RANK_FIELD_NAME
public static final java.lang.String RANK_FIELD_NAME
The expression to be used if you wish to sort by rank field. By default, results are sorted in descending value of rank. To sort in ascending order, you need to create a sort expression asSortExpression expr = SortExpression.newBuilder() .setExpression(SortExpression.RANK_FIELD_NAME) .setDirection(SortExpression.SortDirection.ASCENDING) .setDefaultValueNumeric(0) .build();
- See Also:
- Constant Field Values
-
SCORE_FIELD_NAME
public static final java.lang.String SCORE_FIELD_NAME
The expression to be used if you wish to sort by document score. You need to create a sort expression asSortExpression expr = SortExpression.newBuilder() .setExpression(String.format( "%s + rating * 0.01", SortExpression.SCORE_FIELD_NAME)) .setDirection(SortExpression.SortDirection.DESCENDING) .setDefaultValueNumeric(0) .build();
- See Also:
- Constant Field Values
-
TIMESTAMP_FIELD_NAME
public static final java.lang.String TIMESTAMP_FIELD_NAME
The expression to be used if you wish to sort by seconds since EPOCH that the document was written. You need to create a sort expression asSortExpression expr = SortExpression.newBuilder() .setExpression(SortExpression.TIMESTAMP_FIELD_NAME) .setDefaultValueNumeric(0) .build();
- See Also:
- Constant Field Values
-
-
Method Detail
-
getExpression
public java.lang.String getExpression()
- Returns:
- the expression to evaluate for each document and sort by
-
getDirection
public SortExpression.SortDirection getDirection()
- Returns:
- the direction to sort the search results in
-
getDefaultValue
public java.lang.String getDefaultValue()
- Returns:
- the default value for the field. Can be null
-
getDefaultValueNumeric
public java.lang.Double getDefaultValueNumeric()
- Returns:
- the default numeric value for the field. Can be null
-
getDefaultValueDate
public java.util.Date getDefaultValueDate()
- Returns:
- the default date value for the field. Can be null
-
newBuilder
public static SortExpression.Builder newBuilder()
Creates and returns a SortExpression Builder.- Returns:
- a new
SortExpression.Builder
. Set the parameters for the sort specification on the Builder, and use theSortExpression.Builder.build()
method to create a concrete instance of SortExpression
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-