org.apache.stanbol.enhancer.engines.geonames.impl

Enum GeonamesAPIWrapper.HierarchyRequestPorpertyEnum

java.lang.Object

java.lang.Enum<GeonamesAPIWrapper.HierarchyRequestPorpertyEnum>

org.apache.stanbol.enhancer.engines.geonames.impl.GeonamesAPIWrapper.HierarchyRequestPorpertyEnum

All Implemented Interfaces:

Serializable, Comparable<GeonamesAPIWrapper.HierarchyRequestPorpertyEnum>

Enclosing class:

GeonamesAPIWrapper

public static enum GeonamesAPIWrapper.HierarchyRequestPorpertyEnum
extends Enum<GeonamesAPIWrapper.HierarchyRequestPorpertyEnum>

Enum Constant Summary

Enum Constants

Enum Constant and Description
geonameId The ID of the Toponym the hierarchy is requested for
lang Also not documented but supported is that the hierarchy service supports the language attribute.
style Even not documented also the hierarchy service does support the style parameter as documented for the search service.
token The token required for requests of premium accounts
type The encoding of the results.
username Can be used to parse the user name needed for premium accounts

Method Summary

Modifier and Type	Method and Description
RequestProperty	getProperty()
String	toString()
static GeonamesAPIWrapper.HierarchyRequestPorpertyEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeonamesAPIWrapper.HierarchyRequestPorpertyEnum[]	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

geonameId

public static final GeonamesAPIWrapper.HierarchyRequestPorpertyEnum geonameId

The ID of the Toponym the hierarchy is requested for

type

public static final GeonamesAPIWrapper.HierarchyRequestPorpertyEnum type

The encoding of the results. Default is set to "json". geonames.org would set the default to xml if this property is not defined

style

public static final GeonamesAPIWrapper.HierarchyRequestPorpertyEnum style

Even not documented also the hierarchy service does support the style parameter as documented for the search service. Parse "FULL" to get all the alternate labels

lang

public static final GeonamesAPIWrapper.HierarchyRequestPorpertyEnum lang

Also not documented but supported is that the hierarchy service supports the language attribute. This is especially interesting because the name property of results will use the label in the parsed language. The toponymName property will provide the preferred name!

username

public static final GeonamesAPIWrapper.HierarchyRequestPorpertyEnum username

Can be used to parse the user name needed for premium accounts

token

public static final GeonamesAPIWrapper.HierarchyRequestPorpertyEnum token

The token required for requests of premium accounts

Method Detail

values

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

Returns:

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

valueOf

public static GeonamesAPIWrapper.HierarchyRequestPorpertyEnum 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

getProperty

public RequestProperty getProperty()

toString

public String toString()

Overrides:

toString in class Enum<GeonamesAPIWrapper.HierarchyRequestPorpertyEnum>