at.ac.ait.ariadne.routeformat.instruction

Class Instruction<T extends Instruction<T>>

java.lang.Object

at.ac.ait.ariadne.routeformat.instruction.Instruction<T>

All Implemented Interfaces:

Validatable

Direct Known Subclasses:

AreaInstruction, ModeChangeInstruction, RoadCrossingInstruction, RoadInstruction, RoundaboutInstruction

public abstract class Instruction<T extends Instruction<T>>
extends Object
implements Validatable

Common base class for all types of turn-by-turn navigation instructions.

In its minimal form it consists of a position.

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors

Constructor and Description
Instruction()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,Object>	getAdditionalInfo()
Optional<GeoJSONFeature<GeoJSONPoint>>	getConfirmationTriggerPosition()
GeoJSONFeature<GeoJSONPoint>	getPosition()
Optional<GeoJSONFeature<GeoJSONPoint>>	getPreviewTriggerPosition()
Map<String,String>	getText()
int	hashCode()
T	setAdditionalInfo(Map<String,Object> additionalInfo)
T	setConfirmationTriggerPosition(GeoJSONCoordinate confirmationTriggerPosition)
T	setConfirmationTriggerPosition(GeoJSONFeature<GeoJSONPoint> confirmationTriggerPosition)
T	setPosition(GeoJSONCoordinate position)
T	setPosition(GeoJSONFeature<GeoJSONPoint> position)
T	setPreviewTriggerPosition(GeoJSONCoordinate previewTriggerPosition)
T	setPreviewTriggerPosition(GeoJSONFeature<GeoJSONPoint> previewTriggerPosition)
T	setText(Map<String,String> text)
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

Instruction

public Instruction()

Method Detail

getPosition

public GeoJSONFeature<GeoJSONPoint> getPosition()

Returns:

the position the instruction is defined for

getPreviewTriggerPosition

public Optional<GeoJSONFeature<GeoJSONPoint>> getPreviewTriggerPosition()

Returns:

a position where, during on-trip navigation, a first instruction could be presented to the user

getConfirmationTriggerPosition

public Optional<GeoJSONFeature<GeoJSONPoint>> getConfirmationTriggerPosition()

Returns:

a position after the maneuver, where, during on-trip navigation, a confirmation message could be presented to the user

getText

public Map<String,String> getText()

Returns:

text versions of the instruction, the key of the map is the language (RFC 1766), e.g. 'en' or 'de-AT'.

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

setPosition

public T setPosition(GeoJSONFeature<GeoJSONPoint> position)

setPosition

public T setPosition(GeoJSONCoordinate position)

setPreviewTriggerPosition

public T setPreviewTriggerPosition(GeoJSONFeature<GeoJSONPoint> previewTriggerPosition)

setPreviewTriggerPosition

public T setPreviewTriggerPosition(GeoJSONCoordinate previewTriggerPosition)

setConfirmationTriggerPosition

public T setConfirmationTriggerPosition(GeoJSONFeature<GeoJSONPoint> confirmationTriggerPosition)

setConfirmationTriggerPosition

public T setConfirmationTriggerPosition(GeoJSONCoordinate confirmationTriggerPosition)

setText

public T setText(Map<String,String> text)

setAdditionalInfo

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

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