public class NamedRankExpression extends Object implements Serializable
A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.
| Constructor and Description |
|---|
NamedRankExpression() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getRankExpression()
The expression to evaluate for ranking or thresholding while
processing a search request.
|
String |
getRankName()
The name of a rank expression.
|
int |
hashCode() |
void |
setRankExpression(String rankExpression)
The expression to evaluate for ranking or thresholding while
processing a search request.
|
void |
setRankName(String rankName)
The name of a rank expression.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
NamedRankExpression |
withRankExpression(String rankExpression)
The expression to evaluate for ranking or thresholding while
processing a search request.
|
NamedRankExpression |
withRankName(String rankName)
The name of a rank expression.
|
public String getRankName()
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
public void setRankName(String rankName)
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
rankName - The name of a rank expression. Rank expression names must begin with a
letter and can contain the following characters: a-z (lowercase), 0-9,
and _ (underscore). Uppercase letters and hyphens are not allowed. The
names "body", "docid", and "text_relevance" are reserved and cannot be
specified as field or rank expression names.public NamedRankExpression withRankName(String rankName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
rankName - The name of a rank expression. Rank expression names must begin with a
letter and can contain the following characters: a-z (lowercase), 0-9,
and _ (underscore). Uppercase letters and hyphens are not allowed. The
names "body", "docid", and "text_relevance" are reserved and cannot be
specified as field or rank expression names.public String getRankExpression()
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
public void setRankExpression(String rankExpression)
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
rankExpression - The expression to evaluate for ranking or thresholding while
processing a search request. The RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
public NamedRankExpression withRankExpression(String rankExpression)
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 10240
rankExpression - The expression to evaluate for ranking or thresholding while
processing a search request. The RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
public String toString()
toString in class ObjectObject.toString()Copyright © 2016. All rights reserved.