gov.nih.nci.caarray.domain.search
Enum BrowseCategory

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

public enum BrowseCategory
extends java.lang.Enum<BrowseCategory>
implements ResourceBasedEnum

Author:
Winston Cheng

Enum Constant Summary
ARRAY_DESIGNS
          Array designs.
ARRAY_PROVIDERS
          Array providers.
EXPERIMENTS
          Experiments.
ORGANISMS
          Organisms.
 
Method Summary
 java.lang.String getField()
           
 java.lang.String getJoin()
           
 java.lang.String getResourceKey()
           
static BrowseCategory valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static BrowseCategory[] 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

EXPERIMENTS

public static final BrowseCategory EXPERIMENTS
Experiments.


ORGANISMS

public static final BrowseCategory ORGANISMS
Organisms.


ARRAY_PROVIDERS

public static final BrowseCategory ARRAY_PROVIDERS
Array providers.


ARRAY_DESIGNS

public static final BrowseCategory ARRAY_DESIGNS
Array designs.

Method Detail

values

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

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

valueOf

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

getResourceKey

public java.lang.String getResourceKey()
Specified by:
getResourceKey in interface ResourceBasedEnum
Returns:
the resource key that should be used to retrieve a label for this BrowseCategory in the UI

getJoin

public java.lang.String getJoin()
Returns:
the join table

getField

public java.lang.String getField()
Returns:
the field that represents this category