com.ptvag.navigation.sdk

Class SearchRequest

java.lang.Object

com.ptvag.navigation.sdk.SearchRequest

public class SearchRequest
extends java.lang.Object

Search request for most geocoding APIS (including SDKSearchTown(), SDKSearchPostcode(), SDKSearchStreet(), SDKSearchHouseNr())

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
SearchRequest() Constructor
SearchRequest(long cPtr, boolean cMemoryOwn) Only for internal use - don't try to call this from Java.
SearchRequest(java.lang.String searchString, Position pos, SearchKind kind)
SearchRequest(java.lang.String searchString, Position pos, short cc, SearchKind kind) Constructor
SearchRequest(java.lang.String searchString, SearchKind kind)
SearchRequest(java.lang.String searchString, short cc, SearchKind kind)

Method Summary

Modifier and Type	Method and Description
void	delete() Kills rubbish if owning the object.
protected void	finalize()
short	getCC() Returns the numerical country code.
static long	getCPtr(com.ptvag.navigation.sdk.NativeObject obj)
Position	getPosition() Returns the position for nearest or circle search.
SearchKind	getSearchKind() Return the kind of search request (see @link SearchKind).
java.lang.String	getSearchString() Returns the string representation of item to search for.
void	setCC(short cc) Sets the countrycode
void	setPosition(Position position) Sets the position.
void	setSearchKind(SearchKind kind) Sets the type of search.
void	setSearchString(java.lang.String searchString) Sets the search string
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

SearchRequest

public SearchRequest(java.lang.String searchString,
                     Position pos,
                     short cc,
                     SearchKind kind)

Constructor

Parameters:

searchString - - String representation of item to search for

pos - - Position for nearest or circle search

cc - - Numerical country code. Available for SDK_SearchTown* & SDK_SearchPostCode*. Set to 0 to be ignored.

kind - - Kind of search request

SearchRequest

public SearchRequest(java.lang.String searchString,
                     short cc,
                     SearchKind kind)

SearchRequest

public SearchRequest(java.lang.String searchString,
                     Position pos,
                     SearchKind kind)

SearchRequest

public SearchRequest(java.lang.String searchString,
                     SearchKind kind)

SearchRequest

public SearchRequest()

Constructor

SearchRequest

public SearchRequest(long cPtr,
                     boolean cMemoryOwn)

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

Method Detail

getSearchKind

public SearchKind getSearchKind()

Return the kind of search request (see @link SearchKind). If the search request is unknown ERROR will be returned.

Returns:

the kind of search request.

getSearchString

public java.lang.String getSearchString()

Returns the string representation of item to search for.

Returns:

the string representation of item to search for.

getCC

public short getCC()

Returns the numerical country code. Available for SDKSearchTown* & SDKSearchPostCode*. Set to 0 to be ignored.

Returns:

the numerical country code

getPosition

public Position getPosition()

Returns the position for nearest or circle search.

Returns:

Position for nearest or circle search

setSearchString

public void setSearchString(java.lang.String searchString)

Sets the search string

Parameters:

searchString - - the search string

setPosition

public void setPosition(Position position)

Sets the position.

Parameters:

position - - the position.

setCC

public void setCC(short cc)

Sets the countrycode

Parameters:

cc - - the countrycode

setSearchKind

public void setSearchKind(SearchKind kind)

Sets the type of search.

Parameters:

kind - - the type of search

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.