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.
- See Also:
- Serialized Form
Fields inherited from class com.endeca.portal.data.functions.QueryConfig |
id |
Method Summary |
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
void |
applyToENEQuery(com.endeca.navigation.ENEQuery query)
Apply this function to an ENEQuery. |
boolean |
getExposeAllRefinements()
|
java.util.List<java.lang.reflect.Method> |
getGetters()
Return the list of property getters on this function. |
boolean |
getRefineAllProperties()
|
java.util.List<java.lang.reflect.Method> |
getSetters()
Return the list of property setters on this function. |
void |
setExposeAllRefinements(boolean exposeAllRefinements)
|
void |
setExposeAllRefinements(java.lang.String exposeAllRefinements)
|
void |
setRefineAllProperties(boolean refineAllProperties)
|
void |
setRefineAllProperties(java.lang.String refineAllProperties)
|
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.QueryFunction |
clone, equals, equals, getInstance, getInstance, getName, getOperator, hashCode, init, setName, setOperator, setOperator, toJSON, toXML |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
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
NavConfig
public NavConfig()
NavConfig
public NavConfig(boolean exposeAllRefinements)
NavConfig
public NavConfig(java.lang.String id)
NavConfig
public NavConfig(java.lang.String id,
boolean exposeAllRefinements)
getExposeAllRefinements
public boolean getExposeAllRefinements()
setExposeAllRefinements
public void setExposeAllRefinements(boolean exposeAllRefinements)
setExposeAllRefinements
public void setExposeAllRefinements(java.lang.String exposeAllRefinements)
getRefineAllProperties
public boolean getRefineAllProperties()
setRefineAllProperties
public void setRefineAllProperties(boolean refineAllProperties)
setRefineAllProperties
public void setRefineAllProperties(java.lang.String refineAllProperties)
applyToDiscoveryServiceQuery
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
throws QueryFunctionUnsupportedException
- Description copied from class:
QueryFunction
- Apply this function to a Request. Must be implemented by subclass.
- Specified by:
applyToDiscoveryServiceQuery
in class QueryFunction
- Throws:
QueryFunctionUnsupportedException
applyToENEQuery
public void applyToENEQuery(com.endeca.navigation.ENEQuery query)
throws QueryFunctionUnsupportedException
- Description copied from class:
QueryFunction
- Apply this function to an ENEQuery. Must be implemented by subclass.
- Specified by:
applyToENEQuery
in class QueryFunction
- Throws:
QueryFunctionUnsupportedException
getGetters
public java.util.List<java.lang.reflect.Method> getGetters()
- Description copied from class:
QueryFunction
- Return the list of property getters on this function. Must be implemented
by subclass. Required for correct JSON serialization/deserialization
support.
For most subclasses, implementing this method should be simple, as long as
your getter methods follow standard Java naming conventions (e.g.
"getPropertyName()"). All you should need to write is:
private static List getters = Reflection.getGetters(MyFunctionClass.class);
\@Override
public List getGetters() {
return getters;
}
- Specified by:
getGetters
in class QueryFunction
- Returns:
- the list of getters
getSetters
public java.util.List<java.lang.reflect.Method> getSetters()
- Description copied from class:
QueryFunction
- Return the list of property setters on this function. Must be implemented
by subclass. Required for correct JSON serialization/deserialization
support.
For most subclasses, implementing this method should be simple, as long as
your setter methods follow standard Java naming conventions (e.g.
"setPropertyName(PropertyType)"). All you should need to write is:
private static List setters = Reflection.getSetters(MyFunctionClass.class);
\@Override
public List getSetters() {
return setters;
}
- Specified by:
getSetters
in class QueryFunction
- Returns:
- the list of setters
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