com.endeca.portal.data.functions
Class NavConfig

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class NavConfig
extends QueryConfig

Configure the navigation on a query state. Currently, only controls whether "expose all refinements" is on or off, and the name of the group this NavConfig applies to.

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

NavConfig()

NavConfig(boolean exposeAllRefinements)

NavConfig(java.lang.String id)

NavConfig(java.lang.String id, boolean exposeAllRefinements)

Method Summary

void	addRefinementGroupConfig(com.endeca.mdex.conversation.RefinementGroupConfig refinementGroupConfig)
void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query, java.lang.String stateName) Apply this function to a Request.
QueryFunction	clone()
boolean	getExposeAllRefinements()
java.util.List<com.endeca.mdex.conversation.RefinementGroupConfig>	getRefinementGroupConfig()
void	setExposeAllRefinements(boolean exposeAllRefinements)
void	setRefinementGroupConfig(java.util.List<com.endeca.mdex.conversation.RefinementGroupConfig> refinementGroupConfigs)
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

NavConfig

public NavConfig()

NavConfig

public NavConfig(boolean exposeAllRefinements)

NavConfig

public NavConfig(java.lang.String id)

NavConfig

public NavConfig(java.lang.String id,
                 boolean exposeAllRefinements)

Method Detail

getExposeAllRefinements

public boolean getExposeAllRefinements()

setExposeAllRefinements

public void setExposeAllRefinements(boolean exposeAllRefinements)

setRefinementGroupConfig

public void setRefinementGroupConfig(java.util.List<com.endeca.mdex.conversation.RefinementGroupConfig> refinementGroupConfigs)

getRefinementGroupConfig

public java.util.List<com.endeca.mdex.conversation.RefinementGroupConfig> getRefinementGroupConfig()

addRefinementGroupConfig

public void addRefinementGroupConfig(com.endeca.mdex.conversation.RefinementGroupConfig refinementGroupConfig)

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