com.endeca.portal.data.functions
Class AttributeValueSearchConfig

java.lang.Object
  com.endeca.portal.data.functions.QueryFunction
      com.endeca.portal.data.functions.QueryConfig
          com.endeca.portal.data.functions.AttributeValueSearchConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AttributeValueSearchConfig
extends QueryConfig

See Also:

Serialized Form

Field Summary

static java.lang.String	DEFAULT_ID
static java.lang.String	HANDLER_FUNCTION

Fields inherited from class com.endeca.portal.data.functions.QueryConfig

id

Fields inherited from class com.endeca.portal.data.functions.QueryFunction

CLASS_PROPERTY, VIEWKEY_PROPERTY

Constructor Summary

protected	AttributeValueSearchConfig()
	AttributeValueSearchConfig(java.lang.String searchTerm)
	AttributeValueSearchConfig(java.lang.String searchTerm, int maxValuesToReturn)
	AttributeValueSearchConfig(java.lang.String searchTerm, java.util.List<java.lang.String> searchWithin)
	AttributeValueSearchConfig(java.lang.String searchTerm, java.util.List<java.lang.String> searchWithin, int maxValuesToReturn)
	AttributeValueSearchConfig(java.lang.String searchTerm, java.lang.String attribute)
	AttributeValueSearchConfig(java.lang.String searchTerm, java.lang.String attribute, int maxValuesToReturn)

Method Summary

void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query, java.lang.String stateName) Apply this function to a Request.
QueryFunction	clone()
java.lang.String	getAttribute()
java.lang.String	getLanguageId()
SearchFilter.MatchMode	getMatchMode()
int	getMaxValuesToReturn()
java.lang.String	getRelevanceRankingStrategy()
java.lang.String	getSearchTerm()
java.util.List<java.lang.String>	getSearchWithin()
void	setAttribute(java.lang.String attribute)
void	setLanguageId(java.lang.String languageId)
void	setMatchMode(SearchFilter.MatchMode matchMode)
void	setMaxValuesToReturn(int maxValuesToReturn)
void	setRelevanceRankingStrategy(java.lang.String relevanceRankingStrategy)
void	setSearchTerm(java.lang.String searchTerm)
void	setSearchWithin(java.util.List<java.lang.String> searchWithin)
void	substituteAttributeKeys(AttributeKeyConverter attributeKeyConverter, java.util.Locale currentLocale) Substitute the attribute keys in the QueryFunction with new values specified in attributeKeyMap
java.lang.String	toString() This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

Methods inherited from class com.endeca.portal.data.functions.QueryConfig

getId, setId

Methods inherited from class com.endeca.portal.data.functions.QueryFunction

beforeQueryStateAdd, beforeQueryStateRemove, equals, equals, getCompareString, getName, getVersion, getViewKey, hashCode, initializeFromJSON, passesSelectiveFilter, setName, setVersion, setViewKey, upgrade

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID

public static final java.lang.String DEFAULT_ID

See Also:

Constant Field Values

HANDLER_FUNCTION

public static final java.lang.String HANDLER_FUNCTION

See Also:

Constant Field Values

Constructor Detail

AttributeValueSearchConfig

protected AttributeValueSearchConfig()

AttributeValueSearchConfig

public AttributeValueSearchConfig(java.lang.String searchTerm)

AttributeValueSearchConfig

public AttributeValueSearchConfig(java.lang.String searchTerm,
                                  int maxValuesToReturn)

AttributeValueSearchConfig

public AttributeValueSearchConfig(java.lang.String searchTerm,
                                  java.lang.String attribute)

AttributeValueSearchConfig

public AttributeValueSearchConfig(java.lang.String searchTerm,
                                  java.lang.String attribute,
                                  int maxValuesToReturn)

AttributeValueSearchConfig

public AttributeValueSearchConfig(java.lang.String searchTerm,
                                  java.util.List<java.lang.String> searchWithin)

AttributeValueSearchConfig

public AttributeValueSearchConfig(java.lang.String searchTerm,
                                  java.util.List<java.lang.String> searchWithin,
                                  int maxValuesToReturn)

Method Detail

getMaxValuesToReturn

public int getMaxValuesToReturn()

setMaxValuesToReturn

public void setMaxValuesToReturn(int maxValuesToReturn)

getAttribute

public java.lang.String getAttribute()

setAttribute

public void setAttribute(java.lang.String attribute)

getSearchWithin

public java.util.List<java.lang.String> getSearchWithin()

setSearchWithin

public void setSearchWithin(java.util.List<java.lang.String> searchWithin)

getSearchTerm

public java.lang.String getSearchTerm()

setSearchTerm

public void setSearchTerm(java.lang.String searchTerm)

getMatchMode

public SearchFilter.MatchMode getMatchMode()

setMatchMode

public void setMatchMode(SearchFilter.MatchMode matchMode)

getRelevanceRankingStrategy

public java.lang.String getRelevanceRankingStrategy()

setRelevanceRankingStrategy

public void setRelevanceRankingStrategy(java.lang.String relevanceRankingStrategy)

getLanguageId

public java.lang.String getLanguageId()

setLanguageId

public void setLanguageId(java.lang.String languageId)

applyToDiscoveryServiceQuery

public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query,
                                         java.lang.String stateName)
                                  throws QueryFunctionUnsupportedException

Description copied from class: QueryFunction

Apply this function to a Request. Must be implemented by subclass.

Specified by:

applyToDiscoveryServiceQuery in class QueryFunction

Parameters:

query - the CS Request to which this function should be applied

stateName - stateName to use for filters or content element configs

Throws:

QueryFunctionUnsupportedException

substituteAttributeKeys

public void substituteAttributeKeys(AttributeKeyConverter attributeKeyConverter,
                                    java.util.Locale currentLocale)

Description copied from class: QueryFunction

Substitute the attribute keys in the QueryFunction with new values specified in attributeKeyMap

Overrides:

substituteAttributeKeys in class QueryFunction

toString

public java.lang.String toString()

Description copied from class: QueryFunction

This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

Specified by:

toString in class QueryFunction

clone

public QueryFunction clone()

Overrides:

clone in class QueryFunction