com.ptvag.navigation.sdk

Class POISearchResult

java.lang.Object

com.ptvag.navigation.sdk.POISearchResult

public class POISearchResult
extends java.lang.Object

POI search result * Result of a POI search.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	jniCMemOwn
protected long	jniCPtr
com.ptvag.navigation.sdk.NativeObject	parent

Constructor Summary

Constructors

Constructor and Description
POISearchResult() Constructor
POISearchResult(long cPtr, boolean cMemoryOwn) Only for internal use - don't try to call this from Java.
POISearchResult(long cPtr, com.ptvag.navigation.sdk.NativeObject parent)

Method Summary

Modifier and Type	Method and Description
void	delete() Kills rubbish if owning the object.
boolean	equals(POISearchResult result) Returns true when the given POISearchResult equals this POISearchResult, otherwise false The POISearchResult are equal, if their positions and names are identical.
protected void	finalize()
static long	getCPtr(com.ptvag.navigation.sdk.NativeObject obj)
java.lang.String	getDescription() Returns a description (optional field.
int	getDistance() Returns the distance to original position [m].
int	getDistanceLotPointToPOI() Returns the distance to original position [m].
int	getDistanceStartToLotPoint() Returns the distance to original position [m].
java.lang.String	getIconName() Get the name of the icon associated with this POI
POISearchKind	getKind() Returns the kind of search request.
int	getLayerId() Returns the id of the corresponding layer.
java.lang.String	getName() Returns the visible name of the item, to be displayed in a list.
Position	getPos() Returns the position of address.
Position	getPosLotPoint() Returns the position of the address lot point.
void	setDescription(java.lang.String description) Sets a description.
void	setDistance(int distance) Sets the distance to original position [m].
void	setDistanceLotPointToPOI(int distanceLotPointToPOI) Sets the distance to original position [m].
void	setDistanceStartToLotPoint(int distanceStartToLotPoint) Sets the distance to original position [m].
void	setKind(POISearchKind kind) Sets the kind of search request.
void	setLayerId(int layerId) Sets the id of the corresponding layer.
void	setName(java.lang.String name) Sets the visible name of the item, to be displayed in a list.
void	setPos(Position position) Sets the position of address.
void	setPosLotPoint(Position position) Sets the position of the address lot point.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

jniCPtr

protected long jniCPtr

jniCMemOwn

protected boolean jniCMemOwn

parent

public com.ptvag.navigation.sdk.NativeObject parent

Constructor Detail

POISearchResult

public POISearchResult()

Constructor

POISearchResult

public POISearchResult(long cPtr,
                       boolean cMemoryOwn)

Only for internal use - don't try to call this from Java.

POISearchResult

public POISearchResult(long cPtr,
                       com.ptvag.navigation.sdk.NativeObject parent)

Method Detail

getKind

public POISearchKind getKind()

Returns the kind of search request.

Returns:

the kind of search request.

setKind

public void setKind(POISearchKind kind)

Sets the kind of search request.

Parameters:

kind - - the kind of search request.

getName

public java.lang.String getName()

Returns the visible name of the item, to be displayed in a list.

Returns:

the visible name of the item, to be displayed in a list.

setName

public void setName(java.lang.String name)

Sets the visible name of the item, to be displayed in a list. Nate: The name is limited up to 511 signs.

Parameters:

name - - the visible name of the item, to be displayed in a list.

getDescription

public java.lang.String getDescription()

Returns a description (optional field. As of 2009 usually phone numbers are supplied with standard POI layers as of the map providers).

Returns:

a description.

setDescription

public void setDescription(java.lang.String description)

Sets a description. Note: The description is limited up to 511 signs.

Parameters:

description - - the decription.

getPos

public Position getPos()

Returns the position of address.

Returns:

the position of address.

setPos

public void setPos(Position position)

Sets the position of address.

Parameters:

position - - the position of address.

getPosLotPoint

public Position getPosLotPoint()

Returns the position of the address lot point.

Returns:

the position of the address lot point.

setPosLotPoint

public void setPosLotPoint(Position position)

Sets the position of the address lot point.

Parameters:

position - - the position of the address lot point.

getDistance

public int getDistance()

Returns the distance to original position [m]. This field is set to zero in case of kind=SDK_SA_GLOBAL

Returns:

the distance to original position.

setDistance

public void setDistance(int distance)

Sets the distance to original position [m].

Parameters:

distance - - the distance to original position.

getDistanceStartToLotPoint

public int getDistanceStartToLotPoint()

Returns the distance to original position [m]. This field is set to zero in case of kind=SDK_SA_GLOBAL

Returns:

the distance to original position.

setDistanceStartToLotPoint

public void setDistanceStartToLotPoint(int distanceStartToLotPoint)

Sets the distance to original position [m].

Parameters:

distanceStartToLotPoint - - the distance to original position.

getDistanceLotPointToPOI

public int getDistanceLotPointToPOI()

Returns the distance to original position [m]. This field is set to zero in case of kind=SDK_SA_GLOBAL

Returns:

the distance to original position.

setDistanceLotPointToPOI

public void setDistanceLotPointToPOI(int distanceLotPointToPOI)

Sets the distance to original position [m].

Parameters:

distanceLotPointToPOI - - the distance to original position.

getLayerId

public int getLayerId()

Returns the id of the corresponding layer.

Returns:

the id of the corresponding layer.

setLayerId

public void setLayerId(int layerId)

Sets the id of the corresponding layer.

Parameters:

layerId - - the id of the corresponding layer.

getIconName

public java.lang.String getIconName()

Get the name of the icon associated with this POI

equals

public boolean equals(POISearchResult result)

Returns true when the given POISearchResult equals this POISearchResult, otherwise false The POISearchResult are equal, if their positions and names are identical.

Parameters:

result - - the POISearchresult to compare.

Returns:

true if result equals this POISearchResult, otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCPtr

public static long getCPtr(com.ptvag.navigation.sdk.NativeObject obj)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

delete

public void delete()

Kills rubbish if owning the object.