Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.cloudsearch.model;
 

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

 
 public class NamedRankExpression implements Serializable {

    
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_]*

 
     private String rankName;

    
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 evaluating b at all
  • JavaScript order of precedence 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

 
     private String rankExpression;

    
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.
 
     public String getRankName() {
         return ;
     }
    
    
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.
    public void setRankName(String rankName) {
        this. = 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.
    public NamedRankExpression withRankName(String rankName) {
        this. = rankName;
        return this;
    }

    
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 evaluating b at all
  • JavaScript order of precedence 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 evaluating b at all
  • JavaScript order of precedence 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.

    public String getRankExpression() {
        return ;
    }
    
    
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 evaluating b at all
  • JavaScript order of precedence 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 evaluating b at all
  • JavaScript order of precedence 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.

    public void setRankExpression(String rankExpression) {
        this. = 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 evaluating b at all
  • JavaScript order of precedence 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 evaluating b at all
  • JavaScript order of precedence 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.
    public NamedRankExpression withRankExpression(String rankExpression) {
        this. = rankExpression;
        return this;
    }

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

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getRankName() != nullsb.append("RankName: " + getRankName() + ",");
        if (getRankExpression() != nullsb.append("RankExpression: " + getRankExpression() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getRankName() == null) ? 0 : getRankName().hashCode()); 
        hashCode = prime * hashCode + ((getRankExpression() == null) ? 0 : getRankExpression().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof NamedRankExpression == falsereturn false;
        NamedRankExpression other = (NamedRankExpression)obj;
        
        if (other.getRankName() == null ^ this.getRankName() == nullreturn false;
        if (other.getRankName() != null && other.getRankName().equals(this.getRankName()) == falsereturn false
        if (other.getRankExpression() == null ^ this.getRankExpression() == nullreturn false;
        if (other.getRankExpression() != null && other.getRankExpression().equals(this.getRankExpression()) == falsereturn false
        return true;
    }
    
}
    
New to GrepCode? Check out our FAQ X