org.faktorips.runtime.formula

Enum FormulaEvaluatorUtil

java.lang.Object

java.lang.Enum<FormulaEvaluatorUtil>

org.faktorips.runtime.formula.FormulaEvaluatorUtil

All Implemented Interfaces:

Serializable, Comparable<FormulaEvaluatorUtil>

public enum FormulaEvaluatorUtil
extends Enum<FormulaEvaluatorUtil>

Provides methods that can be used in formula evaluation.

Some code in formulas does not need to be generated again and again but is implemented in static methods in this class that are used by the formulas.

Since:

3.6

See Also:

IFormulaEvaluator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormulaEvaluatorUtil.AssociationTo1Helper<S extends IModelObject,T extends IModelObject> Helper class for navigating 1-to-1 associations from a list of source objects of type <S> to target objects of type <T>.
static class	FormulaEvaluatorUtil.AssociationToManyHelper<S extends IModelObject,T extends IModelObject> Helper class for navigating 1-to-many associations from a list of source objects of type <S> to target objects of type <T>.
static class	FormulaEvaluatorUtil.AttributeAccessorHelper<S extends IModelObject,E> Helper class to get the values from a list of source objects of type <S> to target type <E>.
static class	FormulaEvaluatorUtil.ExistsHelper Helper class to encapsulate a function call to verify the existence of an object that could result in an Exception (for example a NullPointerException or IndexOutOfBoundsException when navigating over associations in model objects) which should just be treated as a false result.
static class	FormulaEvaluatorUtil.FunctionWithListAsArgumentHelper<E> Base class for functions working on list arguments.

Method Summary

Modifier and Type	Method and Description
static <T extends IModelObject,R extends T> List<? extends R>	getListModelObjectById(List<? extends T> modelObjects, String id) Returns all IConfigurableModelObject in the list that is configured by a IProductComponent with the given ID, the list is empty if no such object is found in the list.
static <T extends IModelObject,R extends T> R	getModelObjectById(List<? extends T> modelObjects, String id) Returns the (first) IConfigurableModelObject in the list that is configured by a IProductComponent with the given ID, null if no such object is found in the list.
static <T extends IModelObject,R extends T> R	getModelObjectById(T modelObject, String id) Returns the IModelObject if it is a IConfigurableModelObject configured by a IProductComponent with the given ID, null otherwise.
static FormulaEvaluatorUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static FormulaEvaluatorUtil[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static FormulaEvaluatorUtil[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FormulaEvaluatorUtil c : FormulaEvaluatorUtil.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FormulaEvaluatorUtil valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getModelObjectById

public static <T extends IModelObject,R extends T> R getModelObjectById(List<? extends T> modelObjects,
                                                                        String id)

Returns the (first) IConfigurableModelObject in the list that is configured by a IProductComponent with the given ID, null if no such object is found in the list.

Type Parameters:

T - the type of IModelObject returned by this method and expected in the list

Parameters:

modelObjects - a list of model objects of type T

id - the runtime ID this method searches

Returns:

the (first) IConfigurableModelObject in the list that is configured by a IProductComponent with the given ID, null if no such object is found in the list

See Also:

getModelObjectById(IModelObject, String)

getListModelObjectById

public static <T extends IModelObject,R extends T> List<? extends R> getListModelObjectById(List<? extends T> modelObjects,
                                                                                            String id)

Returns all IConfigurableModelObject in the list that is configured by a IProductComponent with the given ID, the list is empty if no such object is found in the list.

Type Parameters:

T - the type of IModelObject returned by this method and expected in the list

Parameters:

modelObjects - a list of model objects of type T

id - the runtime ID this method searches

Returns:

the all IConfigurableModelObject in the list that is configured by a IProductComponent with the given ID, the list is empty if no such object is found in the list

See Also:

getModelObjectById(IModelObject, String)

getModelObjectById

public static <T extends IModelObject,R extends T> R getModelObjectById(T modelObject,
                                                                        String id)

Returns the IModelObject if it is a IConfigurableModelObject configured by a IProductComponent with the given ID, null otherwise.

Type Parameters:

T - the type of IModelObject returned and expected by this method

Parameters:

modelObject - a model object of type T

id - the runtime ID this method searches

Returns:

the IModelObject if it is a IConfigurableModelObject configured by a IProductComponent with the given ID, null otherwise

See Also:

getModelObjectById(List, String)