com.bericotech.clavin.resolver.multipart

Enum SearchLevel

java.lang.Object

java.lang.Enum<SearchLevel>

com.bericotech.clavin.resolver.multipart.SearchLevel

All Implemented Interfaces:

Serializable, Comparable<SearchLevel>

public enum SearchLevel
extends Enum<SearchLevel>

A roll-up of feature classes and codes that assists in searching for locations that fall into a particular category.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN1
ADMIN2
ADMIN3
ADMIN4
ADMINX
CITY
COUNTRY

Method Summary

Methods

Modifier and Type	Method and Description
QueryBuilder	apply(QueryBuilder builder)
SearchLevel	broaden()
boolean	canNarrow()
static SearchLevel	forGeoName(GeoName name)
String	getCode(GeoName geoName)
boolean	isAdmin()
SearchLevel	narrow()
static SearchLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchLevel[]	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

COUNTRY

public static final SearchLevel COUNTRY

ADMIN1

public static final SearchLevel ADMIN1

ADMIN2

public static final SearchLevel ADMIN2

ADMIN3

public static final SearchLevel ADMIN3

ADMIN4

public static final SearchLevel ADMIN4

ADMINX

public static final SearchLevel ADMINX

CITY

public static final SearchLevel CITY

Method Detail

values

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

Returns:

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

valueOf

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

forGeoName

public static SearchLevel forGeoName(GeoName name)

apply

public QueryBuilder apply(QueryBuilder builder)

narrow

public SearchLevel narrow()

canNarrow

public boolean canNarrow()

broaden

public SearchLevel broaden()

getCode

public String getCode(GeoName geoName)

isAdmin

public boolean isAdmin()