at.ac.ait.ariadne.routeformat.features

Class Site

java.lang.Object

at.ac.ait.ariadne.routeformat.features.Site

All Implemented Interfaces:

Validatable

public class Site
extends Object
implements Validatable

Details for a site, i.e. a region, that is supported by the routing service.

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors

Constructor and Description
Site()

Method Summary

Modifier and Type	Method and Description
static Site	createMinimal(String id)
static Site	createShallowCopy(Site s)
boolean	equals(Object obj)
Map<String,Object>	getAdditionalInfo()
Optional<GeoJSONFeature<GeoJSONPolygon>>	getBoundingPolygon()
List<Constants.SiteFeature>	getFeatures()
Optional<GeoJSONFeature<GeoJSONPoint>>	getFocusPoint()
String	getId()
List<ModeOfTransport>	getModesOfTransport()
Optional<String>	getName()
List<OptimizedFor>	getOptimizedFor()
Optional<Integer>	getZoomLevel()
int	hashCode()
Site	setAdditionalInfo(Map<String,Object> additionalInfo)
Site	setBoundingPolygon(GeoJSONFeature<GeoJSONPolygon> boundingPolygon)
Site	setFeatures(List<Constants.SiteFeature> features)
Site	setFocusPoint(GeoJSONFeature<GeoJSONPoint> focusPoint)
Site	setId(String id)
Site	setModesOfTransport(List<ModeOfTransport> modesOfTransport)
Site	setName(String name)
Site	setOptimizedFor(List<OptimizedFor> optimizedFor)
Site	setZoomLevel(Integer zoomLevel)
String	toString()
void	validate() Checks if the instance is in a valid / useful state.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Site

public Site()

Method Detail

getId

public String getId()

Returns:

a unique ID

getName

public Optional<String> getName()

Returns:

a human readable name

getOptimizedFor

public List<OptimizedFor> getOptimizedFor()

Returns:

a list of the the supported criteria for RoutingRequest.getOptimizedFor()

getModesOfTransport

public List<ModeOfTransport> getModesOfTransport()

Returns:

all modes of transport that are supported for this site for use in RoutingRequest.getModesOfTransport()

getFocusPoint

public Optional<GeoJSONFeature<GeoJSONPoint>> getFocusPoint()

Returns:

the point a map of the site should be focused / centered on

getZoomLevel

public Optional<Integer> getZoomLevel()

Returns:

the zoom level to be used when displaying an overview map of the Site, see http://wiki.openstreetmap.org/wiki/Zoom_levels

getBoundingPolygon

public Optional<GeoJSONFeature<GeoJSONPolygon>> getBoundingPolygon()

Returns:

a polygon defining the bounds of the site e.g. for displaying it on a map

getFeatures

public List<Constants.SiteFeature> getFeatures()

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

setId

public Site setId(String id)

setName

public Site setName(String name)

setOptimizedFor

public Site setOptimizedFor(List<OptimizedFor> optimizedFor)

setModesOfTransport

public Site setModesOfTransport(List<ModeOfTransport> modesOfTransport)

setFocusPoint

public Site setFocusPoint(GeoJSONFeature<GeoJSONPoint> focusPoint)

setZoomLevel

public Site setZoomLevel(Integer zoomLevel)

setBoundingPolygon

public Site setBoundingPolygon(GeoJSONFeature<GeoJSONPolygon> boundingPolygon)

setFeatures

public Site setFeatures(List<Constants.SiteFeature> features)

setAdditionalInfo

public Site setAdditionalInfo(Map<String,Object> additionalInfo)

createMinimal

public static Site createMinimal(String id)

createShallowCopy

public static Site createShallowCopy(Site s)

validate

public void validate()

Description copied from interface: Validatable

Checks if the instance is in a valid / useful state. If this is not the case an IllegalArgumentException including a description of the invalid state is thrown.

Specified by:

validate in interface Validatable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object