com.askgeo.dbl.base
Enum ResultField

java.lang.Object
  extended by java.lang.Enum<ResultField>
      extended by com.askgeo.dbl.base.ResultField
All Implemented Interfaces:
DataFieldInterface, java.io.Serializable, java.lang.Comparable<ResultField>

public enum ResultField
extends java.lang.Enum<ResultField>
implements DataFieldInterface

The ResultField class enumerates some of the return values that are included in the subclasses of the ResultBase class as return values to a query on a subclass of the GeneralMap class. In particular, it enumerates those pertaining to the query, such as whether the query point was inside the shape, and if not the distance to the shape from the query point.


Enum Constant Summary
AskGeoId
          The internally-used AskGeo unique ID for the returned polygon
IsInside
          Whether or not the query point is inside the returned polygon
MinDistanceKm
          The distance from the query point to the nearest interior point of the returned polygon
 
Method Summary
 java.lang.String description()
          Returns a human-readable description of the data field.
 FieldType fieldType()
          Returns the FieldType corresponding to this FieldUnit.
 FieldUnit fieldUnit()
          Specifies the FieldUnit of the field.
static ResultField valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ResultField[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.askgeo.dbl.base.DataFieldInterface
name, ordinal
 

Enum Constant Detail

AskGeoId

public static final ResultField AskGeoId
The internally-used AskGeo unique ID for the returned polygon


IsInside

public static final ResultField IsInside
Whether or not the query point is inside the returned polygon


MinDistanceKm

public static final ResultField MinDistanceKm
The distance from the query point to the nearest interior point of the returned polygon

Method Detail

values

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

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

valueOf

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

fieldType

public FieldType fieldType()
Returns the FieldType corresponding to this FieldUnit. Most units are represented by the FieldType.FLOAT type, but fields with no unit (such as a code, or a boolean variable) are of FieldType.STRING, FieldType.BOOLEAN, or FieldType.INTEGER.

Returns:
the FieldType of a this FieldUnit.

fieldUnit

public FieldUnit fieldUnit()
Description copied from interface: DataFieldInterface
Specifies the FieldUnit of the field. The FieldUnit is the logical unit of the reported value, such as "people", "dollars", and "percent".

Specified by:
fieldUnit in interface DataFieldInterface
Returns:
the FieldUnit of the data field.

description

public java.lang.String description()
Description copied from interface: DataFieldInterface
Returns a human-readable description of the data field.

Specified by:
description in interface DataFieldInterface
Returns:
the description of the data field.


Copyright © 2012 Vector Magic, Inc.