com.appiancorp.common.query

Class Filter<T>

java.lang.Object

com.appiancorp.common.query.Filter<T>

Type Parameters:

T - Type of value

All Implemented Interfaces:

Criteria, com.appiancorp.common.query.ReadOnlyFilter, java.io.Serializable

Direct Known Subclasses:

GenericFilter, TypedValueFilter

@GwtCompatible
 @MappedSuperclass
public abstract class Filter<T>
extends java.lang.Object
implements com.appiancorp.common.query.ReadOnlyFilter

Bean representing a configured Filter on a column.

The column can be filtered either by a value or an expression, which evaluated value will be use to filter.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_PART
static javax.xml.namespace.QName	QNAME
static java.lang.String	TABLE_NAME
protected static java.lang.String	XML_ROOT_ELEMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Filter() Initializes a newly created Filter
protected	Filter(java.lang.String field, FilterOperator operator, java.lang.String valueExpression) Constructs a new Filter where its constraint is given as an expression.
protected	Filter(java.lang.String field, FilterOperator operator, T value) Constructs a new Filter where its constraint is given as an object value.

Method Summary

Modifier and Type	Method and Description
static <T> boolean	containsFilters(Criteria criteria, java.lang.Iterable<Filter<T>> filters) Checks if all the filters are contained by the given criteria
boolean	equals(java.lang.Object obj)
java.lang.String	getField() Returns the column or alias name
FilterOperator	getOperator() Returns the FilterOperator
abstract T	getValue() Returns the value used as a constraint on the column or alias
java.lang.String	getValueExpression() Return the value expression used as a constraint on the column or alias
com.appiancorp.core.expr.portable.PortableTypedValue	getValueReadOnly()
int	hashCode()
static com.appiancorp.common.query.Filter.IsPartOfCriteriaPredicate	isPartOfCriteriaPredicate(Criteria c) Returns the predicate function which checks if given Filter is contained in a certain Criteria
static com.google.common.base.Function<Filter<?>,java.lang.String>	selectField() Returns a Function which retrieves the column/alias/field name from a given Filter
protected abstract void	setValue(T value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appiancorp.common.query.Criteria

copy

Field Detail

XML_ROOT_ELEMENT

protected static final java.lang.String XML_ROOT_ELEMENT

See Also:

Constant Field Values

TABLE_NAME

public static final java.lang.String TABLE_NAME

See Also:

Constant Field Values

LOCAL_PART

public static final java.lang.String LOCAL_PART

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

Constructor Detail

Filter

protected Filter()

Initializes a newly created Filter

Filter

protected Filter(java.lang.String field,
                 FilterOperator operator,
                 java.lang.String valueExpression)

Constructs a new Filter where its constraint is given as an expression.

The constructor that takes T value is preferred over this constructor because evaluation of an expression to obtain the value is unnecessary except in cases of deferred evaluation, which are not applicable to cases of constructing a Filter for plug-ins.

Parameters:

field - column or alias name

operator - filter type define as FilterOperator

valueExpression - expression representing the object use to constraint the column or alias

See Also:

Filter(String, FilterOperator, T)

Filter

protected Filter(java.lang.String field,
                 FilterOperator operator,
                 T value)

Constructs a new Filter where its constraint is given as an object value.

Parameters:

field - column or alias name

operator - filter type define as FilterOperator

value - object use to constraint the column or alias

Method Detail

getValue

public abstract T getValue()

Returns the value used as a constraint on the column or alias

Returns:

the value constraint

setValue

protected abstract void setValue(T value)

getValueReadOnly

public com.appiancorp.core.expr.portable.PortableTypedValue getValueReadOnly()

Specified by:

getValueReadOnly in interface com.appiancorp.common.query.ReadOnlyFilter

getField

public java.lang.String getField()

Returns the column or alias name

Specified by:

getField in interface com.appiancorp.common.query.ReadOnlyFilter

Returns:

the column or alias name

getOperator

public FilterOperator getOperator()

Returns the FilterOperator

Specified by:

getOperator in interface com.appiancorp.common.query.ReadOnlyFilter

Returns:

the FilterOperator

getValueExpression

public java.lang.String getValueExpression()

Return the value expression used as a constraint on the column or alias

Specified by:

getValueExpression in interface com.appiancorp.common.query.ReadOnlyFilter

Returns:

the object use to constraint the column or alias

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isPartOfCriteriaPredicate

public static final com.appiancorp.common.query.Filter.IsPartOfCriteriaPredicate isPartOfCriteriaPredicate(Criteria c)

Returns the predicate function which checks if given Filter is contained in a certain Criteria

Parameters:

c - a Criteria

Returns:

a predicate function which checks if given Filter is contained in a certain Criteria

containsFilters

public static <T> boolean containsFilters(Criteria criteria,
                                          java.lang.Iterable<Filter<T>> filters)

Checks if all the filters are contained by the given criteria

Parameters:

criteria - a Criteria

filters - iterable Filters

Returns:

true if all the filters are contained by the given criteria; false otherwise

selectField

public static com.google.common.base.Function<Filter<?>,java.lang.String> selectField()

Returns a Function which retrieves the column/alias/field name from a given Filter

Returns:

a Function which retrieves the column/alias/field name from a given Filter