Package org.faktorips.fl

Enum FunctionSignatures

java.lang.Object
java.lang.Enum<FunctionSignatures>
org.faktorips.fl.FunctionSignatures
All Implemented Interfaces:
Serializable, Comparable<FunctionSignatures>, java.lang.constant.Constable
public enum FunctionSignatures extends Enum<FunctionSignatures>
A list of all function signatures that are supported by the formula language.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Abs
    Returns the absolute value of the argument.
    Decimal=Abs(Decimal)
    And
    Returns whether all arguments are true.
    boolean=And(boolean...)
    Count
    Returns the count of instances the object path references.
    int=Count(ListOfTypeDatatype<Object>)
    DATE
     
    DAYS
     
    DAYS360
     
    Exists
    Returns whether the argument is not null or a Null-Object.
    boolean=Exists(Object)
    If
    Returns the second argument if the first argument is true, the third argument if not.
    Object=If(boolean, Object, Object)
    IfBoolean
    Returns the second argument if the first argument is true, the third argument if not.
    IsEmpty
    Returns whether the argument is an empty array, null or a Null-Object.
    boolean=IsEmpty(Object)
    MaxDecimal
    Returns the maximum of the two arguments.
    Decimal=Max(Decimal,Decimal)
    MaxDouble
    Returns the maximum of the two arguments.
    double=Max(double,double)
    MaxInt
    Returns the maximum of the two arguments.
    int=Max(int,int)
    MaxList
    Returns the maximum (greatest value) from a list of values.
    MaxLong
    Returns the maximum of the two arguments.
    long=Max(long,long)
    MaxMoney
    Returns the maximum of the two arguments.
    Money=Max(Money,Money)
    MinDecimal
    Returns the minimum of the two arguments.
    Decimal=Min(Decimal,Decimal)
    MinDouble
    Returns the minimum of the two arguments.
    double=Min(double,double)
    MinInt
    Returns the minimum of the two arguments.
    int=Min(int,int)
    MinList
    Returns the minimum (smallest value) from a list of values.
    MinLong
    Returns the minimum of the two arguments.
    long=Min(long,long)
    MinMoney
    Returns the minimum of the two arguments.
    Decimal=Min(Money,Money)
    MONTHS
     
    Not
    Returns the inverted argument.
    boolean=Not(boolean)
    NotBoolean
    Returns the inverted argument.
    Boolean=Not(Boolean)
    Or
    Returns whether one of the arguments is true.
    boolean=Or(boolean...)
    PowerDecimal
    Returns the Decimal argument, to the power of the Integer value.
    Decimal=ValueOf(Math.pow(Decimal.doubleValue(), Decimal.doubleValue()))
    PowerInt
    Returns the int argument, to the power of the int value.
    int = Math.pow(double, double).intValue()
    Round
    Returns the first argument, rounded to the scale given by the second argument.
    Decimal=Round(Decimal, int)
    RoundDown
    Returns the first argument, rounded down to the scale given by the second argument.
    Decimal=RoundDown(Decimal, int)
    RoundUp
    Returns the first argument, rounded up to the scale given by the second argument.
    Decimal=RoundUp(Decimal, int)
    SqrtDecimal
    Returns the square root of the Decimal argument.
    Decimal=ValueOf(Math.sqrt(Decimal.doubleValue()))
    SumBeanArrayPropertyFct
    Given an array of objects as the first argument returns the sum of the properties identified by the second argument.
    Object=Sum(Object[], Property)
    SumDecimal
    Returns the sum of the values in the argument array.
    Decimal=Sum(Decimal[])
    SumList
     
    TextFunction
    Returns the textual representation of the given argument
    WEEKS
     
    WholeNumber
    Returns the argument, rounded down to an Integer.
    Integer=WholeNumber(Decimal)
    YEARS
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.faktorips.datatype.Datatype[]
    getArgTypes()
     
    org.faktorips.datatype.Datatype
    getType()
     
    boolean
    hasVarArgs()
     
    static FunctionSignatures
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static FunctionSignatures[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • Abs

      public static final FunctionSignatures Abs
      Returns the absolute value of the argument.
      Decimal=Abs(Decimal)
      See Also:
      • Datatype.DECIMAL

    • And

      public static final FunctionSignatures And
      Returns whether all arguments are true.
      boolean=And(boolean...)
      See Also:
      • Datatype.PRIMITIVE_BOOLEAN

    • Exists

      public static final FunctionSignatures Exists
      Returns whether the argument is not null or a Null-Object.
      boolean=Exists(Object)
      See Also:
      • Datatype.PRIMITIVE_BOOLEAN
      • AnyDatatype

    • If

      public static final FunctionSignatures If
      Returns the second argument if the first argument is true, the third argument if not.
      Object=If(boolean, Object, Object)
      See Also:
      • Datatype.PRIMITIVE_BOOLEAN
      • AnyDatatype

    • IfBoolean

      public static final FunctionSignatures IfBoolean
      Returns the second argument if the first argument is true, the third argument if not. null is treated as false.
      Object=If(Boolean, Object, Object)
      See Also:
      • Datatype.BOOLEAN
      • AnyDatatype

    • IsEmpty

      public static final FunctionSignatures IsEmpty
      Returns whether the argument is an empty array, null or a Null-Object.
      boolean=IsEmpty(Object)
      See Also:
      • Datatype.PRIMITIVE_BOOLEAN
      • AnyDatatype

    • MaxList

      public static final FunctionSignatures MaxList
      Returns the maximum (greatest value) from a list of values.
      See Also:
      • ListOfTypeDatatype
      • AnyDatatype

    • MaxDecimal

      public static final FunctionSignatures MaxDecimal
      Returns the maximum of the two arguments.
      Decimal=Max(Decimal,Decimal)
      See Also:
      • Datatype.DECIMAL

    • MaxDouble

      public static final FunctionSignatures MaxDouble
      Returns the maximum of the two arguments.
      double=Max(double,double)
      See Also:
      • Datatype.DOUBLE

    • MaxInt

      public static final FunctionSignatures MaxInt
      Returns the maximum of the two arguments.
      int=Max(int,int)
      See Also:
      • Datatype.PRIMITIVE_INT

    • MaxLong

      public static final FunctionSignatures MaxLong
      Returns the maximum of the two arguments.
      long=Max(long,long)
      See Also:
      • Datatype.PRIMITIVE_LONG

    • MaxMoney

      public static final FunctionSignatures MaxMoney
      Returns the maximum of the two arguments.
      Money=Max(Money,Money)
      See Also:
      • Datatype.MONEY

    • MinList

      public static final FunctionSignatures MinList
      Returns the minimum (smallest value) from a list of values.
      See Also:
      • ListOfTypeDatatype
      • AnyDatatype

    • MinDecimal

      public static final FunctionSignatures MinDecimal
      Returns the minimum of the two arguments.
      Decimal=Min(Decimal,Decimal)
      See Also:
      • Datatype.DECIMAL

    • MinDouble

      public static final FunctionSignatures MinDouble
      Returns the minimum of the two arguments.
      double=Min(double,double)
      See Also:
      • Datatype.DOUBLE

    • MinInt

      public static final FunctionSignatures MinInt
      Returns the minimum of the two arguments.
      int=Min(int,int)
      See Also:
      • Datatype.PRIMITIVE_INT

    • MinLong

      public static final FunctionSignatures MinLong
      Returns the minimum of the two arguments.
      long=Min(long,long)
      See Also:
      • Datatype.PRIMITIVE_LONG

    • MinMoney

      public static final FunctionSignatures MinMoney
      Returns the minimum of the two arguments.
      Decimal=Min(Money,Money)
      See Also:
      • Datatype.MONEY

    • Not

      public static final FunctionSignatures Not
      Returns the inverted argument.
      boolean=Not(boolean)
      See Also:
      • Datatype.PRIMITIVE_BOOLEAN

    • NotBoolean

      public static final FunctionSignatures NotBoolean
      Returns the inverted argument.
      Boolean=Not(Boolean)
      See Also:
      • Datatype.BOOLEAN

    • Or

      public static final FunctionSignatures Or
      Returns whether one of the arguments is true.
      boolean=Or(boolean...)
      See Also:
      • Datatype.PRIMITIVE_BOOLEAN

    • Round

      public static final FunctionSignatures Round
      Returns the first argument, rounded to the scale given by the second argument.
      Decimal=Round(Decimal, int)
      See Also:
      • Datatype.DECIMAL

    • RoundDown

      public static final FunctionSignatures RoundDown
      Returns the first argument, rounded down to the scale given by the second argument.
      Decimal=RoundDown(Decimal, int)
      See Also:
      • Datatype.DECIMAL

    • RoundUp

      public static final FunctionSignatures RoundUp
      Returns the first argument, rounded up to the scale given by the second argument.
      Decimal=RoundUp(Decimal, int)
      See Also:
      • Datatype.DECIMAL

    • SumBeanArrayPropertyFct

      public static final FunctionSignatures SumBeanArrayPropertyFct
      Given an array of objects as the first argument returns the sum of the properties identified by the second argument.
      Object=Sum(Object[], Property)
      See Also:

    • SumDecimal

      public static final FunctionSignatures SumDecimal
      Returns the sum of the values in the argument array.
      Decimal=Sum(Decimal[])
      See Also:
      • Datatype.DECIMAL

    • SumList

      public static final FunctionSignatures SumList

    • WholeNumber

      public static final FunctionSignatures WholeNumber
      Returns the argument, rounded down to an Integer.
      Integer=WholeNumber(Decimal)
      See Also:
      • Datatype.INTEGER
      • Datatype.DECIMAL

    • PowerDecimal

      public static final FunctionSignatures PowerDecimal
      Returns the Decimal argument, to the power of the Integer value.
      Decimal=ValueOf(Math.pow(Decimal.doubleValue(), Decimal.doubleValue()))
      See Also:
      • Datatype.DECIMAL

    • PowerInt

      public static final FunctionSignatures PowerInt
      Returns the int argument, to the power of the int value.
      int = Math.pow(double, double).intValue()
      See Also:
      • Datatype.PRIMITIVE_INT

    • SqrtDecimal

      public static final FunctionSignatures SqrtDecimal
      Returns the square root of the Decimal argument.
      Decimal=ValueOf(Math.sqrt(Decimal.doubleValue()))
      See Also:
      • Datatype.DECIMAL

    • Count

      public static final FunctionSignatures Count
      Returns the count of instances the object path references.
      int=Count(ListOfTypeDatatype<Object>)
      See Also:
      • Datatype.PRIMITIVE_INT
      • ListOfTypeDatatype
      • AnyDatatype

    • DAYS

      public static final FunctionSignatures DAYS

    • WEEKS

      public static final FunctionSignatures WEEKS

    • MONTHS

      public static final FunctionSignatures MONTHS

    • YEARS

      public static final FunctionSignatures YEARS

    • DATE

      public static final FunctionSignatures DATE

    • DAYS360

      public static final FunctionSignatures DAYS360

    • TextFunction

      public static final FunctionSignatures TextFunction
      Returns the textual representation of the given argument
      See Also:
      • AnyDatatype

  • Method Details

    • values

      public static FunctionSignatures[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static FunctionSignatures 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

    • getType

      public org.faktorips.datatype.Datatype getType()

    • getArgTypes

      public org.faktorips.datatype.Datatype[] getArgTypes()

    • hasVarArgs

      public boolean hasVarArgs()