PoiCategory Class Reference

Points of interest (POIs) are waypoints marking some special location. These are grouped in categories (defined by this class) which can be used f.e. to search or display waypoints of the appropriate PoiCategory in the map.
More...

Inheritance diagram for PoiCategory:

Public Member Functions
boolean	equals (Object o)
native String	getHtmlUrl ()
native String	getIconPath ()
native String	getIdColumn ()
native String	getName ()
native Iterable< PoiCategory >	getSubCategories ()
native String	getTypeIdStr ()
int	getWarningDistance ()
String	getWarningFilter ()
native boolean	hasSubCategories ()
void	setWarningDistance (final int distance)
void	setWarningFilter (final String filter)

Static Public Member Functions
static native PoiCategory	getCurrentlyVisibleCategory (Mapviewer view)
static native PoiCategory	getToplevelCategory ()

Detailed Description

The POI's are provided by a PoiSource. POIs are subdivided into categories as gas stations, pharmacies, restaurants etc.. A category can have subcategories. Call PoiCategory.getToplevelCategory() to get the top level category.

Member Function Documentation

equals()

boolean equals ( Object  o )

inherited

getCurrentlyVisibleCategory()

static native PoiCategory getCurrentlyVisibleCategory ( Mapviewer  view )

static

Gets an artificial poi category, which has all currently visible poi categories as SubCategories. You can use this category in PoiCategory.getSubCategories() to browse through all currently visible poi categories. These categories must be enabled AND currently really visible on the map - according to its visibility start and visibility end settings.

Parameters

view	- map to check visibility for

Returns

A virtual PoiCategory containing all visible PoiCategories as children for the given map

getHtmlUrl()

native String getHtmlUrl

(

)

Returns

the optional url for html pages for pois of a category

getIconPath()

native String getIconPath

(

)

Returns

absolute path to the icon used for the PoiCategory

getIdColumn()

native String getIdColumn

(

)

Returns

the optional User Attribute name for dynamic content (currently only for xml or html of MapContentServer)!

getName()

native String getName

(

)

Returns

name of the poi category

getSubCategories()

native Iterable< PoiCategory > getSubCategories

(

)

Returns

iterator of type PoiCategory for all child categories

getToplevelCategory()

static native PoiCategory getToplevelCategory ( )

static

Gets the top level PoiCategory. This is an artificial poi category that contains all available PoiCategories in all PoiSources. You can use this category in PoiCategory.getSubCategories() to browse through all poi categories.

Returns

A virtual PoiCategory containing all available PoiCategories as children

getTypeIdStr()

native String getTypeIdStr

(

)

Returns

the unique type ID of a category as a string

getWarningDistance()

int getWarningDistance

(

)

Returns

the distance from a poi of this category to the the current gps location that has to be reached in order to trigger an activated poi notifier

getWarningFilter()

String getWarningFilter

(

)

Returns

filter string, which must be found in the name of a poi of this category, before the poi notifier fires.

hasSubCategories()

native boolean hasSubCategories

(

)

Returns

True if POI category has subcategories.

setWarningDistance()

void setWarningDistance

(

final int

distance

)

Parameters

distance

in meters from current position to any poi of this category, when the poi notifier fires!

setWarningFilter()

void setWarningFilter

(

final String

filter

)

Parameters

filter

string, which must be found in the name of a poi of this category, before the poi notifier fires.

---

The documentation for this class was generated from the following file:

• PoiCategory.java