Package org.goplanit.network.layer.physical

Class NodesImpl

java.lang.Object

org.goplanit.utils.wrapper.MapWrapperImpl<Long,V>

org.goplanit.utils.wrapper.LongMapWrapperImpl<E>

org.goplanit.utils.id.ManagedIdEntitiesImpl<E>

org.goplanit.utils.graph.ManagedGraphEntitiesImpl<Node>

org.goplanit.network.layer.physical.NodesImpl

All Implemented Interfaces:

Cloneable, Iterable<Node>, GraphEntities<Node>, ManagedGraphEntities<Node>, ManagedIdEntities<Node>, Nodes, LongMapWrapper<Node>, MapWrapper<Long,Node>

public class NodesImpl
extends ManagedGraphEntitiesImpl<Node>
implements Nodes

Nodes primary managed container implementation

Author:

markr

Field Summary

Fields inherited from class org.goplanit.utils.id.ManagedIdEntitiesImpl

managedIdClass

Constructor Summary

Constructors

Constructor	Description
NodesImpl(NodesImpl other, boolean deepCopy, BiConsumer<Node,Node> mapper)	Copy constructor, also creates new factory with this as its underlying container
NodesImpl(IdGroupingToken groupId)	Constructor
NodesImpl(IdGroupingToken groupId, NodeFactory nodeFactory)	Constructor

Method Summary

Modifier and Type	Method	Description
NodesImpl	deepClone()	Deep clone implementation
NodesImpl	deepCloneWithMapping(BiConsumer<Node,Node> mapper)	Deep clone implementation where the mapping for its internal copies is captured by the provided mapper
NodeFactory	getFactory()	Factory to create instance of graph entity (for this container class)
void	recreateIds(boolean resetManagedIdClass)	Recreate the ids for all registered entities with or without resetting, this includes child managed ids, i.e., nested magedidentities containers if so indicated
void	reset()	When reset it called, it not only clears the entries, but also resets the managedids, such that when the container is reused the managed ids start from zero again.
NodesImpl	shallowClone()	Each map wrapper should be cloneable where the contents are references of the original where possible but the underlying map itself is newly created

Methods inherited from class org.goplanit.utils.graph.ManagedGraphEntitiesImpl

getByXmlId

Methods inherited from class org.goplanit.utils.id.ManagedIdEntitiesImpl

getManagedIdClass, updateIdMapping

Methods inherited from class org.goplanit.utils.wrapper.LongMapWrapperImpl

containsKey, get, remove

Methods inherited from class org.goplanit.utils.wrapper.MapWrapperImpl

clear, containsValue, createEmptyInstance, firstMatch, get, getKeyByValue, getMap, getValueToKey, isEmpty, iterator, register, remove, removeIf, setMap, size, toCollection, valuesAsNewSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.goplanit.utils.graph.GraphEntities

forEachMatchingIdIn, getByExternalId, getByXmlId

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.goplanit.utils.wrapper.LongMapWrapper

get, remove

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

containsKey, getManagedIdClass, groupBy, recreateIds, streamSortedBy

Methods inherited from interface org.goplanit.utils.wrapper.MapWrapper

addAll, clear, containsValue, firstMatch, forEachIn, get, getFirst, getKeyByValue, isEmpty, register, remove, removeAll, removeIf, size, stream, streamSorted, toCollection, toMap, valuesAsNewSet

Constructor Detail

NodesImpl

public NodesImpl(IdGroupingToken groupId)

Constructor

Parameters:

groupId - to use for creating ids for instances

NodesImpl

public NodesImpl(IdGroupingToken groupId,
                 NodeFactory nodeFactory)

Constructor

Parameters:

groupId - to use for creating ids for instances

nodeFactory - the factory to use

NodesImpl

public NodesImpl(NodesImpl other,
                 boolean deepCopy,
                 BiConsumer<Node,Node> mapper)

Copy constructor, also creates new factory with this as its underlying container

Parameters:

other - to copy

deepCopy - when true, create a deep cpy, shallow copy otherwise

mapper - apply to each mapping from original to copy

Method Detail

getFactory

public NodeFactory getFactory()

Factory to create instance of graph entity (for this container class)

Specified by:

getFactory in interface GraphEntities<Node>

Specified by:

getFactory in interface ManagedIdEntities<Node>

Specified by:

getFactory in interface Nodes

Returns:

entity factory

recreateIds

public void recreateIds(boolean resetManagedIdClass)

Recreate the ids for all registered entities with or without resetting, this includes child managed ids, i.e., nested magedidentities containers if so indicated

Specified by:

recreateIds in interface ManagedIdEntities<Node>

Overrides:

recreateIds in class ManagedIdEntitiesImpl<Node>

Parameters:

resetManagedIdClass - when true we reset the managedId's counter to zero (via its id class) before recreating the ids, otherwise we simply recreate the managed id by starting with the next available id without resetting

shallowClone

public NodesImpl shallowClone()

Each map wrapper should be cloneable where the contents are references of the original where possible but the underlying map itself is newly created

Specified by:

shallowClone in interface GraphEntities<Node>

Specified by:

shallowClone in interface ManagedGraphEntities<Node>

Specified by:

shallowClone in interface ManagedIdEntities<Node>

Specified by:

shallowClone in interface MapWrapper<Long,Node>

Specified by:

shallowClone in interface Nodes

Specified by:

shallowClone in class ManagedGraphEntitiesImpl<Node>

Returns:

copy

deepClone

public NodesImpl deepClone()

Deep clone implementation

Specified by:

deepClone in interface GraphEntities<Node>

Specified by:

deepClone in interface ManagedGraphEntities<Node>

Specified by:

deepClone in interface ManagedIdEntities<Node>

Specified by:

deepClone in interface Nodes

Specified by:

deepClone in class ManagedGraphEntitiesImpl<Node>

Returns:

deep copy of entities

deepCloneWithMapping

public NodesImpl deepCloneWithMapping(BiConsumer<Node,Node> mapper)

Deep clone implementation where the mapping for its internal copies is captured by the provided mapper

Specified by:

deepCloneWithMapping in interface GraphEntities<Node>

Specified by:

deepCloneWithMapping in interface ManagedGraphEntities<Node>

Specified by:

deepCloneWithMapping in interface ManagedIdEntities<Node>

Specified by:

deepCloneWithMapping in interface Nodes

Specified by:

deepCloneWithMapping in class ManagedGraphEntitiesImpl<Node>

Parameters:

mapper - to apply to each mapping between original and copy

Returns:

copy

reset

public void reset()

When reset it called, it not only clears the entries, but also resets the managedids, such that when the container is reused the managed ids start from zero again. If any entries are managedEntities themselves or contain managed entities themselves, they are reset as well

Specified by:

reset in interface ManagedIdEntities<Node>

Overrides:

reset in class ManagedIdEntitiesImpl<Node>