com.endeca.portal.data.functions

Class QueryFilter

java.lang.Object

com.endeca.portal.data.functions.QueryFunction

com.endeca.portal.data.functions.QueryFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ArbitraryLQLASTFilter, CreatedByMeFilter, DateFilter, JoinFilter, LastNDateFilter, NegativeRefinementFilter, PrimaryDatasetJoinFilterset, RangeFilter, RefinementFilter, SearchFilter

public abstract class QueryFilter
extends QueryFunction

A subclass of QueryFunction. Semantically, QueryFilter subclass instances should restrict the resulting record set (i.e. they "filter" the records), in contrast to subclasses of QueryConfig, which do not restrict the returned record set.

See Also:

QueryConfig, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	filterId

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

CLASS_PROPERTY, VIEWKEY_PROPERTY

Constructor Summary

Constructors

Constructor and Description
QueryFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeQueryStateAdd(QueryState state) Function to check for any additional conditions when adding to the query state.
void	beforeQueryStateRemove(QueryState state)
int	getFilterId()
boolean	isBaseFilter()
void	setBaseFilter(boolean isBaseFilter)
java.lang.String	toGroovyFilter(DataSource ds)

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

applyToDiscoveryServiceQuery, applyToDiscoveryServiceQuery, clone, equals, equals, getCompareString, getName, getStateNameOverride, getVersion, getViewKey, hashCode, initializeFromJSON, isInvalid, setInvalid, setName, setStateNameOverride, setVersion, setViewKey, toString, upgrade

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

filterId

protected int filterId

Constructor Detail

QueryFilter

public QueryFilter()

Method Detail

beforeQueryStateAdd

public void beforeQueryStateAdd(QueryState state)

Description copied from class: QueryFunction

Function to check for any additional conditions when adding to the query state. The base function won't do anything, but can be overridden as necessary.

Overrides:

beforeQueryStateAdd in class QueryFunction

beforeQueryStateRemove

public void beforeQueryStateRemove(QueryState state)

Overrides:

beforeQueryStateRemove in class QueryFunction

getFilterId

public int getFilterId()

isBaseFilter

public boolean isBaseFilter()

Returns:

the isBaseFilter

setBaseFilter

public void setBaseFilter(boolean isBaseFilter)

Parameters:

isBaseFilter - the isBaseFilter to set

toGroovyFilter

public java.lang.String toGroovyFilter(DataSource ds)
                                throws QueryFunctionUnsupportedException

Throws:

QueryFunctionUnsupportedException