com.nutiteq.location.providers
Class LocationAPIProvider

java.lang.Object
  com.nutiteq.location.providers.LocationAPIProvider

All Implemented Interfaces:

LocationSource, java.lang.Runnable

public class LocationAPIProvider
extends java.lang.Object
implements java.lang.Runnable, LocationSource

This is a wrapper class around JSR179

Field Summary

Fields inherited from interface com.nutiteq.location.LocationSource

STATUS_CANT_LOCATE, STATUS_CONNECTED, STATUS_CONNECTING, STATUS_CONNECTION_LOST

Constructor Summary

LocationAPIProvider(long updateInterval)
Create location provider with given update interval (in milliseconds) and without any accuracy requirements.

LocationAPIProvider(long updateInterval, int accuracy)
Create location provider with given update interval (in milliseconds) and with accuracy requirement.

LocationAPIProvider(long updateInterval, int accuracy, int timeout, int maxAge)
Create location provider with given update interval (in milliseconds) and with accuracy requirement.

Method Summary

void	addLocationListener(LocationListener listener) Add listener for location coordinates
WgsPoint	getLocation()
LocationMarker	getLocationMarker() Get location marker used on screen
java.lang.String	getMethod() Method of positioning, depending on implementation e.g.
java.lang.Object	getNativeLocation() Provides native location object with last info, e.g.
int	getStatus() Get status code for location source.
void	locationUpdated(LocationProvider provider, Location location)
void	providerStateChanged(LocationProvider provider, int newState)
void	quit() Quit location polling
void	run()
void	setLocationMarker(LocationMarker marker) Set location marker where to push location updates
void	start() Start location polling

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocationAPIProvider

public LocationAPIProvider(long updateInterval)

Create location provider with given update interval (in milliseconds) and without any accuracy requirements.

Parameters:

updateInterval - location update time in milliseconds

LocationAPIProvider

public LocationAPIProvider(long updateInterval,
                           int accuracy)

Create location provider with given update interval (in milliseconds) and with accuracy requirement.

On Nokia phones this could trigger assisted positioning for faster location finding.

Parameters:

updateInterval - location update time in milliseconds

accuracy - accuracy for positioning (suggested value would be starting from 500)

LocationAPIProvider

public LocationAPIProvider(long updateInterval,
                           int accuracy,
                           int timeout,
                           int maxAge)

Create location provider with given update interval (in milliseconds) and with accuracy requirement.

Parameters:

updateInterval - location update time in milliseconds

accuracy - accuracy for positioning (suggested value would be starting from 500)

timeout - location retrieving timeout in seconds

maxAge - maximum location age in seconds

Method Detail

start

public void start()

Description copied from interface: LocationSource

Start location polling

Specified by:

start in interface LocationSource

run

public void run()

Specified by:

run in interface java.lang.Runnable

getLocation

public WgsPoint getLocation()

Specified by:

getLocation in interface LocationSource

getStatus

public int getStatus()

Description copied from interface: LocationSource

Get status code for location source.

Specified by:

getStatus in interface LocationSource

Returns:

status code

getLocationMarker

public LocationMarker getLocationMarker()

Description copied from interface: LocationSource

Get location marker used on screen

Specified by:

getLocationMarker in interface LocationSource

Returns:

associated location marker

quit

public void quit()

Description copied from interface: LocationSource

Quit location polling

Specified by:

quit in interface LocationSource

setLocationMarker

public void setLocationMarker(LocationMarker marker)

Description copied from interface: LocationSource

Set location marker where to push location updates

Specified by:

setLocationMarker in interface LocationSource

Parameters:

marker - marker displayed on screen

addLocationListener

public void addLocationListener(LocationListener listener)

Description copied from interface: LocationSource

Add listener for location coordinates

Specified by:

addLocationListener in interface LocationSource

Parameters:

listener - listener to be added

locationUpdated

public void locationUpdated(LocationProvider provider,
                            Location location)

providerStateChanged

public void providerStateChanged(LocationProvider provider,
                                 int newState)

getMethod

public java.lang.String getMethod()

Description copied from interface: LocationSource

Method of positioning, depending on implementation e.g. "GPS", "AGPS" etc Useful for debugging

Specified by:

getMethod in interface LocationSource

Returns:

used location method as string

getNativeLocation

public java.lang.Object getNativeLocation()

Description copied from interface: LocationSource

Provides native location object with last info, e.g. Location in JSR-172

Specified by:

getNativeLocation in interface LocationSource

Returns:

implementation-specific Object holding last location