Poi Class Reference

Poi class is used to add POIs to Favorites and custom POI category. More...

Public Member Functions
	Poi ()
	Class constructor. More...
	Poi (Position pos, String cat, String name, String address, boolean searchAddr)
	Class constructor. More...
	Poi (int x, int y, String cat, String name, String address, boolean searchAddr)
	Class constructor. More...
boolean	isSearchAddress ()
void	setSearchAddress (boolean searchAddr)
String	getAddress ()
	Returns POI address in "ISO,city,street,house number" format. More...
void	setAddress (String addr)
	Set a string to POI address in "ISO,city,street,house number" format. More...
String	getCategory ()
	Returns POI category. More...
void	setCategory (String cat)
	Set a string to POI category. More...
String	getName ()
	Returns POI name which is shown in POI list. More...
void	setName (String name)
	Sets POI name which is shown in POI list. More...
Position	getLocation ()
	Returns POI location on map. More...
void	setLocation (int x, int y)
	Sets POI location on map. More...
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (Poi poi)
static Poi	readBundle (Bundle b)

Detailed Description

Poi class is used to add POIs to Favorites and custom POI category.

It is also used during retrieving items lists of these categories.

Constructor & Destructor Documentation

Poi() [1/3]

Poi

(

)

Class constructor.

Referenced by Poi.readBundle().

Poi() [2/3]

Poi	(	Position	pos,
		String	cat,
		String	name,
		String	address,
		boolean	searchAddr
	)

Class constructor.

Parameters

pos	Position class determining POI location on map.
cat	Name of custom POI category. POI is member of this category.
name	POI name which is shown in POI list.
address	POI address in "ISO,city,street,house number" format.
searchAddr	Flag determining whether function searches for address when adding POI.

Poi() [3/3]

Poi	(	int	x,
		int	y,
		String	cat,
		String	name,
		String	address,
		boolean	searchAddr
	)

Class constructor.

Parameters

x	coordinate of Position class determining POI location on map.
y	coordinate of Position class determining POI location on map.
cat	Name of custom POI category. POI is member of this category.
name	POI name which is shown in POI list.
address	the address string
searchAddr	Flag determining whether function searches for address when adding POI.

Member Function Documentation

getAddress()

String getAddress

(

)

Returns POI address in "ISO,city,street,house number" format.

Returns

A new string to POI address in "ISO,city,street,house number" format.

Referenced by Poi.writeBundle().

getCategory()

String getCategory

(

)

Returns POI category.

Returns

The name of POI category.

Referenced by Poi.writeBundle().

getLocation()

Position getLocation

(

)

Returns POI location on map.

Returns

POI location on map.

Referenced by Poi.writeBundle().

getName()

String getName

(

)

Returns POI name which is shown in POI list.

Returns

A new string to POI name which is shown in POI list.

Referenced by Poi.writeBundle().

isSearchAddress()

boolean isSearchAddress

(

)

Notes:
Possible values are:

• true Search for address.
• false Do not search for address.

Returns

Flag determining whether function searches for address when adding POI.

Referenced by Poi.writeBundle().

readBundle()

static Poi readBundle ( Bundle  b )

static

References Poi.Poi().

Referenced by ApiPoi.findNearbyPoi(), ApiPoi.findNearbyPoiList(), and ApiPoi.getPoiList().

setAddress()

void setAddress

(

String

addr

)

Set a string to POI address in "ISO,city,street,house number" format.

Parameters

addr	String to POI address in "ISO,city,street,house number" format.

setCategory()

void setCategory

(

String

cat

)

Set a string to POI category.

Parameters

cat	String of POI category name.

setLocation()

void setLocation	(	int	x,
		int	y
	)

Sets POI location on map.

Parameters

x	Determines X coordinate (geographical longitude) of location in world degrees multiplied by 100 000.
y	Determines Y coordinate (geographical latitude) of location in world degrees multiplied by 100 000.

setName()

void setName

(

String

name

)

Sets POI name which is shown in POI list.

Parameters

name	POI name which is shown in POI list.

setSearchAddress()

void setSearchAddress

(

boolean

searchAddr

)

Notes:
Possible values are:

• true Search for address.
• false Do not search for address.

Parameters

searchAddr

Flag determining whether function searches for address when adding POI.

toString()

String toString

(

)

writeBundle()

static Bundle writeBundle ( Poi  poi )

static

References Poi.getAddress(), Poi.getCategory(), Poi.getLocation(), Poi.getName(), Poi.isSearchAddress(), and Position.toArray().

Referenced by ApiPoi.addPoi(), and ApiPoi.deletePoi().