com.endeca.portal.data.functions
Class DimensionSearchConfig

java.lang.Object
  extended by com.endeca.portal.data.functions.QueryFunction
      extended by com.endeca.portal.data.functions.QueryConfig
          extended by com.endeca.portal.data.functions.DimensionSearchConfig
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class DimensionSearchConfig
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, operator
 
Constructor Summary
protected DimensionSearchConfig()
           
  DimensionSearchConfig(java.lang.String searchTerm)
           
  DimensionSearchConfig(java.lang.String searchTerm, int maxPerDimension)
           
  DimensionSearchConfig(java.lang.String searchTerm, java.lang.String dimensionId)
           
  DimensionSearchConfig(java.lang.String searchTerm, java.lang.String dimensionId, int maxPerDimension)
           
  DimensionSearchConfig(java.lang.String searchTerm, java.lang.String dimensionId, java.lang.String dimValId, int maxPerDimension)
           
 
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.
 java.lang.String getDimensionId()
           
 java.lang.String getDimValId()
           
 java.util.List<java.lang.reflect.Method> getGetters()
          Return the list of property getters on this function.
 SearchFilter.MatchMode getMatchMode()
           
 int getMaxPerDimension()
           
 java.lang.String getRelevanceRankingStrategy()
           
 java.lang.String getSearchTerm()
           
 java.util.List<java.lang.reflect.Method> getSetters()
          Return the list of property setters on this function.
 void setDimensionId(java.lang.String dimensionId)
           
 void setDimValId(java.lang.String dimValId)
           
 void setMatchMode(SearchFilter.MatchMode matchMode)
           
 void setMatchMode(java.lang.String matchMode)
           
 void setMaxPerDimension(int maxPerDimension)
           
 void setMaxPerDimension(java.lang.String maxPerDimension)
           
 void setRelevanceRankingStrategy(java.lang.String relevanceRankingStrategy)
           
 void setSearchTerm(java.lang.String searchTerm)
           
 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
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
 

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

DimensionSearchConfig

protected DimensionSearchConfig()

DimensionSearchConfig

public DimensionSearchConfig(java.lang.String searchTerm)

DimensionSearchConfig

public DimensionSearchConfig(java.lang.String searchTerm,
                             int maxPerDimension)

DimensionSearchConfig

public DimensionSearchConfig(java.lang.String searchTerm,
                             java.lang.String dimensionId)

DimensionSearchConfig

public DimensionSearchConfig(java.lang.String searchTerm,
                             java.lang.String dimensionId,
                             int maxPerDimension)

DimensionSearchConfig

public DimensionSearchConfig(java.lang.String searchTerm,
                             java.lang.String dimensionId,
                             java.lang.String dimValId,
                             int maxPerDimension)
Method Detail

getMaxPerDimension

public int getMaxPerDimension()

setMaxPerDimension

public void setMaxPerDimension(int maxPerDimension)

setMaxPerDimension

public void setMaxPerDimension(java.lang.String maxPerDimension)

getDimValId

public java.lang.String getDimValId()

setDimValId

public void setDimValId(java.lang.String dimValId)

getDimensionId

public java.lang.String getDimensionId()

setDimensionId

public void setDimensionId(java.lang.String dimensionId)

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)

setMatchMode

public void setMatchMode(java.lang.String matchMode)

getRelevanceRankingStrategy

public java.lang.String getRelevanceRankingStrategy()

setRelevanceRankingStrategy

public void setRelevanceRankingStrategy(java.lang.String relevanceRankingStrategy)

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