org.opensha.commons.eq.cat.util
Enum DataType

java.lang.Object
  extended by java.lang.Enum<DataType>
      extended by org.opensha.commons.eq.cat.util.DataType
All Implemented Interfaces:
Serializable, Comparable<DataType>

public enum DataType
extends Enum<DataType>

Values for different catalog data types.

Version:
$Id: DataType.java 7478 2011-02-15 04:56:25Z pmpowers $
Author:
Peter Powers

Enum Constant Summary
DEPTH
          Event depth data identifier.
DIP
          Event fault plane dip data identifier.
EVENT_ID
          Event ID data identifier.
EVENT_TYPE
          Event type data identifier.
FAULT_DISTANCE
          Distance of event from assiociated fault data identifier.
LATITUDE
          Event latitude data identifier.
LONGITUDE
          Event longitude data identifier.
MAGNITUDE
          Event magnitude data identifier.
MAGNITUDE_TYPE
          Event magnitude type data identifier.
QUALITY
          Event location quality data identifier.
RAKE
          Event fault plane rake data identifier.
STRIKE
          Event fault plane strike data identifier.
TIME
          Event time data identifier.
XY_ERROR
          Event horizontal error data identifier.
Z_ERROR
          Event vertical error data identifier.
 
Method Summary
 Class<?> clazz()
          Returns the class
 Double maxLimit()
          Returns the maximum possible value for this DataType.
 Double minLimit()
          Returns the minimum possible value for this DataType.
 String toString()
          Overriden to return a label friendly String.
static DataType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static DataType[] 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

EVENT_ID

public static final DataType EVENT_ID
Event ID data identifier.


EVENT_TYPE

public static final DataType EVENT_TYPE
Event type data identifier.


TIME

public static final DataType TIME
Event time data identifier.


LONGITUDE

public static final DataType LONGITUDE
Event longitude data identifier.


LATITUDE

public static final DataType LATITUDE
Event latitude data identifier.


DEPTH

public static final DataType DEPTH
Event depth data identifier.


QUALITY

public static final DataType QUALITY
Event location quality data identifier.


XY_ERROR

public static final DataType XY_ERROR
Event horizontal error data identifier.


Z_ERROR

public static final DataType Z_ERROR
Event vertical error data identifier.


MAGNITUDE

public static final DataType MAGNITUDE
Event magnitude data identifier.


MAGNITUDE_TYPE

public static final DataType MAGNITUDE_TYPE
Event magnitude type data identifier.


STRIKE

public static final DataType STRIKE
Event fault plane strike data identifier.


DIP

public static final DataType DIP
Event fault plane dip data identifier.


RAKE

public static final DataType RAKE
Event fault plane rake data identifier.


FAULT_DISTANCE

public static final DataType FAULT_DISTANCE
Distance of event from assiociated fault data identifier.

Method Detail

values

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

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

valueOf

public static DataType valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

clazz

public Class<?> clazz()
Returns the class

Returns:
the array class that will hold data for this type.

toString

public String toString()
Overriden to return a label friendly String.

Overrides:
toString in class Enum<DataType>
Returns:
a String value for labels.

minLimit

public Double minLimit()
Returns the minimum possible value for this DataType. Method is only applicable for the following double-valued DataTypes: [LONGITUDE, LATITUDE, DEPTH, MAGNITUDE]. Requests on any other DataType return null.

Returns:
the lower limit value
See Also:
for values, for values

maxLimit

public Double maxLimit()
Returns the maximum possible value for this DataType. Method is only applicable for the following double-valued DataTypes: [LONGITUDE, LATITUDE, DEPTH, MAGNITUDE]. Requests on any other DataType return null.

Returns:
the upper limit value
See Also:
for values, for values