com.endeca.mobile.abstraction
Class SearchMetaInfoAbstraction

java.lang.Object
  com.endeca.mobile.abstraction.SearchMetaInfoAbstraction

public final class SearchMetaInfoAbstraction
extends java.lang.Object

The SearchMetaInfoAbstractionPlugin retrieves information related to any searches that have been done (for instance, spell-correction, terms and keys searched on, etc.) It adds its data to the AbstractedResults object, under the key "Search Info". If no search information is relevant to the current navigation/search state, this key will not exist.

All information added to the AbstractedResult object by the SearchMetaInfoAbstractionPlugin is contained within one master hash. This hash is keyed by the name of each search key (e.g. search interface) that was searched against. Each value in it is itself a hash. (This hash is roughly equivalent to the search reports returned by the Endeca API.)

For each of the hashes within each search key, the following keys are available:

Search Term

contains a string representation of the search term(s) sent in for that search

Spell Correction

contains an array of applied spelling corrections. Each spelling correction in the array is a hash containing the following keys:

New Term	indicating what the term was corrected to
AutoPhrasing	containing a boolean indicating whether autophrasing was used
Spell Correction	containing a boolean indicating whether the term was spell-corrected

DYM Information

contains an array of suggested "did you mean" corrections. Each suggestion in the array is a hash containing the following keys:

New Term	indicating what the term was corrected to
AutoPhrasing	containing a boolean indicating whether autophrasing was used
Spell Correction	containing a boolean indicating whether the term was spell-corrected
Number of Results	containing a number identifying how many results will match if this suggestion is used in a search
Pivot Link	containing link to the search results page for the suggested term

Constructor Summary

SearchMetaInfoAbstraction()

Method Summary

static java.util.HashMap

abstractifySearchMetaInfo(com.endeca.navigation.Navigation mNavigation)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchMetaInfoAbstraction

public SearchMetaInfoAbstraction()

Method Detail

abstractifySearchMetaInfo

public static java.util.HashMap abstractifySearchMetaInfo(com.endeca.navigation.Navigation mNavigation)