Package org.goplanit.utils.id

Interface ExternalIdAble

All Superinterfaces:

Cloneable, Comparable<IdAble>, IdAble

All Known Subinterfaces:

Centroid, Connectoid, ConnectoidEdge, ConnectoidSegment, DirectedConnectoid, DirectedEdge, DirectedPath, DirectedVertex, Edge, EdgeSegment, GraphEntity, Link, LinkSegment, MacroscopicLinkSegment, MacroscopicLinkSegmentType, MacroscopicNetworkLayer, Mode, Node, OdZone, PhysicalLayer, PredefinedMode, RoutedService, RoutedServicesLayer, RoutedTrip, RoutedTripFrequency, RoutedTripSchedule, ServiceLeg, ServiceLegSegment, ServiceNetworkLayer, ServiceNode, TimePeriod, TopologicalLayer, TransferZone, TransferZoneGroup, TransportLayer, UndirectedConnectoid, UntypedDirectedGraphLayer<V,E,S>, UntypedPhysicalLayer<N,L,LS>, Vertex, Zone

All Known Implementing Classes:

AbstractPhysicalCost, AbstractVirtualCost, AlgorithmB, BicycleMode, BPRLinkTravelTimeCost, BusMode, CarHighOccupancyMode, CarMode, CarShareMode, CentroidImpl, ConnectoidEdgeImpl, ConnectoidImpl, ConnectoidSegmentImpl, Demands, DirectedConnectoidImpl, DirectedEdgeImpl, DirectedPathImpl, DirectedVertexImpl, EdgeImpl, EdgeSegmentImpl, EventBasedLtm, ExternalIdAbleImpl, FixedConnectoidTravelTimeCost, FreeFlowLinkTravelTimeCost, FundamentalDiagramComponent, GapFunction, GoodsMode, GraphEntityImpl, HeavyGoodsMode, InitialLinkSegmentCost, InitialPhysicalCost, LargeHeavyGoodsMode, LightRailMode, LinkBasedRelativeDualityGapFunction, LinkImpl, LinkSegmentImpl, LogitChoiceModel, LtmAssignment, MacroscopicLinkSegmentImpl, MacroscopicLinkSegmentTypeImpl, MacroscopicNetwork, MacroscopicNetworkLayerImpl, ManualInitialLinkSegmentCost, ModeImpl, MotorBikeMode, MSASmoothing, MultinomialLogit, Network, NetworkLoading, NewellFundamentalDiagramComponent, NodeImpl, NodeModelComponent, NormBasedGapFunction, OdPathSets, OdZoneImpl, PathChoice, PedestrianMode, PlanitComponent, PlanitOsmNetwork, PredefinedModeImpl, RoutedServiceImpl, RoutedServices, RoutedServicesLayerImpl, RoutedTripDeparture, RoutedTripFrequencyImpl, RoutedTripImpl, RoutedTripScheduleImpl, ServiceLegImpl, ServiceLegSegmentImpl, ServiceNetwork, ServiceNetworkLayerImpl, ServiceNodeImpl, Smoothing, SpeedConnectoidTravelTimeCost, StaticLtm, StaticTrafficAssignment, SteadyStateTravelTimeCost, StochasticPathChoice, SubwayMode, TampereNodeModelComponent, TimePeriodImpl, TopologicalLayerImpl, TopologicalLayerNetwork, TraditionalStaticAssignment, TrafficAssignment, TrainMode, TramMode, TransferZoneGroupImpl, TransferZoneImpl, TransportLayerImpl, TransportLayerNetwork, TravelerType, UndirectedConnectoidImpl, UntypedNetworkLayerImpl, UntypedPhysicalLayerImpl, UntypedPhysicalNetwork, UserClass, VertexImpl, VirtualNetwork, ZoneImpl, Zoning

public interface ExternalIdAble
extends IdAble

A class implementing this interface signals that it is external id-able. Anything that has an external id by definition should also be Idable as well. Unlike an id, the external id is by definition modifiable. further, something that can have an external id also has an xmlId reflecting a unique id used for persistence. This differs from the regular id in that it is less stringent, it is modifiable, and only needs to be unique. It is not necessarily a number and it does not need to be consecutively numbers from zero.

Author:

markr

Method Summary

Modifier and Type	Method	Description
String	getExternalId()	get external id of the entity
String	getXmlId()	the id exposed to users as the "normal" id in the PLANit native xml format
default boolean	hasExternalId()	check if external id is available or not
default boolean	hasXmlId()	check if external id is available or not
void	setExternalId(String externalId)	set the external id
void	setXmlId(String xmlId)	set the external id

Methods inherited from interface org.goplanit.utils.id.IdAble

clone, compareTo, getId, idEquals, idHashCode

Method Detail

getExternalId

String getExternalId()

get external id of the entity

Returns:

external id

setExternalId

void setExternalId(String externalId)

set the external id

Parameters:

externalId - to set

getXmlId

String getXmlId()

the id exposed to users as the "normal" id in the PLANit native xml format

Returns:

xmlId

setXmlId

void setXmlId(String xmlId)

set the external id

Parameters:

xmlId - to set

hasXmlId

default boolean hasXmlId()

check if external id is available or not

Returns:

true when not null, false otherwise

hasExternalId

default boolean hasExternalId()

check if external id is available or not

Returns:

true when nont null, false otherwise