|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.portal.data.functions.QueryFunction com.endeca.portal.data.functions.QueryFilter com.endeca.portal.data.functions.NegativeRefinementFilter
public class NegativeRefinementFilter
NegativeRefinementFilter provides a function for filtering out all records associated with a refinement. This filter applies to the MDEX query as a NOT record filter for the specified dimension and dimension value (e.g. NOT(Vintage:1992).
Field Summary | |
---|---|
static java.lang.String |
JSON_CONFIG_ANCESTORS
|
static java.lang.String |
JSON_CONFIG_DIM_VAL_NAME
|
static java.lang.String |
JSON_CONFIG_DIMENSION_NAME
|
static java.lang.String |
JSON_CONFIG_NAME
|
static java.lang.String |
PASSTHROUGH_NEGATIVE_REFINEMENT_FILTER
|
static java.lang.String |
PASSTHROUGH_RECORD_FILTER_INFO
|
Fields inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
CLASS_PROPERTY, operator |
Constructor Summary | |
---|---|
protected |
NegativeRefinementFilter()
Empty constructor is not public, to nudge users toward one of the more useful constructors. |
|
NegativeRefinementFilter(com.endeca.navigation.Dimension dim,
com.endeca.navigation.DimVal dimVal)
Convenience constructor for creating a NegativeRefinementFilter from Dimension and DimVal objects in the presentation API. |
|
NegativeRefinementFilter(org.json.JSONObject jsonObject)
Constructs a NegativeRefinementFilter from its JSON representation. |
|
NegativeRefinementFilter(java.lang.String dimensionName,
java.lang.String dimValName)
|
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.String> |
getAncestors()
|
static java.util.List<java.lang.String> |
getAncestors(com.endeca.mdex.conversation.Results results,
java.lang.String dimension,
java.lang.String dimVal)
Returns the ancestors of a specific dimension from a NegativeRefinementFilter returned in a V7 Results object. |
java.lang.String |
getDimensionName()
|
java.lang.String |
getDimValName()
|
java.util.List<java.lang.reflect.Method> |
getGetters()
Return the list of property getters on this function. |
static java.util.List<NegativeRefinementFilter> |
getNegativeRefinements(com.endeca.mdex.conversation.Request request)
Gets the RecordFilterInfo passthrough element, and finds the NegativeRefinementFilter elements from a request object |
static java.util.List<NegativeRefinementFilter> |
getNegativeRefinements(com.endeca.mdex.conversation.Results results)
Gets the RecordFilterInfo passthrough element, and finds the NegativeRefinementFilter elements from the V7 results object. |
java.util.List<java.lang.reflect.Method> |
getSetters()
Return the list of property setters on this function. |
void |
setAncestors(java.util.List<java.lang.String> ancestors)
|
void |
setAncestors(java.lang.String ancestors)
|
void |
setDimensionName(java.lang.String dimensionName)
|
void |
setDimValName(java.lang.String dimValName)
|
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 |
Field Detail |
---|
public static final java.lang.String JSON_CONFIG_NAME
public static final java.lang.String JSON_CONFIG_DIM_VAL_NAME
public static final java.lang.String JSON_CONFIG_DIMENSION_NAME
public static final java.lang.String JSON_CONFIG_ANCESTORS
public static final java.lang.String PASSTHROUGH_RECORD_FILTER_INFO
public static final java.lang.String PASSTHROUGH_NEGATIVE_REFINEMENT_FILTER
Constructor Detail |
---|
protected NegativeRefinementFilter()
public NegativeRefinementFilter(java.lang.String dimensionName, java.lang.String dimValName)
public NegativeRefinementFilter(com.endeca.navigation.Dimension dim, com.endeca.navigation.DimVal dimVal)
dim
- Dimension objectdimVal
- Dimension valuepublic NegativeRefinementFilter(org.json.JSONObject jsonObject) throws org.json.JSONException, java.lang.IllegalArgumentException, java.lang.ClassNotFoundException, java.lang.IllegalAccessException, java.lang.InstantiationException, java.lang.reflect.InvocationTargetException
jsonObject
- JSON representation of the NegativeRefinementFilter.
org.json.JSONException
- Thrown if an error occurs while constructing the JSONObject.
java.lang.IllegalArgumentException
java.lang.ClassNotFoundException
java.lang.IllegalAccessException
java.lang.InstantiationException
java.lang.reflect.InvocationTargetException
Method Detail |
---|
public java.util.List<java.lang.reflect.Method> getSetters()
QueryFunction
private static List setters = Reflection.getSetters(MyFunctionClass.class);
\@Override
public List getSetters() {
return setters;
}
getSetters
in class QueryFunction
public java.util.List<java.lang.reflect.Method> getGetters()
QueryFunction
private static List getters = Reflection.getGetters(MyFunctionClass.class);
\@Override
public List getGetters() {
return getters;
}
getGetters
in class QueryFunction
public java.lang.String getDimValName()
public void setDimValName(java.lang.String dimValName)
public java.lang.String getDimensionName()
public void setDimensionName(java.lang.String dimensionName)
public java.util.List<java.lang.String> getAncestors()
public void setAncestors(java.util.List<java.lang.String> ancestors)
public void setAncestors(java.lang.String ancestors)
public void applyToENEQuery(com.endeca.navigation.ENEQuery query)
QueryFunction
applyToENEQuery
in class QueryFunction
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) throws QueryFunctionUnsupportedException
QueryFunction
applyToDiscoveryServiceQuery
in class QueryFunction
QueryFunctionUnsupportedException
public java.lang.String toString()
QueryFunction
toString
in class QueryFunction
public static java.util.List<NegativeRefinementFilter> getNegativeRefinements(com.endeca.mdex.conversation.Results results)
results
-
public static java.util.List<NegativeRefinementFilter> getNegativeRefinements(com.endeca.mdex.conversation.Request request)
results
-
public static java.util.List<java.lang.String> getAncestors(com.endeca.mdex.conversation.Results results, java.lang.String dimension, java.lang.String dimVal)
results
- dimension
- dimVal
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |