com.amazonaws.services.cloudsearch.model

## クラス NamedRankExpression

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

- すべての実装されたインタフェース:
    java.io.Serializable

      public class NamedRankExpression
      extends java.lang.Object
      implements java.io.Serializable

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

  関連項目:
    直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `NamedRankExpression()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getRankExpression()` The expression to evaluate for ranking or thresholding while processing a search request.
    `java.lang.String` | `getRankName()` The name of a rank expression.
    `int` | `hashCode()`
    `void` | `setRankExpression(java.lang.String rankExpression)` The expression to evaluate for ranking or thresholding while processing a search request.
    `void` | `setRankName(java.lang.String rankName)` The name of a rank expression.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `NamedRankExpression` | `withRankExpression(java.lang.String rankExpression)` The expression to evaluate for ranking or thresholding while processing a search request.
    `NamedRankExpression` | `withRankName(java.lang.String rankName)` The name of a rank expression.

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### NamedRankExpression

          public NamedRankExpression()

  - ### メソッドの詳細

    - #### getRankName

          public java.lang.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_]*

      戻り値:
        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(java.lang.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_]*

      パラメータ:
        `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(java.lang.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_]*

      パラメータ:
        `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.

    - #### getRankExpression

          public java.lang.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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`