Package org.ka2ddo.yaac.osm

Enum Class Place

java.lang.Object

java.lang.Enum<Place>

org.ka2ddo.yaac.osm.Place

All Implemented Interfaces:

Serializable, Comparable<Place>, Constable, EnumMayHaveFlags

public enum Place
extends Enum<Place>
implements EnumMayHaveFlags

Supported types of the OSM place="*" attribute. See the definition of place on the OpenStreetMap wiki.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
archipelago
borough
city
continent
country
county
district
farm
hamlet
island
islet
isolated_dwelling
locality
neighbourhood
ocean
province
region
sea
state
suburb
town
township
user_defined
village

Method Summary

Modifier and Type	Method	Description
WayType	getAdminLevel()	Gets the numeric administrative level that is associated with this level of place.
short	getFlagMask()	Indicates any flag bits implied by this enum type.
float	getMaxZoom()	Get the scale value below which labels for this kind of Place will be displayed.
float	getMinZoom()	Get the scale value above which labels for this kind of Place will be displayed.
void	loadZoom(Preferences node)	Load persisted configuration data for this Place enum
void	saveZoom(Preferences node)	Save persisted configuration data for this Place enum
void	setMaxZoom(float maxZoom)	Set the scale value below which labels for this kind of Place will be displayed.
void	setMinZoom(float minZoom)	Set the scale value above which labels for this kind of Place will be displayed.
static Place	value(String name)	Get the enum value associated with the string name specified.
static Place	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Place[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

user_defined

public static final Place user_defined

isolated_dwelling

public static final Place isolated_dwelling

neighbourhood

public static final Place neighbourhood

hamlet

public static final Place hamlet

village

public static final Place village

town

public static final Place town

suburb

public static final Place suburb

city

public static final Place city

continent

public static final Place continent

country

public static final Place country

county

public static final Place county

region

public static final Place region

state

public static final Place state

locality

public static final Place locality

district

public static final Place district

borough

public static final Place borough

island

public static final Place island

islet

public static final Place islet

archipelago

public static final Place archipelago

township

public static final Place township

province

public static final Place province

sea

public static final Place sea

ocean

public static final Place ocean

farm

public static final Place farm

Method Details

values

public static Place[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Place valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMinZoom

public float getMinZoom()

Get the scale value above which labels for this kind of Place will be displayed.

Returns:

scale value

setMinZoom

public void setMinZoom(float minZoom)

Set the scale value above which labels for this kind of Place will be displayed.

Parameters:

minZoom - scale value

getMaxZoom

public float getMaxZoom()

Get the scale value below which labels for this kind of Place will be displayed.

Returns:

scale value

setMaxZoom

public void setMaxZoom(float maxZoom)

Set the scale value below which labels for this kind of Place will be displayed.

Parameters:

maxZoom - scale value

getAdminLevel

public WayType getAdminLevel()

Gets the numeric administrative level that is associated with this level of place.

Returns:

WayType associated with this hierarchy of Place

value

public static Place value(String name)

Get the enum value associated with the string name specified.

Parameters:

name - String to convert into an Enum

Returns:

Place for the string name, or null if no match

loadZoom

public void loadZoom(Preferences node)

Load persisted configuration data for this Place enum

Parameters:

node - the Preferences node containing persisted Place data

saveZoom

public void saveZoom(Preferences node)

Save persisted configuration data for this Place enum

Parameters:

node - the Preferences node containing persisted Place data

getFlagMask

public short getFlagMask()

Indicates any flag bits implied by this enum type.

Specified by:

getFlagMask in interface EnumMayHaveFlags

Returns:

bitmask of flags if this enum implies flags