Class SuggestedTerm

• Object
  • dw.suggest.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.

Properties

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.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getValue() : String

Returns this suggested term as String value.

isAdditional() : boolean

Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.

isCompleted() : boolean

Returns whether this suggested term is a auto completed version of the original term.

isCorrected() : boolean

Returns whether this suggested term is a corrected version of the original term.

isExactMatch() : boolean

Returns whether this suggested term is exactly matching the original term.

Methods inherited from class Object

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

Method Detail

getValue

getValue() : String

Returns this suggested term as String value.

Returns:

the string representation of this suggested term

isAdditional

isAdditional() : boolean

Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.

Returns:

true if this suggested term is a additional term, false otherwise

isCompleted

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:

true if this suggested term is evaluated by auto completion, false otherwise

isCorrected

isCorrected() : boolean

Returns whether this suggested term is a corrected version of the original term.

Returns:

true if this suggested term is a corrected version of the original term, false otherwise

isExactMatch

isExactMatch() : boolean

Returns whether this suggested term is exactly matching the original term.

Returns:

true if this suggested term exactly matches the original term, false otherwise