gov.nasa.gsfc.drl.rtstps.core.output.hdf5
Enum Collection

java.lang.Object
  extended by java.lang.Enum<Collection>
      extended by gov.nasa.gsfc.drl.rtstps.core.output.hdf5.Collection
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Collection>

public enum Collection
extends java.lang.Enum<Collection>

A Collection is defined by the JPSS/NPOESS documentation for RDRs. This package support four at this time: VIIRS, ATMS, CrIS and Spacecraft Diary (attitude and ephemeris)


Enum Constant Summary
ATMS_SCIENCE_RDR
           
CrIS_SCIENCE_RDR
           
SPACECRAFT_DIARY_RDR
           
VIIRS_SCIENCE_RDR
           
 
Method Summary
static Collection fromRDRName(RDRName rdrName)
          Return the Collection from an RDR name.
static Collection myValueOf(java.lang.String collectionStr)
          Replaces valueOf which doesn't know about the "-" vs "_" issues
 java.lang.String toString()
          Return the Collection name as String but swap the underscores with a hyphen because this is what is needed by the RDR attributes in the HDF file.
static Collection valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Collection[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

VIIRS_SCIENCE_RDR

public static final Collection VIIRS_SCIENCE_RDR

ATMS_SCIENCE_RDR

public static final Collection ATMS_SCIENCE_RDR

CrIS_SCIENCE_RDR

public static final Collection CrIS_SCIENCE_RDR

SPACECRAFT_DIARY_RDR

public static final Collection SPACECRAFT_DIARY_RDR
Method Detail

values

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

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

valueOf

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

fromRDRName

public static Collection fromRDRName(RDRName rdrName)
Return the Collection from an RDR name.

Returns:
a Collection matching the RDR name or null if no match is found

toString

public java.lang.String toString()
Return the Collection name as String but swap the underscores with a hyphen because this is what is needed by the RDR attributes in the HDF file.

Overrides:
toString in class java.lang.Enum<Collection>
Returns:
a String representing the Collection with the '_' replaced by '-'

myValueOf

public static Collection myValueOf(java.lang.String collectionStr)
Replaces valueOf which doesn't know about the "-" vs "_" issues

Parameters:
collectionStr - a String like this SPACECRAFT-DIARY-RDR
Returns:
the matching Collection or null if no match is found