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

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

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

Search criteria for the external API search for biomaterials by keyword.

Author:
dkokotov

Enum Constant Summary
CELL_TYPE
          Cell Type.
DISEASE_STATE
          Disease State.
EXPERIMENT_TITLE
          Experiment title.
EXTERNAL_ID
          External Id.
MATERIAL_TYPE
          Material Type.
NAME
          Name.
ORGANISM
          Organism.
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 ExternalBiomaterialSearchCategory valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ExternalBiomaterialSearchCategory[] 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

NAME

public static final ExternalBiomaterialSearchCategory NAME
Name.


EXTERNAL_ID

public static final ExternalBiomaterialSearchCategory EXTERNAL_ID
External Id.


DISEASE_STATE

public static final ExternalBiomaterialSearchCategory DISEASE_STATE
Disease State.


TISSUE_SITE

public static final ExternalBiomaterialSearchCategory TISSUE_SITE
Tissue Site.


ORGANISM

public static final ExternalBiomaterialSearchCategory ORGANISM
Organism.


EXPERIMENT_TITLE

public static final ExternalBiomaterialSearchCategory EXPERIMENT_TITLE
Experiment title.


MATERIAL_TYPE

public static final ExternalBiomaterialSearchCategory MATERIAL_TYPE
Material Type.


CELL_TYPE

public static final ExternalBiomaterialSearchCategory CELL_TYPE
Cell Type.

Method Detail

values

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

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

valueOf

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