com.endeca.navigation
Class ESearchDYMSuggestion

java.lang.Object
  com.endeca.navigation.ESearchDYMSuggestion

public class ESearchDYMSuggestion
extends Object

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

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.
long	getNumMatchingResults() Returns the number of results that will match if this suggestion is used in a search.
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.

getNumMatchingResults

public long getNumMatchingResults()

Returns the number of results that will match if this suggestion is used in a search.

Returns:

The number of results that will match when using this 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.