gov.nih.nci.caarray.domain.data
Enum DesignElementType

java.lang.Object
  extended by java.lang.Enum<DesignElementType>
      extended by gov.nih.nci.caarray.domain.data.DesignElementType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DesignElementType>

public enum DesignElementType
extends java.lang.Enum<DesignElementType>

Specifies whether a microarray element refers to a location (feature), probe, or probeset.


Enum Constant Summary
FEATURE
          A specific position on a microarray.
LOGICAL_PROBE
          A collection of reporters that together provide the quantification of a single genomic sequence.
PHYSICAL_PROBE
          A reporter with a specific location on a microarray that quantities the amount of a specifc genomic sequence.
 
Method Summary
static void checkType(java.lang.String value)
          Checks to see that the value given is a legal DesignElementType value.
static DesignElementType getByValue(java.lang.String value)
          Returns the DesignElementType corresponding to the given value.
 java.lang.String getValue()
           
static DesignElementType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DesignElementType[] 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

FEATURE

public static final DesignElementType FEATURE
A specific position on a microarray.


PHYSICAL_PROBE

public static final DesignElementType PHYSICAL_PROBE
A reporter with a specific location on a microarray that quantities the amount of a specifc genomic sequence.


LOGICAL_PROBE

public static final DesignElementType LOGICAL_PROBE
A collection of reporters that together provide the quantification of a single genomic sequence.

Method Detail

values

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

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

valueOf

public static DesignElementType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()
Returns:
the value

getByValue

public static DesignElementType getByValue(java.lang.String value)
Returns the DesignElementType corresponding to the given value. Returns null for null value.

Parameters:
value - the value to match
Returns:
the matching type.

checkType

public static void checkType(java.lang.String value)
Checks to see that the value given is a legal DesignElementType value.

Parameters:
value - the value to check;