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

java.lang.Object
  extended by java.lang.Enum<SampleSortCriterion>
      extended by gov.nih.nci.caarray.domain.search.SampleSortCriterion
All Implemented Interfaces:
com.fiveamsolutions.nci.commons.data.search.SortCriterion<Sample>, java.io.Serializable, java.lang.Comparable<SampleSortCriterion>

public enum SampleSortCriterion
extends java.lang.Enum<SampleSortCriterion>
implements com.fiveamsolutions.nci.commons.data.search.SortCriterion<Sample>

Enum of possible sort criterions for samples.

Author:
dkokotov

Enum Constant Summary
CELLTYPE
          cell type.
DESCRIPTION
          description.
DISEASESTATE
          diseasestate.
MATERIALTYPE
          material type.
NAME
          name.
ORGANISM
          Organism.
TISSUESITE
          tissuesite.
TITLE
          Experiment title.
 
Method Summary
 java.lang.String getLeftJoinField()
          
 java.lang.String getOrderField()
          
static SampleSortCriterion valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SampleSortCriterion[] 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 SampleSortCriterion NAME
name.


TITLE

public static final SampleSortCriterion TITLE
Experiment title.


ORGANISM

public static final SampleSortCriterion ORGANISM
Organism.


TISSUESITE

public static final SampleSortCriterion TISSUESITE
tissuesite.


MATERIALTYPE

public static final SampleSortCriterion MATERIALTYPE
material type.


CELLTYPE

public static final SampleSortCriterion CELLTYPE
cell type.


DISEASESTATE

public static final SampleSortCriterion DISEASESTATE
diseasestate.


DESCRIPTION

public static final SampleSortCriterion DESCRIPTION
description.

Method Detail

values

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

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

valueOf

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

getOrderField

public java.lang.String getOrderField()

Specified by:
getOrderField in interface com.fiveamsolutions.nci.commons.data.search.SortCriterion<Sample>

getLeftJoinField

public java.lang.String getLeftJoinField()

Specified by:
getLeftJoinField in interface com.fiveamsolutions.nci.commons.data.search.SortCriterion<Sample>