com.amazonaws.services.cloudsearch.model
Class NamedRankExpression

java.lang.Object
  com.amazonaws.services.cloudsearch.model.NamedRankExpression

All Implemented Interfaces:

Serializable

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.

See Also:

Serialized Form

Constructor Summary

NamedRankExpression()

Method Summary

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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedRankExpression

public NamedRankExpression()

Method Detail

getRankName

public String getRankName()

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.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Returns:

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.

setRankName

public void setRankName(String 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.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

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.

withRankName

public NamedRankExpression withRankName(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getRankExpression

public String getRankExpression()

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate 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

Returns:

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate 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.

setRankExpression

public void setRankExpression(String rankExpression)

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate 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

Parameters:

rankExpression - The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate 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.

withRankExpression

public NamedRankExpression withRankExpression(String rankExpression)

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate 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

Parameters:

rankExpression - The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate 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 updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object