PoiSource Class Reference

Poi sources can be any kind of data, which optionally can be loaded from a iwDataServer, like Pois or traffic flows.
More...

Inheritance diagram for PoiSource:

Public Member Functions
void	addTaskListener (TaskListener listener)
boolean	equals (Object o)
native ComputationSite	getAllowedDataSites ()
native ComputationSite	getAvailableDataSites ()
Iterable< PoiSource >	getChildSources ()
native String	getDescription ()
native boolean	getIsInitialized ()
native String	getName ()
Iterable< PoiCategory >	getPoiCategories ()
native PoisourceType	getType ()
void	removeAllTaskListeners ()
void	removeTaskListener (TaskListener listener)
ApiError	setAllowedDataSites (final ComputationSite computationSite)

Static Public Member Functions
static Iterable< PoiSource >	getPoiSources ()
static ApiError	injectPoisByXmlFile (final String xmlFilePath, final String poiTagName, final String memoryPoiSourceName)
static ApiError	injectSourceByXml (final String xmlDocument)

Detailed Description

These sources are configurable in the Pois.xml in the res folder.

Member Function Documentation

addTaskListener()

void addTaskListener

(

TaskListener

listener

)

equals()

boolean equals ( Object  o )

inherited

getAllowedDataSites()

native ComputationSite getAllowedDataSites

(

)

Deprecated:

Returns

the allowed sites, from where the data for this source may taken from.

getAvailableDataSites()

native ComputationSite getAvailableDataSites

(

)

Deprecated:

Returns the possible sites, from where the data for this source may taken from. This makes only sense for sources of type MTA_POISOURCE_TYPE_DATASERVERDATASET (See MTA_POISOURCE_TYPE). Other sources will always return MTA_CS_ONBOARD, even if it's a child source of a data server source. By default, each data server source is only MTA_CS_OFFBOARD.

Returns

available data sites

getChildSources()

Iterable< PoiSource > getChildSources

(

)

Returns

iterator all child poi sources

getDescription()

native String getDescription

(

)

Returns

textual poi source description

getIsInitialized()

native boolean getIsInitialized

(

)

Returns

true if the poi source is initialized and can be used

getName()

native String getName

(

)

Returns

poi source name

getPoiCategories()

Iterable< PoiCategory > getPoiCategories

(

)

Returns

iterator over all PoiCategory of this PoiSource

getPoiSources()

static Iterable< PoiSource > getPoiSources ( )

static

Returns

iterator of type PoiSource

getType()

native PoisourceType getType

(

)

Returns

type of the poisource

injectPoisByXmlFile()

static ApiError injectPoisByXmlFile ( final String  xmlFilePath, final String  poiTagName, final String  memoryPoiSourceName  )

static

Creates a new poi source, which is defined by the xml string.

Parameters

xmlFilePath	- Complete path to the xml file, which contains the pois
poiTagName	- The xml tag name, which contains a single poi
memoryPoiSourceName	- The memory poi source, to where the pois are added

Returns

ApiError.GENERAL_ERROR, if the the xml is not valid.

injectSourceByXml()

static ApiError injectSourceByXml ( final String  xmlDocument )

static

Creates a new poi source, which is defined by the xml string.

Parameters

xmlDocument

- A complete xml document

Returns

ApiError.GENERAL_ERROR, if the the xml is not valid.

removeAllTaskListeners()

void removeAllTaskListeners

(

)

removeTaskListener()

void removeTaskListener

(

TaskListener

listener

)

setAllowedDataSites()

ApiError setAllowedDataSites

(

final ComputationSite

computationSite

)

DEACTIVATED!

Parameters

computationSite

the allowed data site, from where the data for this source may taken from.

Returns

Errorcode

• ApiError.OK on success

---

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

• PoiSource.java