Package net.sf.basedb.core

Enum Class Formula.AverageMethod

java.lang.Object
java.lang.Enum<Formula.AverageMethod>
net.sf.basedb.core.Formula.AverageMethod
All Implemented Interfaces:
Serializable, Comparable<Formula.AverageMethod>, Constable
Enclosing class:
Formula
public static enum Formula.AverageMethod extends Enum<Formula.AverageMethod>
The average method used for the values of this formula. The average is only useful with a Formula.Type.COLUMN_EXPRESSION.
Version:
2.4

  • Enum Constant Details

  • Field Details

    • valueMapping

      private static final Map<Integer,Formula.AverageMethod> valueMapping
      Maps the integer that is stored in the database.

    • value

      private final int value

    • displayValue

      private final String displayValue

  • Constructor Details

    • AverageMethod

      private AverageMethod(int value, String displayValue)

  • Method Details

    • values

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

    • valueOf

      public static Formula.AverageMethod valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromValue

      public static Formula.AverageMethod fromValue(int value)
      Get the Formula.AverageMethod object when you know the integer code.
      Parameters:
      value - The integer value.
      Returns:
      The AverageMethod object or null if the value is unknown

    • getAverageExpression

      public abstract Expression getAverageExpression(Expression e)
      Given an expression, create an expression that takes the correct average of it.
      Parameters:
      e - The expression, null is not allowed
      Returns:
      The average expression, or null if it is not possible to create an average expression

    • getValue

      public int getValue()
      Get the integer value that is used when storing a Formula.AverageMethod in the database.
      Returns:
      The integer value of this type

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Formula.AverageMethod>