at.ac.ait.ariadne.routeformat.instruction

Class AreaInstruction

java.lang.Object

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

at.ac.ait.ariadne.routeformat.instruction.AreaInstruction

All Implemented Interfaces:

Validatable

public class AreaInstruction
extends Instruction<AreaInstruction>

Instructions for entering / exiting an area such as a square, a park, or a district.

In its minimal form it consists of a position, defines if it refers to entering or leaving, and one of area type and area name.

Exemplary EBNF of how this instruction can be transformed into human-readable text and what's mandatory / optional. Elements ending with STRING are terminal (not defined any further).

 
 AREA_INSTRUCTION = ENTER | EXIT;
 ENTER = "Cross", AREA, [TOWARDS];
 TOWARDS = towards [EXIT_LANDMARK_STRING] and [EXIT_STREET_NAME_STRING]; 
 EXIT = "Now you leave", AREA;
 AREA = [AREA_TYPE_STRING], [AREA_NAME_STRING]; (* at least one of the two *)
 
 

Author:

AIT Austrian Institute of Technology GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AreaInstruction.SubType

Constructor Summary

Constructors

Constructor and Description
AreaInstruction()

Method Summary

Modifier and Type	Method and Description
static AreaInstruction	createMinimalEnter(GeoJSONCoordinate position) Note, that one of setAreaName(String) or #setAreaType(Area) is mandatory as well
static AreaInstruction	createMinimalExit(GeoJSONCoordinate position) Note, that one of setAreaName(String) or #setAreaType(Area) is mandatory as well
boolean	equals(Object obj)
Optional<String>	getAreaName()
Optional<Constants.Area>	getAreaType()
Optional<Landmark>	getExitLandmark()
Optional<String>	getExitStreetName()
AreaInstruction.SubType	getSubType()
int	hashCode()
AreaInstruction	setAreaName(String areaName)
AreaInstruction	setAreaType(Constants.Area areaType)
AreaInstruction	setExitLandmark(Landmark exitLandmark)
AreaInstruction	setExitStreetName(String exitStreetName)
AreaInstruction	setSubType(AreaInstruction.SubType subType)
String	toString()
void	validate() Checks if the instance is in a valid / useful state.

Methods inherited from class at.ac.ait.ariadne.routeformat.instruction.Instruction

getAdditionalInfo, getConfirmationTriggerPosition, getPosition, getPreviewTriggerPosition, getText, setAdditionalInfo, setConfirmationTriggerPosition, setConfirmationTriggerPosition, setPosition, setPosition, setPreviewTriggerPosition, setPreviewTriggerPosition, setText

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaInstruction

public AreaInstruction()

Method Detail

getSubType

public AreaInstruction.SubType getSubType()

getAreaName

public Optional<String> getAreaName()

getAreaType

public Optional<Constants.Area> getAreaType()

getExitStreetName

public Optional<String> getExitStreetName()

getExitLandmark

public Optional<Landmark> getExitLandmark()

setSubType

public AreaInstruction setSubType(AreaInstruction.SubType subType)

setAreaName

public AreaInstruction setAreaName(String areaName)

setAreaType

public AreaInstruction setAreaType(Constants.Area areaType)

setExitStreetName

public AreaInstruction setExitStreetName(String exitStreetName)

setExitLandmark

public AreaInstruction setExitLandmark(Landmark exitLandmark)

createMinimalEnter

public static AreaInstruction createMinimalEnter(GeoJSONCoordinate position)

Note, that one of setAreaName(String) or #setAreaType(Area) is mandatory as well

createMinimalExit

public static AreaInstruction createMinimalExit(GeoJSONCoordinate position)

Note, that one of setAreaName(String) or #setAreaType(Area) is mandatory as well

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

Overrides:

validate in class Instruction<AreaInstruction>

hashCode

public int hashCode()

Overrides:

hashCode in class Instruction<AreaInstruction>

equals

public boolean equals(Object obj)

Overrides:

equals in class Instruction<AreaInstruction>

toString

public String toString()

Overrides:

toString in class Instruction<AreaInstruction>