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

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

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

Enum of possible sort criterions for factors.

Author:
dkokotov

Enum Constant Summary
NAME
          name.
TYPE
          type.
 
Method Summary
 java.lang.String getLeftJoinField()
          
 java.lang.String getOrderField()
          
static FactorSortCriterion valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FactorSortCriterion[] 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 FactorSortCriterion NAME
name.


TYPE

public static final FactorSortCriterion TYPE
type.

Method Detail

values

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

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

valueOf

public static FactorSortCriterion 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<Factor>

getLeftJoinField

public java.lang.String getLeftJoinField()

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