at.ac.ait.ariadne.routeformat.instruction

Class ModeChangeInstruction

java.lang.Object

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

at.ac.ait.ariadne.routeformat.instruction.ModeChangeInstruction

All Implemented Interfaces:

Validatable

public class ModeChangeInstruction
extends Instruction<ModeChangeInstruction>

A ModeChangeInstruction contains details about alighting and / boarding modes of transport. This includes changes from/to walking and changes within public transport, i.e. changing / the line.

Simple examples are:

• Park your bicycle and board bus 76A.
• At the restaurant park your bicycle and go to the Car2Go with the license plate W-23456.

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).

 
 MODE_CHANGE_INSTRUCTION = [LANDMARK_PART], [EXIT_PART], [ENTER_PART];
 
 LANDMARK_PART = PREPOSITION, "the", LANDMARK_STRING;
 PREPOSITION = "before" | "at" | "after";

 EXIT_PART = EXIT_INDIVIDUAL | EXIT_PUBLIC;
 EXIT_INDIVIDUAL = "Park your", VEHICLE_STRING;
 EXIT_PUBLIC = "Leave", PUBLIC_TRANSPORT_STRING;
 
 ENTER_PART = ENTER_INDIVIDUAL | ENTER_PUBLIC;
 ENTER_INDIVIDUAL = "Take your", VEHICLE_STRING;
 ENTER_INDIVIDUAL = "Enter", VEHICLE_STRING;
 
 

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors

Constructor and Description
ModeChangeInstruction()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Optional<Landmark>	getLandmark()
Optional<ModeOfTransport>	getNextModeOfTransport()
Optional<ModeOfTransport>	getPreviousModeOfTransport()
int	hashCode()
ModeChangeInstruction	setLandmark(Landmark landmark)
ModeChangeInstruction	setNextModeOfTransport(ModeOfTransport nextModeOfTransport)
ModeChangeInstruction	setPreviousModeOfTransport(ModeOfTransport previousModeOfTransport)
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

ModeChangeInstruction

public ModeChangeInstruction()

Method Detail

getPreviousModeOfTransport

public Optional<ModeOfTransport> getPreviousModeOfTransport()

getNextModeOfTransport

public Optional<ModeOfTransport> getNextModeOfTransport()

getLandmark

public Optional<Landmark> getLandmark()

setPreviousModeOfTransport

public ModeChangeInstruction setPreviousModeOfTransport(ModeOfTransport previousModeOfTransport)

setNextModeOfTransport

public ModeChangeInstruction setNextModeOfTransport(ModeOfTransport nextModeOfTransport)

setLandmark

public ModeChangeInstruction setLandmark(Landmark landmark)

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<ModeChangeInstruction>

hashCode

public int hashCode()

Overrides:

hashCode in class Instruction<ModeChangeInstruction>

equals

public boolean equals(Object obj)

Overrides:

equals in class Instruction<ModeChangeInstruction>

toString

public String toString()

Overrides:

toString in class Instruction<ModeChangeInstruction>