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

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

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

Author:
Winston Cheng

Enum Constant Summary
ARRAY_DESIGN
          Array design.
ARRAY_PROVIDER
          Array provider.
DISEASE_STATE
          Disease state.
EXPERIMENT_DESCRIPTION
          Experiment title.
EXPERIMENT_ID
          Experiment ID.
EXPERIMENT_TITLE
          Experiment title.
ORGANISM
          Organism.
PUBLICATION_AUTHOR
          Publication Author.
PUBMED_ID
          Pubmed ID.
SAMPLE
          Sample.
 
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 SearchCategory valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SearchCategory[] 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

EXPERIMENT_TITLE

public static final SearchCategory EXPERIMENT_TITLE
Experiment title.


EXPERIMENT_ID

public static final SearchCategory EXPERIMENT_ID
Experiment ID.


EXPERIMENT_DESCRIPTION

public static final SearchCategory EXPERIMENT_DESCRIPTION
Experiment title.


ARRAY_PROVIDER

public static final SearchCategory ARRAY_PROVIDER
Array provider.


ARRAY_DESIGN

public static final SearchCategory ARRAY_DESIGN
Array design.


ORGANISM

public static final SearchCategory ORGANISM
Organism.


SAMPLE

public static final SearchCategory SAMPLE
Sample.


PUBMED_ID

public static final SearchCategory PUBMED_ID
Pubmed ID.


PUBLICATION_AUTHOR

public static final SearchCategory PUBLICATION_AUTHOR
Publication Author.


DISEASE_STATE

public static final SearchCategory DISEASE_STATE
Disease state.

Method Detail

values

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

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

valueOf

public static SearchCategory 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 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.

Returns:
the fields to join against

getWhereClause

public java.lang.String getWhereClause()
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.