org.eclipse.stardust.engine.api.query
Interface FilterableAttribute

All Superinterfaces:
Serializable
All Known Implementing Classes:
ActivityInstanceQuery.Attribute, DeployedRuntimeArtifactQuery.Attribute, org.eclipse.stardust.engine.api.query.FilterableAttributeImpl, LogEntryQuery.Attribute, ProcessInstanceQuery.Attribute, UserGroupQuery.Attribute, UserQuery.Attribute, WorklistQuery.Attribute

public interface FilterableAttribute
extends Serializable

Definition of an attribute supporting filter operations.

Currently supported predicates are:

IMPORTANT: This interface is not intended to be implemented.

Version:
$Revision$
Author:
rsauer
See Also:
UnaryOperatorFilter, BinaryOperatorFilter, TernaryOperatorFilter

Method Summary
 TernaryOperatorFilter between(double lowerBound, double upperBound)
          Creates a filter matching an attribute being both greater than or equal the given lowerBound and less than or equal the given upperBound.
 TernaryOperatorFilter between(long lowerBound, long upperBound)
          Creates a filter matching an attribute being both greater than or equal the given lowerBound and less than or equal the given upperBound.
 TernaryOperatorFilter between(String lowerBound, String upperBound)
          Creates a filter matching an attribute being both greater than or equal the given lowerBound and less than or equal the given upperBound.
 String getAttributeName()
          Returns the name of the attribute to apply this filter to.
 BinaryOperatorFilter greaterOrEqual(double value)
          Creates a filter matching an attribute being greater than the given value.
 BinaryOperatorFilter greaterOrEqual(long value)
          Creates a filter matching an attribute being greater than the given value.
 BinaryOperatorFilter greaterOrEqual(String value)
          Creates a filter matching an attribute being greater than the given value.
 BinaryOperatorFilter greaterThan(double value)
          Creates a filter matching an attribute being greater than or equal the given value.
 BinaryOperatorFilter greaterThan(long value)
          Creates a filter matching an attribute being greater than or equal the given value.
 BinaryOperatorFilter greaterThan(String value)
          Creates a filter matching an attribute being greater than or equal the given value.
 BinaryOperatorFilter isEqual(double value)
          Creates a filter matching an attribute being equal with the given value.
 BinaryOperatorFilter isEqual(long value)
          Creates a filter matching an attribute being equal with the given value.
 BinaryOperatorFilter isEqual(String value)
          Creates a filter matching an attribute being equal with the given value.
 UnaryOperatorFilter isNotNull()
          Creates a filter matching an attribute not having a SQL NULL value.
 UnaryOperatorFilter isNull()
          Creates a filter matching an attribute having a SQL NULL value.
 BinaryOperatorFilter lessOrEqual(double value)
          Creates a filter matching an attribute being less than or equal the given value.
 BinaryOperatorFilter lessOrEqual(long value)
          Creates a filter matching an attribute being less than or equal the given value.
 BinaryOperatorFilter lessOrEqual(String value)
          Creates a filter matching an attribute being less than or equal the given value.
 BinaryOperatorFilter lessThan(double value)
          Creates a filter matching an attribute being less than the given value.
 BinaryOperatorFilter lessThan(long value)
          Creates a filter matching an attribute being less than the given value.
 BinaryOperatorFilter lessThan(String value)
          Creates a filter matching an attribute being less than the given value.
 BinaryOperatorFilter like(String value)
          Creates a filter matching a text attribute according to the pattern given by value.
 BinaryOperatorFilter notEqual(double value)
          Creates a filter matching an attribute being equal with the given value.
 BinaryOperatorFilter notEqual(long value)
          Creates a filter matching an attribute being not equal with the given value.
 BinaryOperatorFilter notEqual(String value)
          Creates a filter matching an attribute being not equal with the given value.
 

Method Detail

isNull

UnaryOperatorFilter isNull()
Creates a filter matching an attribute having a SQL NULL value.

Returns:
The readily configured filter.
See Also:
isNotNull()

isNotNull

UnaryOperatorFilter isNotNull()
Creates a filter matching an attribute not having a SQL NULL value.

Returns:
The readily configured filter.
See Also:
isNull()

isEqual

BinaryOperatorFilter isEqual(String value)
Creates a filter matching an attribute being equal with the given value.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
isEqual(long), isEqual(double)

isEqual

BinaryOperatorFilter isEqual(long value)
Creates a filter matching an attribute being equal with the given value.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
isEqual(String), isEqual(double)

isEqual

BinaryOperatorFilter isEqual(double value)
Creates a filter matching an attribute being equal with the given value.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
isEqual(String), isEqual(long)

notEqual

BinaryOperatorFilter notEqual(String value)
Creates a filter matching an attribute being not equal with the given value.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
notEqual(long), notEqual(double)

notEqual

BinaryOperatorFilter notEqual(long value)
Creates a filter matching an attribute being not equal with the given value.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
notEqual(String), notEqual(double)

notEqual

BinaryOperatorFilter notEqual(double value)
Creates a filter matching an attribute being equal with the given value.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
notEqual(String), notEqual(long)

lessThan

BinaryOperatorFilter lessThan(String value)
Creates a filter matching an attribute being less than the given value.

The meaning of being less than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
lessThan(long), lessThan(double)

lessThan

BinaryOperatorFilter lessThan(long value)
Creates a filter matching an attribute being less than the given value.

The meaning of being less than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
lessThan(String), lessThan(double)

lessThan

BinaryOperatorFilter lessThan(double value)
Creates a filter matching an attribute being less than the given value.

The meaning of being less than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
lessThan(String), lessThan(long)

lessOrEqual

BinaryOperatorFilter lessOrEqual(String value)
Creates a filter matching an attribute being less than or equal the given value.

The meaning of being less than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
lessOrEqual(long), lessOrEqual(double)

lessOrEqual

BinaryOperatorFilter lessOrEqual(long value)
Creates a filter matching an attribute being less than or equal the given value.

The meaning of being less than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
lessOrEqual(String), lessOrEqual(double)

lessOrEqual

BinaryOperatorFilter lessOrEqual(double value)
Creates a filter matching an attribute being less than or equal the given value.

The meaning of being less than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
lessOrEqual(String), lessOrEqual(long)

greaterThan

BinaryOperatorFilter greaterThan(String value)
Creates a filter matching an attribute being greater than or equal the given value.

The meaning of being greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
greaterOrEqual(long), greaterOrEqual(double)

greaterThan

BinaryOperatorFilter greaterThan(long value)
Creates a filter matching an attribute being greater than or equal the given value.

The meaning of being greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
greaterOrEqual(String), greaterOrEqual(double)

greaterThan

BinaryOperatorFilter greaterThan(double value)
Creates a filter matching an attribute being greater than or equal the given value.

The meaning of being greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
greaterOrEqual(String), greaterOrEqual(long)

greaterOrEqual

BinaryOperatorFilter greaterOrEqual(String value)
Creates a filter matching an attribute being greater than the given value.

The meaning of being greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
greaterThan(long), greaterThan(double)

greaterOrEqual

BinaryOperatorFilter greaterOrEqual(long value)
Creates a filter matching an attribute being greater than the given value.

The meaning of being greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
greaterThan(String), greaterThan(double)

greaterOrEqual

BinaryOperatorFilter greaterOrEqual(double value)
Creates a filter matching an attribute being greater than the given value.

The meaning of being greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.
See Also:
greaterThan(String), greaterThan(long)

like

BinaryOperatorFilter like(String value)
Creates a filter matching a text attribute according to the pattern given by value.

The pattern language syntax is that of SQL LIKE patterns. For details please check the documentation of your database backend.

Parameters:
value - The value to match with.
Returns:
The readily configured filter.

between

TernaryOperatorFilter between(String lowerBound,
                              String upperBound)
Creates a filter matching an attribute being both greater than or equal the given lowerBound and less than or equal the given upperBound.

The meaning of being less than or greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
lowerBound - The lowerBound bound of the value range to match with.
upperBound - The upperBound bound of the value range to match with.
Returns:
The readily configured filter.
See Also:
between(long, long), between(double, double)

between

TernaryOperatorFilter between(long lowerBound,
                              long upperBound)
Creates a filter matching an attribute being both greater than or equal the given lowerBound and less than or equal the given upperBound.

The meaning of being less than or greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
lowerBound - The lowerBound bound of the value range to match with.
upperBound - The upperBound bound of the value range to match with.
Returns:
The readily configured filter.
See Also:
between(String, String), between(double, double)

between

TernaryOperatorFilter between(double lowerBound,
                              double upperBound)
Creates a filter matching an attribute being both greater than or equal the given lowerBound and less than or equal the given upperBound.

The meaning of being less than or greater than is specific to the type of the attribute, i.e. arithmetic or lexical order.

Parameters:
lowerBound - The lowerBound bound of the value range to match with.
upperBound - The upperBound bound of the value range to match with.
Returns:
The readily configured filter.
See Also:
between(String, String), between(long, long)

getAttributeName

String getAttributeName()
Returns the name of the attribute to apply this filter to.

Returns:
The attribute name.


Copyright © 2017 Eclipse Stardust. All Rights Reserved.