org.gcube.indexmanagement.geo
Enum GeoIndexField.DataType

java.lang.Object
  extended by java.lang.Enum<GeoIndexField.DataType>
      extended by org.gcube.indexmanagement.geo.GeoIndexField.DataType
All Implemented Interfaces:
Serializable, Comparable<GeoIndexField.DataType>
Enclosing class:
GeoIndexField

public static enum GeoIndexField.DataType
extends Enum<GeoIndexField.DataType>

An enumeration of accepted data types, along with their respective Class objects and default byte size


Enum Constant Summary
DATE
          The DATE data type.
DOUBLE
          The DOUBLE data type.
FLOAT
          The FLOAT data type.
INT
          The INT data type
LONG
          The LONG data type.
SHORT
          The short data type.
STRING
          The STRING data type.
 
Method Summary
static GeoIndexField.DataType getByName(String name)
          A case insensitive version of valueOf(String).
 int getDefaultSize()
          Getter method for the default byte size of this data type
 Class getTypeClass()
          Getter method for the Class object of this data type
static GeoIndexField.DataType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GeoIndexField.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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SHORT

public static final GeoIndexField.DataType SHORT
The short data type.


INT

public static final GeoIndexField.DataType INT
The INT data type


LONG

public static final GeoIndexField.DataType LONG
The LONG data type.


DATE

public static final GeoIndexField.DataType DATE
The DATE data type.


FLOAT

public static final GeoIndexField.DataType FLOAT
The FLOAT data type.


DOUBLE

public static final GeoIndexField.DataType DOUBLE
The DOUBLE data type.


STRING

public static final GeoIndexField.DataType STRING
The STRING data type.

Method Detail

values

public static GeoIndexField.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 (GeoIndexField.DataType c : GeoIndexField.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 GeoIndexField.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

getByName

public static GeoIndexField.DataType getByName(String name)
                                        throws Exception
A case insensitive version of valueOf(String).

Parameters:
name - - the string value to gte the type for
Returns:
DataType of the input string name.
Throws:
IndexException - - in case of failure.
Exception

getTypeClass

public Class getTypeClass()
Getter method for the Class object of this data type

Returns:
the Class object of this data type

getDefaultSize

public int getDefaultSize()
Getter method for the default byte size of this data type

Returns:
the default byte size of this data type


Copyright © 2013. All Rights Reserved.