Package org.goplanit.utils.id

Interface ManagedId

All Superinterfaces:

Comparable<IdAble>, IdAble

All Known Subinterfaces:

Centroid, CentroidVertex, ConjugateConnectoidEdge, ConjugateConnectoidNode, ConjugateConnectoidSegment, ConjugateDirectedEdge, ConjugateDirectedVertex, ConjugateEdge, ConjugateEdgeSegment, ConjugateLink, ConjugateLinkSegment, ConjugateMacroscopicNetworkLayer, ConjugateNode, ConjugateVertex, Connectoid, ConnectoidEdge, ConnectoidSegment, DirectedConnectoid, DirectedEdge, DirectedGraph<V,E,ES>, DirectedVertex, Edge, EdgeSegment, Graph<V,E>, GraphEntity, Link, LinkSegment, MacroscopicLink, MacroscopicLinkSegment, MacroscopicLinkSegmentType, MacroscopicNetworkLayer, ManagedDirectedPath, Mode, NetworkLayer, Node, OdZone, PhysicalLayer, PredefinedMode, RoutedService, RoutedServicesLayer, RoutedTrip, RoutedTripDeparture, RoutedTripFrequency, RoutedTripSchedule, ServiceLeg, ServiceLegSegment, ServiceNetworkLayer, ServiceNode, TimePeriod, TopologicalLayer, TransferZone, TransferZoneGroup, UndirectedConnectoid, UntypedDirectedGraph<V,E,ES>, UntypedDirectedGraphLayer<V,E,S>, UntypedGraph<V,E>, UntypedPhysicalLayer<N,L,LS>, Vertex, Zone

All Known Implementing Classes:

BicycleMode, BusMode, CarHighOccupancyMode, CarMode, CarShareMode, CentroidImpl, CentroidVertexImpl, ConjugateConnectoidEdgeImpl, ConjugateConnectoidNodeImpl, ConjugateConnectoidSegmentImpl, ConjugateDirectedEdgeImpl, ConjugateDirectedGraphImpl, ConjugateDirectedVertexImpl, ConjugateEdgeImpl, ConjugateEdgeSegmentImpl, ConjugateGraphImpl, ConjugateLinkImpl, ConjugateLinkSegmentImpl, ConjugateMacroscopicNetworkLayerImpl, ConjugateNodeImpl, ConjugateVertexImpl, ConnectoidEdgeImpl, ConnectoidImpl, ConnectoidSegmentImpl, DirectedConnectoidImpl, DirectedEdgeImpl, DirectedGraphImpl, DirectedVertexImpl, EdgeImpl, EdgeSegmentImpl, FerryMode, GoodsMode, GraphEntityImpl, GraphImpl, HeavyGoodsMode, LargeHeavyGoodsMode, LightRailMode, LinkImpl, LinkSegmentBase, MacroscopicLinkImpl, MacroscopicLinkSegmentImpl, MacroscopicLinkSegmentTypeImpl, MacroscopicNetworkLayerImpl, ManagedDirectedPathImpl, ModeImpl, MotorBikeMode, NetworkLayerImpl, NodeImpl, OdZoneImpl, PedestrianMode, PredefinedModeImpl, RoutedServiceImpl, RoutedServicesLayerImpl, RoutedTripDepartureImpl, RoutedTripFrequencyImpl, RoutedTripImpl, RoutedTripScheduleImpl, ServiceLegImpl, ServiceLegSegmentImpl, ServiceNetworkLayerImpl, ServiceNodeImpl, SubwayMode, TimePeriodImpl, TopologicalLayerImpl, TrainMode, TramMode, TransferZoneGroupImpl, TransferZoneImpl, TravellerType, UndirectedConnectoidImpl, UntypedDirectedGraphImpl, UntypedGraphImpl, UntypedNetworkLayerImpl, UntypedPhysicalLayerImpl, UserClass, VertexImpl, ZoneImpl

public interface ManagedId
extends IdAble

Interface supporting methods that aid in classes that implement IdAble where this id is based on a generated id via the IdGenerator using class signatures and grouping tokens to manage the id generation for the instances

Author:

markr

Method Summary

Modifier and Type	Method	Description
Class<? extends IdAble>	getIdClass()	Each managed id class is expected to generate its ids based on its class signature.
long	recreateManagedIds(IdGroupingToken tokenId)	recreate the internal id(s) and set them including the Idable id
default void	resetChildManagedIdEntities()	Each class that has a managed id, should be able to reset any children that themselves are managedIdEntity containers.

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

compareTo, deepClone, getId, idEquals, idHashCode, shallowClone

Method Detail

recreateManagedIds

long recreateManagedIds(IdGroupingToken tokenId)

recreate the internal id(s) and set them including the Idable id

Parameters:

tokenId - to use (may be null in case managed id entity does not rely on token to recreate its managed id(s))

Returns:

the updated internal id

getIdClass

Class<? extends IdAble> getIdClass()

Each managed id class is expected to generate its ids based on its class signature. To be able to generate the correct id the class used for id generation is to be provided via this method call.

Returns:

idClass to use for generating ids for instances of this idable derived class

resetChildManagedIdEntities

default void resetChildManagedIdEntities()

Each class that has a managed id, should be able to reset any children that themselves are managedIdEntity containers. This ensures that when resetting such a container any child containers are also reset