com.navigine.idl.java.Location Class Reference

Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc. More...

Public Member Functions
abstract ElevationGraph	getElevationGraph (String tag)
	Method returns location elevation graph ElevationGraph for specified tag.
abstract ArrayList< String >	getGraphTags ()
	Method returns list of available graph tags.
abstract Sublocation	getSublocationById (int id)
	Method is used for obtaining a sublocation with the specified identifier from the current location.
abstract Category	getCategoryById (int id)
	Method is used for obtaining a category with the specified identifier from the current location.
abstract int	getId ()
	location's identifier.
abstract int	getVersion ()
	location's version.
abstract String	getName ()
	location name.
abstract String	getDescript ()
	location's description.
abstract ArrayList< Category >	getCategories ()
	List of venue categories defined for the location Category.
abstract ArrayList< Sublocation >	getSublocations ()
	List of sublocations Sublocation.
abstract boolean	getModified ()
	Flag indicates if location has been modified by user or not.

Detailed Description

Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc.

Location instance can be obtained from LocationManager using LocationListener callback, when the location is loaded.

Referenced from LocationManager LocationListener.

Definition at line 20 of file Location.java.

Member Function Documentation

getCategories()

abstract ArrayList< Category > com.navigine.idl.java.Location.getCategories ( )

abstract

List of venue categories defined for the location Category.

Returns

getCategoryById()

abstract Category com.navigine.idl.java.Location.getCategoryById ( int id )

abstract

Method is used for obtaining a category with the specified identifier from the current location.

Parameters

id	category identifier.

Returns

Category of the current location with the specified identifier, if it exists. If category with the specified identifier doesn't exist, function returns null.

getDescript()

abstract String com.navigine.idl.java.Location.getDescript ( )

abstract

location's description.

Returns

getElevationGraph()

abstract ElevationGraph com.navigine.idl.java.Location.getElevationGraph ( String tag )

abstract

Method returns location elevation graph ElevationGraph for specified tag.

Parameters

tag	Graph tag in CMS

Returns

Elevation graph instance or null.

ElevationGraph of the current location with the specified tag, if it exists. If elevation graph with the specified tag doesn't exist, function returns null.

getGraphTags()

abstract ArrayList< String > com.navigine.idl.java.Location.getGraphTags ( )

abstract

Method returns list of available graph tags.

Returns

Array of existing tags

getId()

abstract int com.navigine.idl.java.Location.getId ( )

abstract

location's identifier.

Returns

getModified()

abstract boolean com.navigine.idl.java.Location.getModified ( )

abstract

Flag indicates if location has been modified by user or not.

Returns

getName()

abstract String com.navigine.idl.java.Location.getName ( )

abstract

location name.

Returns

getSublocationById()

abstract Sublocation com.navigine.idl.java.Location.getSublocationById ( int id )

abstract

Method is used for obtaining a sublocation with the specified identifier from the current location.

Parameters

id	sublocation identifier.

Returns

The Sublocation of the current location with the specified identifier, if it exists. If sublocation with the specified identifier doesn't exist, function returns null.

getSublocations()

abstract ArrayList< Sublocation > com.navigine.idl.java.Location.getSublocations ( )

abstract

List of sublocations Sublocation.

Returns

getVersion()

abstract int com.navigine.idl.java.Location.getVersion ( )

abstract

location's version.

Returns

---

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

• Location.java