com.endeca.portal.data.functions
Class RecordSpecListFilter

java.lang.Object
  com.endeca.portal.data.functions.QueryFunction
      com.endeca.portal.data.functions.QueryFilter
          com.endeca.portal.data.functions.RecordSpecListFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class RecordSpecListFilter
extends QueryFilter

Filter your MDEX query by a set of record specs. Equivalent to ENEQuery.setERecs(ERECIdList). Not supported on Discovery Service yet.

See Also:

Serialized Form

Field Summary

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

CLASS_PROPERTY, operator

Constructor Summary

RecordSpecListFilter()

RecordSpecListFilter(java.util.List<java.lang.String> recSpecs)

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.util.List<java.lang.reflect.Method>	getGetters() Return the list of property getters on this function.
java.util.List<java.lang.String>	getRecSpecs()
java.util.List<java.lang.reflect.Method>	getSetters() Return the list of property setters on this function.
void	setRecSpecs(java.util.List<java.lang.String> recSpecs)
void	setRecSpecs(java.lang.String recSpecs)
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

Constructor Detail

RecordSpecListFilter

public RecordSpecListFilter()

RecordSpecListFilter

public RecordSpecListFilter(java.util.List<java.lang.String> recSpecs)

Method Detail

getRecSpecs

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

setRecSpecs

public void setRecSpecs(java.util.List<java.lang.String> recSpecs)

setRecSpecs

public void setRecSpecs(java.lang.String recSpecs)

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