Class SuggestedTerms

This container represents a list of suggested terms, all belonging to a particular single original term of the users input search phrase.

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 they are known to the engine as they are.

A instance of this class refers to the original unmodified term, as well as to a list of SuggestedTerms objects representing a single suggested term.

Property Summary 

PropertyDescription
empty: Boolean (read-only)Returns true if this set of suggested terms is empty.
firstTerm: SuggestedTerm (read-only)This method returns the suggested term which is considered best matching with the original term.
originalTerm: String (read-only)Returns the original term of the user input, for which this instance provides a list of suggested terms.
terms: Iterator (read-only)Returns the list of SuggestedTerms suggested for the original term.

Constructor Summary 

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

Method Summary 

MethodDescription
getFirstTerm()This method returns the suggested term which is considered best matching with the original term.
getOriginalTerm()Returns the original term of the user input, for which this instance provides a list of suggested terms.
getTerms()Returns the list of SuggestedTerms suggested for the original term.
isEmpty()Returns true if this set of suggested terms is empty.

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

Property Details 

empty 

empty: Boolean (read-only)

Returns true if this set of suggested terms is empty.


firstTerm 

firstTerm: SuggestedTerm (read-only)

This method returns the suggested term which is considered best matching with the original term. See getTerms() for a note on ordering of suggested terms.

See Also:


originalTerm 

originalTerm: String (read-only)

Returns the original term of the user input, for which this instance provides a list of suggested terms. Suggested terms can either be corrected, or completed or exact matching.


terms 

terms: Iterator (read-only)

Returns the list of SuggestedTerms suggested for the original term.

See Also:


Method Details 

getFirstTerm() 

getFirstTerm(): SuggestedTerm

This method returns the suggested term which is considered best matching with the original term. See getTerms() for a note on ordering of suggested terms.

Returns:

  • the best matching term

See Also:


getOriginalTerm() 

getOriginalTerm(): String

Returns the original term of the user input, for which this instance provides a list of suggested terms. Suggested terms can either be corrected, or completed or exact matching.

Returns:

  • the original unmodified term of the user input search phrase

getTerms() 

getTerms(): Iterator

Returns the list of SuggestedTerms suggested for the original term.

Returns:

  • a iterator of suggested terms, might be empty

See Also:


isEmpty() 

isEmpty(): Boolean

Returns true if this set of suggested terms is empty.

Returns:

  • true if no suggested term is contained in this set, false otherwise