Package de.aristaflow.adept2.model.filter

This package contains classes that model a system of filters that can be applied to specially annotated classes.

See: Description

Interface Summary

Interface	Description
Attribute	Represents an attribute that can be filtered and the path of methods through the containing objects that must be called to retrieve it
AttributeFactory	A factory that can construct new Attribute objects by hierarchically navigating through the method tree of a specified class.
ComparisonFilter	Represents a filter that compares an attribute to a constant value using a specified comparison operator (i.e.
ConstPositionFilter	The "POSITION op Value" filter This filter compares the position of the first object matching the specified filter in the list returned by the attribute to a given constant value.
ContainsAllFilter	The "CONTAINS ALL" filter.
ContainsFilter	The super interface for all filters that match on some kind of "contains" relation.
Filter	Super interface for all filter classes.
FilterFactory	A factory to create filters
MultipleFilterFilter	Represents a filter that logically combines the Boolean outputs of multiple filters by an operator such as AND or OR.
TwoFiltersPositionFilter	The "POSITION FILTER op FILTER" filter This filter compares the position of the first object matching the first specified filter in the list returned by the attribute to the position of the first object matching the second filter.
UnaryFilter	Represents a filter that applies a unary operator (for example the NOT operator) to the result of a sub-filter.

Enum Summary

Enum	Description
ComparisonOperator	Represents the comparison operators that can be used in a ComparisonFilter

Exception Summary

Exception	Description
FilterNotSupportedException	A FilterNotSupportedException indicates that a provided filter cannot be transformed to another representation, for instance SQL.

Package de.aristaflow.adept2.model.filter Description

This package contains classes that model a system of filters that can be applied to specially annotated classes.

A filter is a function that maps an input object to a Boolean value indicating whether the filter matches or not. All filters implement the Filter interface.

An object to which a filter can be applied must annotate the filterable methods with the @UseInFilter annotation. In this context, these methods are called attributes. Attribute methods must be getters for primitive data types, other filterable objects or collections of the former types and must not have any parameters.

The AttributeFactory interface provides methods to parse classes and to build valid attribute paths for filters.

The FilterFactory interface provides methods to create different types of filters. In detail, the following filter types are available:

• ComparisonFilter: This filter compares the value of a primitive attribute to a constant value and returns true if the comparison returns true. The available comparison operators are defined in the ComparisonOperator enumeration.
• AndFilter: This filter returns true if all subfilters return true on the input object.
• OrFilter: This filter returns true if at least one of the subfilters returns true on the input object.
• NotFilter: This filter returns true if its subfilter returns false on the input object.
• ContainsFilter: This filter can only be applied to collection attributes. It returns true if the filter matches at least one of the elements of the collection.
• ContainsAllFilter: This filter can only be applied to collection attributes. It returns true if the filter matches all elements of the collection.
• ConstPositionFilter: This filter can only be applied to list attributes with a specified order. It returns true if the comparison of the position of the first object matching the specified filter in the list with a given constant value succeeds.
• TwoFiltersPositionFilter: This filter can only be applied to list attributes with a specified order. It returns true if the comparison of the position of the first object in the list matching the first filter with the position of the first object in the list matching the second filter succeeds.