com.endeca.navigation
Class ESearchAutoSuggestion

java.lang.Object
  com.endeca.navigation.ESearchAutoSuggestion

public class ESearchAutoSuggestion
extends Object

ESearchAutoSuggestion represents a single alternate spelling suggestion made by the MDEX Engine when a record search is performed. A list of ESearchAutoSuggestion objects can be obtained from ESearchReport.getAutoSuggestions().

Method Summary

boolean	didSuggestionIncludeAutomaticPhrasing() Determines whether this suggestion includes one or more contiguous subsequences of terms that were phrased by the Automatic Phrasing feature of the Endeca MDEX Engine.
boolean	didSuggestionIncludeSpellingCorrection() Determines whether this suggestion includes one or more terms that were spell-corrected by the Spelling Correction feature of the Endeca MDEX Engine.
String	getTerms() Returns the terms for the spelling suggestion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTerms

public String getTerms()

Returns the terms for the spelling suggestion.

Returns:

The terms for the spelling suggestion.

didSuggestionIncludeSpellingCorrection

public boolean didSuggestionIncludeSpellingCorrection()

Determines whether this suggestion includes one or more terms that were spell-corrected by the Spelling Correction feature of the Endeca MDEX Engine. This is useful if the application developer wants to know what features engaged in the MDEX Engine when generating a suggestion.

Returns:

true if the terms were spell-corrected, or false otherwise.

didSuggestionIncludeAutomaticPhrasing

public boolean didSuggestionIncludeAutomaticPhrasing()

Determines whether this suggestion includes one or more contiguous subsequences of terms that were phrased by the Automatic Phrasing feature of the Endeca MDEX Engine. This is useful if the application developer wants to know what features engaged in the MDEX Engine when generating a suggestion.

Returns:

true if the terms were auto-phrased, or false otherwise.