Package com.appiancorp.common.query

Class TypedValueFilter

java.lang.Object

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

com.appiancorp.common.query.TypedValueFilter

All Implemented Interfaces:

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

@Entity
@GwtCompatible
public final class TypedValueFilter
extends Filter<TypedValue>

Immutable bean representing a configured Filter on a column.

An instance can only be obtain by using the helper classes at TypedValueQuery.TypedValueBuilder

• For value expressions use - TypedValueQuery.TypedValueBuilder.FilterOpExpr
• For literal values use - TypedValueQuery.TypedValueBuilder.FilterOpLiteral

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.appiancorp.common.query.Filter

LOCAL_PART, QNAME, TABLE_NAME, XML_ROOT_ELEMENT

Constructor Summary

Constructors

Modifier	Constructor	Description
	TypedValueFilter(String field, FilterOperator operator, TypedValue value)	Constructs a new TypedValueFilter using the given TypedValue as a constraint
protected	TypedValueFilter(String field, FilterOperator operator, String valueExpression)	Constructs a new TypedValueFilter using the given expression as a constraint.

Method Summary

Modifier and Type	Method	Description
Criteria	copy()
Boolean	getValidated()
TypedValue	getValue()	Returns the value used as a constraint on the column or alias
com.appiancorp.core.expr.portable.PortableTypedValue	getValueReadOnly()
protected void	setValidated(Boolean validated)
protected void	setValue(TypedValue value)

Methods inherited from class com.appiancorp.common.query.Filter

containsFilters, equals, getField, getOperator, getValueExpression, hashCode, isPartOfCriteriaPredicate, selectField, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TypedValueFilter

public TypedValueFilter(String field,
 FilterOperator operator,
 TypedValue value)

Constructs a new TypedValueFilter using the given TypedValue as a constraint

Parameters:

field - the field or alias name

operator - the filter type define by FilterOperator

value - TypedValue use to constraint the column or alias

TypedValueFilter

protected TypedValueFilter(String field,
 FilterOperator operator,
 String valueExpression)

Constructs a new TypedValueFilter using the given expression as a constraint. This expression is expected to evaluate to a TypedValue.

The constructor that takes TypedValue 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 - the field or alias name

operator - the filter type define by FilterOperator

valueExpression -

Method Details

getValidated

public Boolean getValidated()

Returns:

whether the filter has been validated within SAIL.

setValidated

protected void setValidated(Boolean validated)

getValue

public TypedValue getValue()

Description copied from class: Filter

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

Specified by:

getValue in class Filter<TypedValue>

Returns:

the value constraint

setValue

protected void setValue(TypedValue value)

Specified by:

setValue in class Filter<TypedValue>

copy

public Criteria copy()

getValueReadOnly

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

Specified by:

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

Overrides:

getValueReadOnly in class Filter<TypedValue>