|
|||||||||
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.RecordFilter
public class RecordFilter
Permits adding a record filter to a QueryState. Currently, only supported on ENE presentation API data sources, not discovery service data sources.
Field Summary | |
---|---|
protected java.lang.String |
recordFilter
|
Fields inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
CLASS_PROPERTY |
Constructor Summary | |
---|---|
protected |
RecordFilter()
|
|
RecordFilter(java.lang.String recordFilter)
|
|
RecordFilter(java.lang.String name,
java.lang.String recordFilter)
|
Method Summary | |
---|---|
static RecordFilter |
andAll(java.util.Collection<RecordFilter> filters)
Takes a collection of RecordFilter s and computes the logical conjunction: AND(filter1, filter2, ...) |
static RecordFilter |
andAll(java.lang.String... filters)
Logical conjunction of filters in string-form. |
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
java.lang.String |
getRecordFilter()
|
static RecordFilter |
orAll(java.util.Collection<RecordFilter> filters)
Takes a collection of RecordFilter s and computes the logical disjunction: OR(filter1, filter2, ...) |
static RecordFilter |
orAll(java.lang.String... filters)
Logical disjunction of filters in string-form. |
void |
setName(java.lang.String name)
Set the name. |
void |
setRecordFilter(java.lang.String recordFilter)
|
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 |
---|
beforeQueryStateAdd, clone, equals, equals, getName, hashCode, initializeFromJSON |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String recordFilter
Constructor Detail |
---|
protected RecordFilter()
public RecordFilter(java.lang.String recordFilter)
public RecordFilter(java.lang.String name, java.lang.String recordFilter)
Method Detail |
---|
public java.lang.String getRecordFilter()
public void setRecordFilter(java.lang.String recordFilter)
public void setName(java.lang.String name)
QueryFunction
setName
in class QueryFunction
name
- the name to setpublic 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 RecordFilter andAll(java.util.Collection<RecordFilter> filters)
RecordFilter
s and computes the logical conjunction: AND(filter1, filter2, ...)
and returns it as a new RecordFilter
. The returned filter is a new instance and isolated from any changes
to the input filter instances.
In the trivial cases:
filters
- the filters to AND together
orAll(Collection)
public static RecordFilter andAll(java.lang.String... filters)
andAll(Collection)
public static RecordFilter orAll(java.util.Collection<RecordFilter> filters)
RecordFilter
s and computes the logical disjunction: OR(filter1, filter2, ...)
and returns it as a new RecordFilter
. The returned filter is a new instance and isolated from any changes
to the input filter instances.
In the trivial cases:
filters
- the filters to OR together
andAll(Collection)
public static RecordFilter orAll(java.lang.String... filters)
orAll(Collection)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |