at.ac.ait.ariadne.routeformat

Class ModeOfTransport

java.lang.Object

at.ac.ait.ariadne.routeformat.ModeOfTransport

All Implemented Interfaces:

Validatable

public class ModeOfTransport
extends Object
implements Validatable

Contains information about the mode of transport up to the detail level of information about the operator (e.g. of a taxi), the details about a public transport line or the type of vehicle (e.g. electric or not).

In its minimal form it consists of a Constants.GeneralizedModeOfTransportType.

Some standard modes of transport where additional information is seldom required are provided, e.g. STANDARD_FOOT

equals(Object) returns true for instances with the same content.

Author:

AIT Austrian Institute of Technology GmbH

Field Summary

Fields

Modifier and Type	Field and Description
static ModeOfTransport	STANDARD_BICYCLE
static ModeOfTransport	STANDARD_CAR
static ModeOfTransport	STANDARD_FOOT
static ModeOfTransport	STANDARD_MOTORCYCLE
static ModeOfTransport	STANDARD_PUBLIC_TRANSPORT
static ModeOfTransport	STANDARD_TRANSFER

Constructor Summary

Constructors

Constructor and Description
ModeOfTransport()

Method Summary

Modifier and Type	Method and Description
static ModeOfTransport	createMinimal(Constants.DetailedModeOfTransportType detailedType)
static ModeOfTransport	createMinimal(Constants.GeneralizedModeOfTransportType generalizedType)
boolean	equals(Object obj)
Set<Constants.VehicleAccessibility>	getAccessibility()
Map<String,Object>	getAdditionalInfo()
Optional<String>	getColor()
Optional<Constants.DetailedModeOfTransportType>	getDetailedType()
Optional<Boolean>	getElectric()
Constants.GeneralizedModeOfTransportType	getGeneralizedType()
Optional<Integer>	getHeightMm()
Optional<String>	getId() E.g.
Optional<Integer>	getLengthMm()
Optional<Operator>	getOperator()
Optional<Service>	getService()
Optional<Constants.Sharing>	getSharingType()
Optional<Integer>	getWeightKg()
Optional<Integer>	getWidthMm()
int	hashCode()
ModeOfTransport	setAccessibility(Set<Constants.VehicleAccessibility> accessibility)
ModeOfTransport	setAdditionalInfo(Map<String,Object> additionalInfo)
ModeOfTransport	setColor(String color)
ModeOfTransport	setDetailedType(Constants.DetailedModeOfTransportType detailedType) Set detailed and generalized type in one step
ModeOfTransport	setElectric(boolean electric)
ModeOfTransport	setGeneralizedType(Constants.GeneralizedModeOfTransportType generalizedType)
ModeOfTransport	setHeightMm(Integer heightMm)
ModeOfTransport	setId(String id)
ModeOfTransport	setLengthMm(Integer lengthMm)
ModeOfTransport	setOperator(Operator operator)
ModeOfTransport	setService(Service service)
ModeOfTransport	setSharingType(Constants.Sharing sharingType)
ModeOfTransport	setWeightKg(Integer weightKg)
ModeOfTransport	setWidthMm(Integer widthMm)
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

Field Detail

STANDARD_FOOT

public static final ModeOfTransport STANDARD_FOOT

STANDARD_BICYCLE

public static final ModeOfTransport STANDARD_BICYCLE

STANDARD_MOTORCYCLE

public static final ModeOfTransport STANDARD_MOTORCYCLE

STANDARD_CAR

public static final ModeOfTransport STANDARD_CAR

STANDARD_TRANSFER

public static final ModeOfTransport STANDARD_TRANSFER

STANDARD_PUBLIC_TRANSPORT

public static final ModeOfTransport STANDARD_PUBLIC_TRANSPORT

Constructor Detail

ModeOfTransport

public ModeOfTransport()

Method Detail

getGeneralizedType

public Constants.GeneralizedModeOfTransportType getGeneralizedType()

getDetailedType

public Optional<Constants.DetailedModeOfTransportType> getDetailedType()

getId

public Optional<String> getId()

E.g. number plate for cars, bicycle nr for bike-sharing,..

getService

public Optional<Service> getService()

Returns:

a service (in case this vehicle is part of public transport)

getOperator

public Optional<Operator> getOperator()

getElectric

public Optional<Boolean> getElectric()

getWeightKg

public Optional<Integer> getWeightKg()

getWidthMm

public Optional<Integer> getWidthMm()

getHeightMm

public Optional<Integer> getHeightMm()

getLengthMm

public Optional<Integer> getLengthMm()

getSharingType

public Optional<Constants.Sharing> getSharingType()

Returns:

the sharing type. If empty the mode of transport is not shared.

getAccessibility

public Set<Constants.VehicleAccessibility> getAccessibility()

getColor

public Optional<String> getColor()

Returns:

the color of the mode of transport for visualization purposes (e.g. red for U1 in Vienna) in hash-prepended six-digit hexadacimal notation (e.g. #FF0000)

getAdditionalInfo

public Map<String,Object> getAdditionalInfo()

setGeneralizedType

public ModeOfTransport setGeneralizedType(Constants.GeneralizedModeOfTransportType generalizedType)

setDetailedType

public ModeOfTransport setDetailedType(Constants.DetailedModeOfTransportType detailedType)

Set detailed and generalized type in one step

setId

public ModeOfTransport setId(String id)

setService

public ModeOfTransport setService(Service service)

setOperator

public ModeOfTransport setOperator(Operator operator)

setElectric

public ModeOfTransport setElectric(boolean electric)

setWeightKg

public ModeOfTransport setWeightKg(Integer weightKg)

setWidthMm

public ModeOfTransport setWidthMm(Integer widthMm)

setHeightMm

public ModeOfTransport setHeightMm(Integer heightMm)

setLengthMm

public ModeOfTransport setLengthMm(Integer lengthMm)

setSharingType

public ModeOfTransport setSharingType(Constants.Sharing sharingType)

setAccessibility

public ModeOfTransport setAccessibility(Set<Constants.VehicleAccessibility> accessibility)

setColor

public ModeOfTransport setColor(String color)

setAdditionalInfo

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

createMinimal

public static ModeOfTransport createMinimal(Constants.GeneralizedModeOfTransportType generalizedType)

createMinimal

public static ModeOfTransport createMinimal(Constants.DetailedModeOfTransportType detailedType)

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

Returns:

true only if every aspect of the two ModeOfTransport is the same, also e.g. the color or properties getAdditionalInfo()

toString

public String toString()

Overrides:

toString in class Object