net.sf.basedb.core
Enum ExtraValue.CoordinateType

java.lang.Object
  java.lang.Enum<ExtraValue.CoordinateType>
      net.sf.basedb.core.ExtraValue.CoordinateType

All Implemented Interfaces:

Serializable, Comparable<ExtraValue.CoordinateType>

Enclosing class:

ExtraValue

public static enum ExtraValue.CoordinateType
extends Enum<ExtraValue.CoordinateType>

Defines which coordinates in the data cube the extra values are attached to. Extra values can be attached to any combination of the column and postion coordinate.

See Also:

DataCube

Enum Constant Summary

COLUMN
The extra values are attached to column coordinates only.

POSITION
The extra values are attached to position coordinates only.

SPOT
The extra values are attached to spots.

Field Summary

private int	value The integer value of this coordinate type.
private static Map<Integer,ExtraValue.CoordinateType>	valueMapping Maps the integer that is stored in the database with an fileaction.

Method Summary

static ExtraValue.CoordinateType	fromValue(int value) Get the CoordinateType object when you know the integer code.
int	getValue() Get the integer value that is used when storing a CoordinateType
abstract VirtualTable	getVirtualTable(Type valueType) Get the VirtualTable used to store extra values of this coordinate type given the value type.
static ExtraValue.CoordinateType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExtraValue.CoordinateType[]	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

Enum Constant Detail

SPOT

public static final ExtraValue.CoordinateType SPOT

The extra values are attached to spots. Ie. position/column coordinates.

POSITION

public static final ExtraValue.CoordinateType POSITION

The extra values are attached to position coordinates only.

COLUMN

public static final ExtraValue.CoordinateType COLUMN

The extra values are attached to column coordinates only.

Field Detail

valueMapping

private static final Map<Integer,ExtraValue.CoordinateType> valueMapping

Maps the integer that is stored in the database with an fileaction.

value

private final int value

The integer value of this coordinate type. Used when stored in the database.

Method Detail

values

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

Returns:

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

valueOf

public static ExtraValue.CoordinateType 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 ExtraValue.CoordinateType fromValue(int value)

Get the CoordinateType object when you know the integer code.

Parameters:

value - The integer value

Returns:

The CoordinateType for the integer value, or null if not found

getValue

public int getValue()

Get the integer value that is used when storing a CoordinateType

Returns:

The intger value of this coordinate type

getVirtualTable

public abstract VirtualTable getVirtualTable(Type valueType)

Get the VirtualTable used to store extra values of this coordinate type given the value type.

Parameters:

valueType - The type of the values to store