de.k3b.geo.api

Interface IGeoPointInfo

All Superinterfaces:

java.lang.Cloneable, ILocation

All Known Implementing Classes:

GeoPointDto

public interface IGeoPointInfo
extends ILocation, java.lang.Cloneable

A location or trackpoint that can be displayed in a locationmap.

Created by k3b on 13.01.2015.

Field Summary

Fields

Modifier and Type	Field and Description
static double	NO_LAT_LON
static int	NO_ZOOM

Method Summary

Modifier and Type	Method and Description
IGeoPointInfo	clone()
java.lang.String	getDescription() Optional: Detailed description of the point displayed in popup on long-click.
java.lang.String	getId() Optional: if not null: a unique id for this item.
double	getLatitude() Mandatory: Latitude, in degrees north.
java.lang.String	getLink() Optional: if not null: link-url belonging to this item.
double	getLongitude() Mandatory: Longitude, in degrees east.
java.lang.String	getName() Optional: Short non-unique text used as marker label.
java.lang.String	getSymbol() Optional: if not null: icon-url belonging to this item.
java.util.Date	getTimeOfMeasurement() Optional: Date when the measurement was taken.
int	getZoomMax() Optional in geo data as filter criteria: this item is only shown if current zoom-level is <= this value.
int	getZoomMin() Optional: In show view: navigate map to this zoom level.

Field Detail

NO_LAT_LON

static final double NO_LAT_LON

See Also:

Constant Field Values

NO_ZOOM

static final int NO_ZOOM

See Also:

Constant Field Values

Method Detail

getLatitude

double getLatitude()

Mandatory: Latitude, in degrees north.
In show view: navigate map to this location.
In geo data: map display data.
NO_LAT_LON if not set.
persistet as geo:lat,lon or geo:0,0?q=lat,lon.

Specified by:

getLatitude in interface ILocation

getLongitude

double getLongitude()

Mandatory: Longitude, in degrees east.
In show view: navigate map to this location.
In geo data: map display data.
NO_LAT_LON if not set.
persistet as geo:lat,lon or geo:0,0?q=lat,lon.

Specified by:

getLongitude in interface ILocation

getZoomMin

int getZoomMin()

Optional: In show view: navigate map to this zoom level.
In geo data: filter - this item is only shown if current zoom-level is >= this value.
NO_LAT_LON if not set.
NO_ZOOM means no lower bound.
persistet in geo-uri as geo:…&z=4

getZoomMax

int getZoomMax()

Optional in geo data as filter criteria: this item is only shown if current zoom-level is <= this value. NO_ZOOM means no upper bound.
persistet in geo-uri as geo:…&z2=6

getTimeOfMeasurement

java.util.Date getTimeOfMeasurement()

Optional: Date when the measurement was taken. Null if unknown.
This may be shown in a map as an alternative label
or used as a filter to include only geopoints of a certain date range.
persistet in geo-uri as geo:…&t=2015-03-24T15:39:52z

Specified by:

getTimeOfMeasurement in interface ILocation

getName

java.lang.String getName()

Optional: Short non-unique text used as marker label.
Null if not set.
In show view after clicking on a marker: Caption/Title in the bubble.
persistet in geo-uri as geo:?q=…(name)

getDescription

java.lang.String getDescription()

Optional: Detailed description of the point displayed in popup on long-click.
Null if not set.
In show view after clicking on a marker: Text in the bubble.
persistet in geo-uri as geo:…&d=someDescription

getId

java.lang.String getId()

Optional: if not null: a unique id for this item.
persistet in geo-uri as geo:…&id=4711

getLink

java.lang.String getLink()

Optional: if not null: link-url belonging to this item.
In show view after clicking on a marker: clock on button “>” opens this url.
persistet in geo-uri as geo:…&link=https://path/to/file.html

getSymbol

java.lang.String getSymbol()

Optional: if not null: icon-url belonging to this item.
persistet in geo-uri as geo:…&s=https://path/to/file.png

clone

IGeoPointInfo clone()