Class SuggestedTerm
A single suggested term.
Each user input term of the search phrase is being processed separately by the suggestion engine. For each original term, a list of terms will be suggested, either completed terms, corrected terms or even the exact term if it is known to the engine.
Each suggested term is represented by a instance of this class. The list of suggested terms belonging to a single original term is represented by a instance of SuggestedTerms class.
The suggested term value can either be the completed version of the original term, the corrected version of the original term or exactly the original term.
| Property | Description |
|---|---|
additional: Boolean (read-only) | Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase. |
completed: Boolean (read-only) | Returns whether this suggested term is a auto completed version of the original term. |
corrected: Boolean (read-only) | Returns whether this suggested term is a corrected version of the original term. |
exactMatch: Boolean (read-only) | Returns whether this suggested term is exactly matching the original term. |
value: String (read-only) | Returns this suggested term as String value. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getValue() | Returns this suggested term as String value. |
| isAdditional() | Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase. |
| isCompleted() | Returns whether this suggested term is a auto completed version of the original term. |
| isCorrected() | Returns whether this suggested term is a corrected version of the original term. |
| isExactMatch() | Returns whether this suggested term is exactly matching the original term. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- additional: Boolean
(read-only) Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
- completed: Boolean
(read-only) Returns whether this suggested term is a auto completed version of the original term. In other words, this method returns true if the original term is a prefix of this suggested term.
- corrected: Boolean
(read-only) Returns whether this suggested term is a corrected version of the original term.
- exactMatch: Boolean
(read-only) Returns whether this suggested term is exactly matching the original term.
- value: String
(read-only) Returns this suggested term as String value.
- getValue(): String
Returns this suggested term as String value.
Returns:
- the string representation of this suggested term
- isAdditional(): Boolean
Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
Returns:
trueif this suggested term is a additional term,falseotherwise
- isCompleted(): Boolean
Returns whether this suggested term is a auto completed version of the original term. In other words, this method returns true if the original term is a prefix of this suggested term.
Returns:
trueif this suggested term is evaluated by auto completion,falseotherwise
- isCorrected(): Boolean
Returns whether this suggested term is a corrected version of the original term.
Returns:
trueif this suggested term is a corrected version of the original term,falseotherwise
- isExactMatch(): Boolean
Returns whether this suggested term is exactly matching the original term.
Returns:
trueif this suggested term exactly matches the original term,falseotherwise