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

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

public enum SearchSourceCategory
extends java.lang.Enum<SearchSourceCategory>
implements BiomaterialSearchCategory

Author:
mshestopalov

Enum Constant Summary
SAMPLE_CELL_TYPE
          Cell Type.
SAMPLE_DISEASE_STATE
          Disease State.
SAMPLE_EXPERIMENT_TITLE
          Experiment title.
SAMPLE_MATERIAL_TYPE
          Material Type.
SAMPLE_ORGANISM
          Organism.
SAMPLE_PROVIDER
          Source Provider.
SAMPLE_TISSUE_SITE
          Tissue Site.
 
Method Summary
 java.lang.String[] getJoins()
          These are the fields to join against in the HQL query.
 java.lang.String getResourceKey()
          
 java.lang.String getWhereClause()
          
static SearchSourceCategory valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SearchSourceCategory[] 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

SAMPLE_DISEASE_STATE

public static final SearchSourceCategory SAMPLE_DISEASE_STATE
Disease State.


SAMPLE_TISSUE_SITE

public static final SearchSourceCategory SAMPLE_TISSUE_SITE
Tissue Site.


SAMPLE_ORGANISM

public static final SearchSourceCategory SAMPLE_ORGANISM
Organism.


SAMPLE_EXPERIMENT_TITLE

public static final SearchSourceCategory SAMPLE_EXPERIMENT_TITLE
Experiment title.


SAMPLE_MATERIAL_TYPE

public static final SearchSourceCategory SAMPLE_MATERIAL_TYPE
Material Type.


SAMPLE_CELL_TYPE

public static final SearchSourceCategory SAMPLE_CELL_TYPE
Cell Type.


SAMPLE_PROVIDER

public static final SearchSourceCategory SAMPLE_PROVIDER
Source Provider.

Method Detail

values

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

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

valueOf

public static SearchSourceCategory 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
Specified by:
getResourceKey in interface BiomaterialSearchCategory
Returns:
the resource key that should be used to retrieve a label for this SearchCategory in the UI

getJoins

public java.lang.String[] getJoins()
These are the fields to join against in the HQL query. Is null if no join is necessary.

Specified by:
getJoins in interface BiomaterialSearchCategory
Returns:
the fields to join against

getWhereClause

public java.lang.String getWhereClause()

Specified by:
getWhereClause in interface BiomaterialSearchCategory
Returns:
the where subclause for this search category. this method assumes that the subclause will be wrapped in parenthesis before being added to the overall where clause of a query.