Package org.goplanit.utils.zoning

Interface DirectedConnectoids

All Superinterfaces:

Connectoids<DirectedConnectoid>, EventListener, EventListener, Iterable<DirectedConnectoid>, LongMapWrapper<DirectedConnectoid>, ManagedIdEntities<DirectedConnectoid>, MapWrapper<Long,DirectedConnectoid>, ZoningModifierListener

All Known Implementing Classes:

DirectedConnectoidsImpl

public interface DirectedConnectoids
extends Connectoids<DirectedConnectoid>

container and factory class for directed connectoids

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static Logger	LOGGER

Method Summary

Modifier and Type	Method	Description
DirectedConnectoids	deepClone()	Deep clone implementation
DirectedConnectoids	deepCloneWithMapping(BiConsumer<DirectedConnectoid,DirectedConnectoid> mapper)	Deep clone implementation where the mapping for its internal copies is captured by the provided mapper
DirectedConnectoidFactory	getFactory()	Factory to create instance of managed id entity (for this container class)
default <L extends UntypedPhysicalLayer<?,?,?>,K extends Comparable> Map<L,Map<K,List<DirectedConnectoid>>>	groupByPhysicalLayerAndCustomKey(Iterable<L> networkLayers, Function<DirectedConnectoid,K> mapToKey)	For a given physical network layers container that has a relation with these directed connectoids, index all connectoids by a custom key on the layers they connect to.
DirectedConnectoids	shallowClone()	Shallow clone implementation

Methods inherited from interface org.goplanit.utils.zoning.Connectoids

createIndexByAccessZone

Methods inherited from interface org.goplanit.utils.event.EventListener

getKnownSupportedEventTypes, hasKnownSupportedEventTypes

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, recreateIds, reset, 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

Methods inherited from interface org.goplanit.utils.zoning.modifier.event.ZoningModifierListener

onZoningModifierEvent

Field Detail

LOGGER

static final Logger LOGGER

Method Detail

getFactory

DirectedConnectoidFactory getFactory()

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

Specified by:

getFactory in interface ManagedIdEntities<DirectedConnectoid>

Returns:

entity factory

shallowClone

DirectedConnectoids shallowClone()

Shallow clone implementation

Specified by:

shallowClone in interface Connectoids<DirectedConnectoid>

Specified by:

shallowClone in interface ManagedIdEntities<DirectedConnectoid>

Specified by:

shallowClone in interface MapWrapper<Long,DirectedConnectoid>

Returns:

clone of entities

deepClone

DirectedConnectoids deepClone()

Deep clone implementation

Specified by:

deepClone in interface Connectoids<DirectedConnectoid>

Specified by:

deepClone in interface ManagedIdEntities<DirectedConnectoid>

Returns:

deep copy of entities

deepCloneWithMapping

DirectedConnectoids deepCloneWithMapping(BiConsumer<DirectedConnectoid,DirectedConnectoid> mapper)

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

Specified by:

deepCloneWithMapping in interface Connectoids<DirectedConnectoid>

Specified by:

deepCloneWithMapping in interface ManagedIdEntities<DirectedConnectoid>

Parameters:

mapper - to apply to each mapping between original and copy

Returns:

copy

groupByPhysicalLayerAndCustomKey

default <L extends UntypedPhysicalLayer<?,?,?>,K extends Comparable> Map<L,Map<K,List<DirectedConnectoid>>> groupByPhysicalLayerAndCustomKey(Iterable<L> networkLayers,
                                                                                                                                                                           Function<DirectedConnectoid,K> mapToKey)

For a given physical network layers container that has a relation with these directed connectoids, index all connectoids by a custom key on the layers they connect to.

Type Parameters:

L - type of the layer

K - type of comparable

Parameters:

networkLayers - to index for

mapToKey - the mapping to key from connectoid

Returns:

directed connectoids indexed by access node location per layer