com.askgeo.dbl.naturalearth
Enum CountryMap.DataField

java.lang.Object
  extended by java.lang.Enum<CountryMap.DataField>
      extended by com.askgeo.dbl.naturalearth.CountryMap.DataField
All Implemented Interfaces:
DataFieldInterface, java.io.Serializable, java.lang.Comparable<CountryMap.DataField>
Enclosing class:
CountryMap

public static enum CountryMap.DataField
extends java.lang.Enum<CountryMap.DataField>
implements DataFieldInterface

Enumerates the metadata associated with each shape in the map.


Enum Constant Summary
Abbreviation
          Long form abbreviation, for example, Berm., Rep.
AbbreviationPostal
          One or two letter postal abbreviation (has gaps)
EntityType
          Entity type: 'Country', 'Sovereign country', 'Dependency', 'Disputed', 'Indeterminate', or 'Lease' (no gaps)
IsNotSovereign
          Indicates if this entity has its own sovereignty, 0: false, 1: true (no gaps)
Iso3166A2
          ISO-3166-2 two-letter country code (has gaps, missing values: -99)
Iso3166A3
          ISO-3166-3 three-letter country code (has gaps, missing values: -99)
MapColorCode
          Color index from US State Department political world map where no neighboring country has the same color, but all territories of a sovereign country share the same color (no gaps)
NameAdministrative
          Administrative name (probably the most useful name all around, no gaps)
NameFormal
          Formal name (has gaps)
NameShort
          Short form name of entity, including common abbreviations, for example, 'Island' becomes 'Is.' (has gaps)
NameSortable
          Name suitable for sorting (no gaps)
NameSovereignty
          Name of the Country that has sovereignty over this entity (no gaps)
NaturalEarthCode
          Internal Natural Earth entity code similar to ISO-3166-3 but without gaps
Notes
          Notes indicating sovereignty relationships, etc.
TotalGdp2009Estimate
          Estimate total GDP in millions of dollars (2009, from World Bank and other sources, has gaps, missing values: -99)
TotalPopulation2009Estimate
          Estimated total population (2009, from UN and other sources, has gaps, missing values: -99)
 
Method Summary
 java.lang.String description()
          Returns a human-readable description of the data field.
 FieldUnit fieldUnit()
          Specifies the FieldUnit of the field.
 java.lang.String originalCode()
           
static CountryMap.DataField valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CountryMap.DataField[] 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

NaturalEarthCode

public static final CountryMap.DataField NaturalEarthCode
Internal Natural Earth entity code similar to ISO-3166-3 but without gaps


NameSovereignty

public static final CountryMap.DataField NameSovereignty
Name of the Country that has sovereignty over this entity (no gaps)


IsNotSovereign

public static final CountryMap.DataField IsNotSovereign
Indicates if this entity has its own sovereignty, 0: false, 1: true (no gaps)


EntityType

public static final CountryMap.DataField EntityType
Entity type: 'Country', 'Sovereign country', 'Dependency', 'Disputed', 'Indeterminate', or 'Lease' (no gaps)


NameAdministrative

public static final CountryMap.DataField NameAdministrative
Administrative name (probably the most useful name all around, no gaps)


NameShort

public static final CountryMap.DataField NameShort
Short form name of entity, including common abbreviations, for example, 'Island' becomes 'Is.' (has gaps)


Abbreviation

public static final CountryMap.DataField Abbreviation
Long form abbreviation, for example, Berm., Rep. Congo, Cz. Rep. (has gaps)


AbbreviationPostal

public static final CountryMap.DataField AbbreviationPostal
One or two letter postal abbreviation (has gaps)


NameFormal

public static final CountryMap.DataField NameFormal
Formal name (has gaps)


Notes

public static final CountryMap.DataField Notes
Notes indicating sovereignty relationships, etc. (mostly blank)


NameSortable

public static final CountryMap.DataField NameSortable
Name suitable for sorting (no gaps)


MapColorCode

public static final CountryMap.DataField MapColorCode
Color index from US State Department political world map where no neighboring country has the same color, but all territories of a sovereign country share the same color (no gaps)


TotalPopulation2009Estimate

public static final CountryMap.DataField TotalPopulation2009Estimate
Estimated total population (2009, from UN and other sources, has gaps, missing values: -99)


TotalGdp2009Estimate

public static final CountryMap.DataField TotalGdp2009Estimate
Estimate total GDP in millions of dollars (2009, from World Bank and other sources, has gaps, missing values: -99)


Iso3166A2

public static final CountryMap.DataField Iso3166A2
ISO-3166-2 two-letter country code (has gaps, missing values: -99)


Iso3166A3

public static final CountryMap.DataField Iso3166A3
ISO-3166-3 three-letter country code (has gaps, missing values: -99)

Method Detail

values

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

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

valueOf

public static CountryMap.DataField 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

originalCode

public java.lang.String originalCode()

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.

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.


Copyright 2012 Vector Magic, Inc.