io.github.privacystreams.location

Class Geolocation

java.lang.Object

io.github.privacystreams.core.Item

io.github.privacystreams.location.Geolocation

@PSItem
public class Geolocation
extends Item

An Geolocation item represents a geolocation value.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCURACY The accuracy of the location data, in meters.
static java.lang.String	BEARING The bearing of the location data.
static java.lang.String	LAT_LON The coordinates of the location.
static java.lang.String	LEVEL_BUILDING Building level.
static java.lang.String	LEVEL_CITY City level.
static java.lang.String	LEVEL_COUNTRY Country level.
static java.lang.String	LEVEL_EXACT Exact level.
static java.lang.String	LEVEL_NEIGHBORHOOD Neighborhood level.
static java.lang.String	PROVIDER The provider of the location data, e.g., "gps" or "network".
static java.lang.String	SPEED The speed at the location, in meters/second.
static java.lang.String	TIMESTAMP The timestamp of the location.

Fields inherited from class io.github.privacystreams.core.Item

EOS, TIME_CREATED

Method Summary

Modifier and Type	Method and Description
static PStreamProvider	asCurrent(java.lang.String level) Provide an PStream of a Geolocation item, as the current location.
static PStreamProvider	asLastKnown(java.lang.String level) Provide an PStream of a Geolocation item, as the last known location.
static PStreamProvider	asUpdates(long interval, java.lang.String level) Provide a live stream of Geolocation as the location updates.

Methods inherited from class io.github.privacystreams.core.Item

containsField, equals, excludeFields, getAsBoolean, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValueByField, includeFields, isEndOfStream, setFieldValue, toDebugString, toJson, toMap, toString

Methods inherited from class java.lang.Object

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

Field Detail

TIMESTAMP

@PSItemField(type=java.lang.Long.class)
public static final java.lang.String TIMESTAMP

The timestamp of the location.

See Also:

Constant Field Values

LAT_LON

@PSItemField(type=LatLon.class)
public static final java.lang.String LAT_LON

The coordinates of the location. The value is a LatLon instance.

See Also:

Constant Field Values

SPEED

@PSItemField(type=java.lang.Float.class)
public static final java.lang.String SPEED

The speed at the location, in meters/second.

See Also:

Constant Field Values

PROVIDER

@PSItemField(type=java.lang.String.class)
public static final java.lang.String PROVIDER

The provider of the location data, e.g., "gps" or "network".

See Also:

Constant Field Values

ACCURACY

@PSItemField(type=java.lang.Float.class)
public static final java.lang.String ACCURACY

The accuracy of the location data, in meters.

See Also:

Constant Field Values

BEARING

@PSItemField(type=java.lang.Float.class)
public static final java.lang.String BEARING

The bearing of the location data. Bearing is the horizontal direction of travel of this device, and is not related to the device orientation. It is guaranteed to be in the range (0.0, 360.0] if the device has a bearing. If this location does not have a bearing, then the bearing value will be0.0.

See Also:

Constant Field Values

LEVEL_COUNTRY

public static final java.lang.String LEVEL_COUNTRY

Country level. This level's accuracy is about 100,000 meters.

See Also:

Constant Field Values

LEVEL_CITY

public static final java.lang.String LEVEL_CITY

City level. This level's accuracy is about 10,000 meters.

See Also:

Constant Field Values

LEVEL_NEIGHBORHOOD

public static final java.lang.String LEVEL_NEIGHBORHOOD

Neighborhood level. This level's accuracy is about 1,000 meters.

See Also:

Constant Field Values

LEVEL_BUILDING

public static final java.lang.String LEVEL_BUILDING

Building level. This level's accuracy is about 100 meters.

See Also:

Constant Field Values

LEVEL_EXACT

public static final java.lang.String LEVEL_EXACT

Exact level. This level's accuracy is about 10 meters.

See Also:

Constant Field Values

Method Detail

asUpdates

public static PStreamProvider asUpdates(long interval,
                                        java.lang.String level)

Provide a live stream of Geolocation as the location updates. This provider requires a location permission based on the location level. If `level` is `Geolocation.LEVEL_EXACT`, this provider requires `android.permission.ACCESS_COARSE_LOCATION` permission. If `level` is any other level, this provider requires `android.permission.ACCESS_FINE_LOCATION` permission.

Parameters:

interval - The interval between each two location updates.

level - The location granularity level, could be `Geolocation.LEVEL_COUNTRY`, `Geolocation.LEVEL_CITY`, `Geolocation.LEVEL_NEIGHBORHOOD`, `Geolocation.LEVEL_BUILDING`, or `Geolocation.LEVEL_EXACT`.

Returns:

the provider

asLastKnown

public static PStreamProvider asLastKnown(java.lang.String level)

Provide an PStream of a Geolocation item, as the last known location. If `level` is `Geolocation.LEVEL_EXACT`, this provider requires `android.permission.ACCESS_COARSE_LOCATION` permission. If `level` is any other level, this provider requires `android.permission.ACCESS_FINE_LOCATION` permission.

Parameters:

level - The location granularity level, could be `Geolocation.LEVEL_COUNTRY`, `Geolocation.LEVEL_CITY`, `Geolocation.LEVEL_NEIGHBORHOOD`, `Geolocation.LEVEL_BUILDING`, or `Geolocation.LEVEL_EXACT`.

Returns:

the provider

asCurrent

public static PStreamProvider asCurrent(java.lang.String level)

Provide an PStream of a Geolocation item, as the current location. If `level` is `Geolocation.LEVEL_EXACT`, this provider requires `android.permission.ACCESS_COARSE_LOCATION` permission. If `level` is any other level, this provider requires `android.permission.ACCESS_FINE_LOCATION` permission.

Parameters:

level - The location granularity level, could be `Geolocation.LEVEL_COUNTRY`, `Geolocation.LEVEL_CITY`, `Geolocation.LEVEL_NEIGHBORHOOD`, `Geolocation.LEVEL_BUILDING`, or `Geolocation.LEVEL_EXACT`.

Returns:

the provider