de.aristaflow.adept2.model.filter

Interface FilterFactory

public interface FilterFactory

A factory to create filters

Author:

Jonas Wolz

Method Summary

Modifier and Type	Method and Description
MultipleFilterFilter	createAndFilter(Filter... filters) Creates a filter that matches when all specified filters match (i.e. that performs a logical AND).
AttributeFactory	createAttributeFactory(java.lang.Class<?> rootClass) Creates a new attribute factory for filters working on the specified root class
ComparisonFilter	createComparisonFilter(Attribute attr, ComparisonOperator operator, java.lang.Comparable<?> compareValue) Creates a filter that matches when a comparison of an attribute to a constant value succeeds.
Filter	createConstantFilter(boolean matchAll) Creates a constant filter that either matches all objects or no objects based on the designated parameter.
ConstPositionFilter	createConstPositionFilter(Attribute attr, Filter filter, ComparisonOperator operator, int position) Creates a filter that matches when comparison between the position of the first object in the list returned by the attribute matching the filter and the specified integer succeeds.
ContainsAllFilter	createContainsAllFilter(Attribute attr, Filter filter, java.util.Collection<java.io.Serializable> allObjects) Creates a filter that matches when all of the objects in the allObjects collection matching the specified filter are also contained in the collection returned by the attribute (i.e. if {o "in" allObjects | filter.matches(o)} is a subset of the attribute value)
ContainsFilter	createContainsAnyFilter(Attribute attr, Filter filter) Creates a filter that matches when any of the objects in the collection returned by the specified attribute match the specified filter (analogous to a existential quantifier)
ContainsFilter	createContainsOnlyFilter(Attribute attr, Filter filter) Creates a filter that matches when all of the objects in the collection returned by the specified attribute match the specified filter (analogous to a universal quantifier)
UnaryFilter	createNotFilter(Filter filter) Creates a filter that matches when the specified filter does not match (i.e. that performs a logical NOT).
MultipleFilterFilter	createOrFilter(Filter... filters) Creates a filter that matches when one of the specified filters matches (i.e. that performs a logical OR).
TwoFiltersPositionFilter	createTwoFiltersPositionFilter(Attribute attr, Filter filter1, ComparisonOperator operator, Filter filter2) Creates a filter that matches when comparison between the position of the first object in the list returned by the attribute matching the first filter and the first object matching the second filter succeeds.

Method Detail

createAttributeFactory

AttributeFactory createAttributeFactory(java.lang.Class<?> rootClass)

Creates a new attribute factory for filters working on the specified root class

Parameters:

rootClass -

Returns:

a new attribute factory

createComparisonFilter

ComparisonFilter createComparisonFilter(Attribute attr,
                                        ComparisonOperator operator,
                                        java.lang.Comparable<?> compareValue)

Creates a filter that matches when a comparison of an attribute to a constant value succeeds.

Parameters:

attr -

operator -

compareValue -

Returns:

a new comparison filter instance

createNotFilter

UnaryFilter createNotFilter(Filter filter)

Creates a filter that matches when the specified filter does not match (i.e. that performs a logical NOT).

Parameters:

filter -

Returns:

a new filter instance

createConstantFilter

Filter createConstantFilter(boolean matchAll)

Creates a constant filter that either matches all objects or no objects based on the designated parameter.

Parameters:

matchAll - Whether to create a True- or a False-filter.

Returns:

A constant filter either matching all or no object.

createAndFilter

MultipleFilterFilter createAndFilter(Filter... filters)

Creates a filter that matches when all specified filters match (i.e. that performs a logical AND).

Parameters:

filters -

Returns:

a new filter instance

createOrFilter

MultipleFilterFilter createOrFilter(Filter... filters)

Creates a filter that matches when one of the specified filters matches (i.e. that performs a logical OR).

Parameters:

filters -

Returns:

a new filter instance

createContainsAnyFilter

ContainsFilter createContainsAnyFilter(Attribute attr,
                                       Filter filter)

Creates a filter that matches when any of the objects in the collection returned by the specified attribute match the specified filter (analogous to a existential quantifier)

Parameters:

attr - an attribute that returns a collection of objects

filter - a filter that works on the objects contained in the attribute's collection

Returns:

a new filter instance

createContainsOnlyFilter

ContainsFilter createContainsOnlyFilter(Attribute attr,
                                        Filter filter)

Creates a filter that matches when all of the objects in the collection returned by the specified attribute match the specified filter (analogous to a universal quantifier)

Parameters:

attr - an attribute that returns a collection of objects

filter - a filter that works on the objects contained in the attribute's collection

Returns:

a new filter instance

createContainsAllFilter

ContainsAllFilter createContainsAllFilter(Attribute attr,
                                          Filter filter,
                                          java.util.Collection<java.io.Serializable> allObjects)

Creates a filter that matches when all of the objects in the allObjects collection matching the specified filter are also contained in the collection returned by the attribute (i.e. if {o "in" allObjects | filter.matches(o)} is a subset of the attribute value)

Parameters:

attr - an attribute that returns a collection of objects

filter - a filter that works on the objects contained in the attribute's collection

allObjects - all existing objects of the type returned by the attribute

Returns:

a new filter instance

createConstPositionFilter

ConstPositionFilter createConstPositionFilter(Attribute attr,
                                              Filter filter,
                                              ComparisonOperator operator,
                                              int position)

Creates a filter that matches when comparison between the position of the first object in the list returned by the attribute matching the filter and the specified integer succeeds.

Parameters:

attr - an attribute that returns a collection of object

filter - a filter that works on the objects contained in the attribute's collection

operator - the comparison operator used

position - the position to compare to

Returns:

a new filter instance

createTwoFiltersPositionFilter

TwoFiltersPositionFilter createTwoFiltersPositionFilter(Attribute attr,
                                                        Filter filter1,
                                                        ComparisonOperator operator,
                                                        Filter filter2)

Creates a filter that matches when comparison between the position of the first object in the list returned by the attribute matching the first filter and the first object matching the second filter succeeds.

Parameters:

attr - an attribute that returns a collection of object

filter1 - a filter that works on the objects contained in the attribute's collection

filter2 - a filter that works on the objects contained in the attribute's collection

operator - the comparison operator used

Returns:

a new filter instance