com.endeca.infront.cartridge
Class SearchAdjustments

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          com.endeca.infront.assembler.BasicContentItem
              com.endeca.infront.cartridge.SearchAdjustments

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class SearchAdjustments
extends BasicContentItem

SearchAdjustmentsHandler output model.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

SearchAdjustments(SearchAdjustmentsConfig pConfig)
Creates the SearchAdjustments output model, using the type and data present in the input SearchAdjustmentsConfig.

Method Summary

Map<String,List<AdjustedSearch>>	getAdjustedSearches() Gets automatically modified search terms from spell correction or phrasing.
Map<String,Map<String,String>>	getInterpretedTerms() Gets debug information on how search terms are interpreted.
List<String>	getOriginalTerms() Gets the original, unaltered search terms.
Map<String,List<SuggestedSearch>>	getSuggestedSearches() Gets the search suggestions.
void	setAdjustedSearches(Map<String,List<AdjustedSearch>> adjustedTerms) Sets automatically modified search terms from
void	setInterpretedTerms(Map<String,Map<String,String>> map) Sets interpreted terms.
void	setOriginalTerms(List<String> originalTerms) Sets the original, unaltered search terms.
void	setSuggestedSearches(Map<String,List<SuggestedSearch>> suggestedSearches) Sets the search suggestions.

Methods inherited from class com.endeca.infront.assembler.BasicContentItem

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

SearchAdjustments

public SearchAdjustments(SearchAdjustmentsConfig pConfig)

Creates the SearchAdjustments output model, using the type and data present in the input SearchAdjustmentsConfig.

Method Detail

getOriginalTerms

public List<String> getOriginalTerms()

Gets the original, unaltered search terms.

setOriginalTerms

public void setOriginalTerms(List<String> originalTerms)

Sets the original, unaltered search terms.

Parameters:

originalTerms -

getAdjustedSearches

public Map<String,List<AdjustedSearch>> getAdjustedSearches()

Gets automatically modified search terms from spell correction or phrasing.

Returns:

adjusted search or null if search was not adjusted

setAdjustedSearches

public void setAdjustedSearches(Map<String,List<AdjustedSearch>> adjustedTerms)

Sets automatically modified search terms from

Parameters:

adjustedTerms -

getSuggestedSearches

public Map<String,List<SuggestedSearch>> getSuggestedSearches()

Gets the search suggestions.

Returns:

search suggestions or null if nothing was suggested

setSuggestedSearches

public void setSuggestedSearches(Map<String,List<SuggestedSearch>> suggestedSearches)

Sets the search suggestions.

Parameters:

suggestedSearches -

getInterpretedTerms

public Map<String,Map<String,String>> getInterpretedTerms()

Gets debug information on how search terms are interpreted. Applicable when the word interpretation debug is enabled when starting the MDEX.

Returns:

a Map of original terms to interpreted terms

See Also:

SearchAdjustmentsConfig.setShowWordInterp(boolean)

setInterpretedTerms

public void setInterpretedTerms(Map<String,Map<String,String>> map)

Sets interpreted terms.