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

Enum GeonamesAPIWrapper.SearchRequestPropertyEnum

java.lang.Object

java.lang.Enum<GeonamesAPIWrapper.SearchRequestPropertyEnum>

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

All Implemented Interfaces:

Serializable, Comparable<GeonamesAPIWrapper.SearchRequestPropertyEnum>

Enclosing class:

GeonamesAPIWrapper

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

Enumeration that contains the property definitions used by the LocationEnhancementEngine. This enum does not define all properties defined by geonames.org

Author:

Rupert Westenthaler

Enum Constant Summary

Enum Constants

Enum Constant and Description
adminCode1 level1 admin code to restrict the search
adminCode2 level2 admin code to restrict the search
adminCode3 level3 admin code to restrict the search
continentCode Restrict search to an continent
country the ISO 3166 code of countries to restrict the search
featureClass Feature Class of searched entities (multiple possible)
featureCode Restrict search to one or more specific feature codes
lang The language of the parsed name.
maxRows the maximum number of results (must be < 1000).
name search Toponyms by name
startRow the index of the first result returned
style The detail level of the response.
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.SearchRequestPropertyEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeonamesAPIWrapper.SearchRequestPropertyEnum[]	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

name

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum name

search Toponyms by name

maxRows

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum maxRows

the maximum number of results (must be < 1000). Default is set to 5

startRow

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum startRow

the index of the first result returned

country

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum country

the ISO 3166 code of countries to restrict the search

continentCode

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum continentCode

Restrict search to an continent

adminCode1

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum adminCode1

level1 admin code to restrict the search

adminCode2

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum adminCode2

level2 admin code to restrict the search

adminCode3

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum adminCode3

level3 admin code to restrict the search

featureClass

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum featureClass

Feature Class of searched entities (multiple possible)

featureCode

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum featureCode

Restrict search to one or more specific feature codes

lang

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum lang

The language of the parsed name. Also will use this language for the returned name of found toponyms

type

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum type

The encoding of the results. Default is set to json. Geonames.org would use XML as default if this parameter is not defined

style

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum style

The detail level of the response. Default is set to FULL, because the score of results is only present with this mode.

username

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum username

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

token

public static final GeonamesAPIWrapper.SearchRequestPropertyEnum token

The token required for requests of premium accounts

Method Detail

values

public static GeonamesAPIWrapper.SearchRequestPropertyEnum[] 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.SearchRequestPropertyEnum c : GeonamesAPIWrapper.SearchRequestPropertyEnum.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.SearchRequestPropertyEnum 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.SearchRequestPropertyEnum>