de.aristaflow.adept2.model.filter

Interface AttributeFactory

public interface AttributeFactory

A factory that can construct new Attribute objects by hierarchically navigating through the method tree of a specified class. Parameters:
Some method allow for passing values to the method representing the filtered attribute, ie. when creating a filter for the attribute isObsolete(boolean subprocessScope), one must supply the value for the parameter subprocessScope when creating an attribute. The following general rules apply for all methods using parameters:

• only serialisable types are allowed as parameters
• all primitive types are automatically unboxed, when looking up the method - whether they are provided explicitly as e.g. new Integer(5) or as simple value 5!
• the creator of the filters must make sure the call to method will not lead to side effects, like e.g. filtering on the attribute put("Hello", "World") would do.

Author:

Christoph Muessel, Jonas Wolz

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAvailableComplexAttributes() Retrieves the set of complex attributes (i.e. annotated methods that do not return a primitive type or collection) of the class that is currently being navigated
java.util.Set<java.lang.String>	getAvailablePrimitiveAttributes() Retrieves the set of primitive attributes (i.e. annotated methods that return a primitive type or collection) of the class that is currently being navigated
java.lang.String	getCurrentPathAsString() Retrieves a string representation of the currently selected attribute path
AttributeFactory	getFactoryForCollectionAttribute(java.lang.String primitiveMethod) Creates an AttributeFactory for the inner type of the given collection attribute.
AttributeFactory	goDown(java.lang.String complexMethod) Adds the supplied method to the method call path and navigates to the class of its return type.
AttributeFactory	goDown(java.lang.String complexMethod, java.lang.Object... parameters) The same as goDown(String) but going down by passing the given parameters to the method.
AttributeFactory	goDownAndCast(java.lang.String complexMethod, java.lang.Class<?> desiredType) Adds the supplied method to the method call path and navigates to the class of the desired type.
AttributeFactory	goDownAndCast(java.lang.String complexMethod, java.lang.Class<?> desiredType, java.lang.Object... parameters) The same as goDownAndCast(String, Class) but going down by passing the given parameters to the method.
AttributeFactory	goUp() Deletes the last element of the method call path and navigates to the class that owns this method
Attribute	selectAttribute(java.lang.String primitiveMethod) Finishes an attribute by adding the supplied primitive method to the method call path and generating an Attribute object
Attribute	selectAttribute(java.lang.String primitiveMethod, java.io.Serializable... parameters) The same as selectAttribute(String) but selecting by passing the given parameters to the method.
Attribute	selectAttributeAndCast(java.lang.String primitiveMethod, java.lang.Class<?> desiredType) Finishes an attribute by adding the supplied primitive method to the method call path and generating an Attribute object.
Attribute	selectAttributeAndCast(java.lang.String primitiveMethod, java.lang.Class<?> desiredType, java.io.Serializable... parameters) The same as selectAttributeAndCast(String, Class) but selecting by passing the given parameters to the method.
AttributeFactory	startNewAttribute() Tells the factory to start a new attribute.

Method Detail

startNewAttribute

AttributeFactory startNewAttribute()

Tells the factory to start a new attribute. This navigates to the class associated with the factory and fills the maps of available attributes with the annotated methods of this class (i.e. this resets the attribute factory to the state when i)

Returns:

This attribute factory allowing to concatenate various method calls and therefore simplifying creation of attributes.

getAvailableComplexAttributes

java.util.Set<java.lang.String> getAvailableComplexAttributes()

Retrieves the set of complex attributes (i.e. annotated methods that do not return a primitive type or collection) of the class that is currently being navigated

Returns:

a set with the names of complex attributes

getAvailablePrimitiveAttributes

java.util.Set<java.lang.String> getAvailablePrimitiveAttributes()

Retrieves the set of primitive attributes (i.e. annotated methods that return a primitive type or collection) of the class that is currently being navigated

Returns:

a set with the names of primitive attributes

goDown

AttributeFactory goDown(java.lang.String complexMethod)

Adds the supplied method to the method call path and navigates to the class of its return type.

Parameters:

complexMethod - an element of the map returned by getAvailableComplesAttributes()

Returns:

This attribute factory allowing to concatenate various method calls and therefore simplifying creation of attributes.

goDown

AttributeFactory goDown(java.lang.String complexMethod,
                        java.lang.Object... parameters)

The same as goDown(String) but going down by passing the given parameters to the method. Cf. AttributeFactory for details on parameters.

Parameters:

complexMethod -

parameters -

Returns:

This attribute factory allowing to concatenate various method calls and therefore simplifying creation of attributes.

goDownAndCast

AttributeFactory goDownAndCast(java.lang.String complexMethod,
                               java.lang.Class<?> desiredType)

Adds the supplied method to the method call path and navigates to the class of the desired type.
At runtime it is checked if the return type is an instance of the desired type. If not, any filter using this attribute will always fail (but not crash or throw an error).

Parameters:

complexMethod - an element of the map returned by getAvailableComplesAttributes()

desiredType - The type the attribute should be casted to. If null the return type of the attribute is used

Returns:

This attribute factory allowing to concatenate various method calls and therefore simplifying creation of attributes.

goDownAndCast

AttributeFactory goDownAndCast(java.lang.String complexMethod,
                               java.lang.Class<?> desiredType,
                               java.lang.Object... parameters)

The same as goDownAndCast(String, Class) but going down by passing the given parameters to the method. Cf. AttributeFactory for details on parameters.

Parameters:

complexMethod -

desiredType -

parameters -

Returns:

This attribute factory allowing to concatenate various method calls and therefore simplifying creation of attributes.

goUp

AttributeFactory goUp()

Deletes the last element of the method call path and navigates to the class that owns this method

Returns:

This attribute factory allowing to concatenate various method calls and therefore simplifying creation of attributes.

selectAttribute

Attribute selectAttribute(java.lang.String primitiveMethod)

Finishes an attribute by adding the supplied primitive method to the method call path and generating an Attribute object

Parameters:

primitiveMethod - an element of the map returned by getAvailablePrimitiveAttributes()

Returns:

the generated Attribute object

selectAttribute

Attribute selectAttribute(java.lang.String primitiveMethod,
                          java.io.Serializable... parameters)

The same as selectAttribute(String) but selecting by passing the given parameters to the method. Cf. AttributeFactory for details on parameters.

Parameters:

primitiveMethod -

parameters -

Returns:

The generated attribute object.

selectAttributeAndCast

Attribute selectAttributeAndCast(java.lang.String primitiveMethod,
                                 java.lang.Class<?> desiredType)

Finishes an attribute by adding the supplied primitive method to the method call path and generating an Attribute object.
* At runtime it is checked if the return type is an instance of the desired type. If not, any filter using this attribute will always fail (but not crash or throw an error).

Parameters:

primitiveMethod - an element of the map returned by getAvailablePrimitiveAttributes()

desiredType - The type the attribute should be casted to. If null the return type of the attribute is used.

Returns:

the generated Attribute object

selectAttributeAndCast

Attribute selectAttributeAndCast(java.lang.String primitiveMethod,
                                 java.lang.Class<?> desiredType,
                                 java.io.Serializable... parameters)

The same as selectAttributeAndCast(String, Class) but selecting by passing the given parameters to the method. Cf. AttributeFactory for details on parameters.

Parameters:

primitiveMethod -

desiredType -

parameters -

Returns:

The generated attribute object.

getFactoryForCollectionAttribute

AttributeFactory getFactoryForCollectionAttribute(java.lang.String primitiveMethod)

Creates an AttributeFactory for the inner type of the given collection attribute.

Parameters:

primitiveMethod -

Returns:

A new attribute factory.

getCurrentPathAsString

java.lang.String getCurrentPathAsString()

Retrieves a string representation of the currently selected attribute path

Returns:

the attribute path string