net.sf.basedb.core
Enum Formula.Type

java.lang.Object
  java.lang.Enum<Formula.Type>
      net.sf.basedb.core.Formula.Type

All Implemented Interfaces:

Serializable, Comparable<Formula.Type>

Enclosing class:

Formula

public static enum Formula.Type
extends Enum<Formula.Type>

The type of formula indicats in which situations it can be used.

Enum Constant Summary

COLUMN_EXPRESSION
An arbitrary expression that specify one formula only.

COLUMN_RESTRICTION
An arbitraty expression that specify one formula only.

INTENSITY_EXPRESSION
The formula represents an intensity measurement expression.

INTENSITY_TRANSFORMATION
The formula represents a intensity transformation expression.

Field Summary

private boolean	canUseColoring
private String	displayValue
private boolean	supportsAverage
private int	value
private static Map<Integer,Formula.Type>	valueMapping Maps the integer that is stored in the database.
private Type	valueType

Method Summary

boolean	canUseColoring() If a formula of this type can use coloring or not.
static Formula.Type	fromValue(int value) Get the Formula.Type object when you know the integer code.
int	getValue() Get the integer value that is used when storing a Formula.Type in the database.
Type	getValueType() Get the type of values that formulas of this type must produce or null if it can be any type of values.
boolean	supportsAverage() If a formula of this type can be used in an average expression or not.
String	toString()
(package private) abstract void	validate(Formula formula)
static Formula.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Formula.Type[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INTENSITY_EXPRESSION

public static final Formula.Type INTENSITY_EXPRESSION

The formula represents an intensity measurement expression. A raw data type and one formula for each channel must be specified. A formula of this type is typically used to create a root bioassay set from raw data.

INTENSITY_TRANSFORMATION

public static final Formula.Type INTENSITY_TRANSFORMATION

The formula represents a intensity transformation expression. A raw data type or the number of channels and one formula for each channel are required. A formula of this type if typically used to transform the intensities of one bioassay set into a child bioassay set.

COLUMN_EXPRESSION

public static final Formula.Type COLUMN_EXPRESSION

An arbitrary expression that specify one formula only. A raw data type or the number of channels are also required. A formula of this type is typically used for displaying calculated values in a table view or plotting them in a plot tool. The formula can also be used to calculate extra values for a bioassay set.

COLUMN_RESTRICTION

public static final Formula.Type COLUMN_RESTRICTION

An arbitraty expression that specify one formula only. The formula is converted into a Restriction. A raw data type or the number of channels must are also required. A formula of this type is typically used to create a filtered bioassay set.

Field Detail

valueMapping

private static final Map<Integer,Formula.Type> valueMapping

Maps the integer that is stored in the database.

value

private final int value

displayValue

private final String displayValue

canUseColoring

private final boolean canUseColoring

supportsAverage

private final boolean supportsAverage

valueType

private final Type valueType

Method Detail

values

public static Formula.Type[] 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 (Formula.Type c : Formula.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static Formula.Type 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

fromValue

public static Formula.Type fromValue(int value)

Get the Formula.Type object when you know the integer code.

Parameters:

value - The integer value.

Returns:

The type object or null if the value is unknown

toString

public String toString()

Overrides:

toString in class Enum<Formula.Type>

getValue

public int getValue()

Get the integer value that is used when storing a Formula.Type in the database.

Returns:

The integer value of this type

canUseColoring

public boolean canUseColoring()

If a formula of this type can use coloring or not. Coloring is only possible for formulas which create one value.

supportsAverage

public boolean supportsAverage()

If a formula of this type can be used in an average expression or not. This is only possible for formulas which create one value.

Since:

2.4

getValueType

public Type getValueType()

Get the type of values that formulas of this type must produce or null if it can be any type of values.

Since:

2.15

validate

abstract void validate(Formula formula)
                throws InvalidDataException

Throws:

InvalidDataException