com.dna.jopt.member.unit.nodeedge

Interface INodeEdgeConnector

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractNodeEdgeConnector, NodeEdgeConnector

public interface INodeEdgeConnector
extends Serializable

The Interface INodeConnector. A node connector is holding a table of INodeConnectorItem which hold the two Strings of the start and the end location. Each INodeConnectorItem is describing for example the time, distance etc. between two nodes.

By default the Table is implemented as TreeBasedTable which is used to store the connection items.

The INodeConnectorItem can be populated with realistic data on distance and time needed between two locations. If not populated, the IBackupElementConnector is used to create missing connections. The default DefaultFlatEarthAverageSpeedBackupElementConnector uses the haversine formula to calculate the distance between two points. Further it uses an average speed to calculate the driving time between two points based on the previously calculated distance.

Recommendation: The connections of two Nodes should be filtered before the INodeconnector is being populated. If one Node is only accessible in December and another one only in January the Optimizer most likely never puts them in the same Route in the final result which is more efficient and the specific data on the distance between these Nodes does not need to be acquired.

Since:

06/09/2019

Version:

19/09/2019

Author:

DNA

Method Summary

Modifier and Type	Method and Description
void	attachSeparatedTestConnectionProvider(ISeparatedTestConnectionProvider separatedTestConnectionProvider)
Set<String>	cleanUp(List<IOptimizationElement> presentItems, List<String> presentIdemIds) Cleans up the connections table by removing connections with no present items.
void	dropSeparatedTestConnectionProvider()
IBackupElementConnector	getBackupElementConnector() Gets the systems default or user provided backup element connector.
Optional<IExternalConnectionProvider>	getExternalConnectionProvider()
INodeConnectorItem	getNodeConnection(IOptimizationElement from, IOptimizationElement to, ILogicEntityRoute contextRoute)
INodeConnectorItem	getNodeConnection(IOptimizationElement from, IOptimizationElement to, IResource visitor) Gets a specific node connection.
INodeConnectorItem	getNodeConnection(String fromId, String tooId) Gets a specific node connection between two IOptimizationElement ids.
List<INodeConnectorItem>	getNodeConnections() Gets all connections as a list instead of a table.
Optional<ISeparatedTestConnectionProvider>	getSeparatedTestConnectionProvider()
boolean	hasConnectionToOrFrom(String elementId)
void	putNodeConnection(INodeConnectorItem connection) Puts a single node connection.
void	putNodeConnection(String from, String too, INodeConnectorItem connection) Deprecated. please use putNodeConnection(INodeConnectorItem) or putNodeConnections(List) instead
void	putNodeConnectionIfNotExisting(INodeConnectorItem connection) Put node connection if not existing.
void	putNodeConnectionIfNotExisting(String from, String too, INodeConnectorItem connection) Deprecated. please use putNodeConnectionIfNotExisting(INodeConnectorItem) instead
void	putNodeConnections(List<INodeConnectorItem> connections) Puts a list of connections to be stored in the table.
void	putNodeConnectionsIfNotExisting(List<INodeConnectorItem> connections)
void	refactorNodeConnectorConnection(IOptimizationElement oldElement, IOptimizationElement newElement, boolean reAddConnections)
boolean	removeConnection(IOptimizationElement removeElement) Removes a connection.
boolean	removeConnection(IOptimizationElement removeElement, Optional<Set<String>> protectedIdsOpt) Removes the connection.
void	removeConnectionFromElements(IOptimizationElement removeElement)
void	setBackupElementConnector(IBackupElementConnector backUpConnector) Sets the IBackupElementConnector which is used if the INodeEdgeConnector cannot find a requested connection.
void	setExternalConnectionProvider(IExternalConnectionProvider externalConnectionProvider)
void	setNodeConnections(com.google.common.collect.Table<String,String,INodeConnectorItem> table) Sets the node connections table.

Method Detail

getNodeConnection

INodeConnectorItem getNodeConnection(IOptimizationElement from,
                                     IOptimizationElement to,
                                     IResource visitor)

Gets a specific node connection. This call will ignore connections hooks.

Parameters:

from - the starting IOptimizationElement of the connection

to - the termination IOptimizationElement of the connection

visitor - the IResource visitor

Returns:

the node connection

getNodeConnection

INodeConnectorItem getNodeConnection(IOptimizationElement from,
                                     IOptimizationElement to,
                                     ILogicEntityRoute contextRoute)

getNodeConnections

List<INodeConnectorItem> getNodeConnections()

Gets all connections as a list instead of a table.

Returns:

the node connections

setNodeConnections

void setNodeConnections(com.google.common.collect.Table<String,String,INodeConnectorItem> table)

Sets the node connections table.

Parameters:

table - the table

putNodeConnections

void putNodeConnections(List<INodeConnectorItem> connections)

Puts a list of connections to be stored in the table. Already present connections (identified via the unique ids of the connection member IOptimizationElement) are replaced.

Parameters:

connections - the connections

putNodeConnection

void putNodeConnection(INodeConnectorItem connection)

Puts a single node connection. An already present connection (identified via the unique ids of the connection member IOptimizationElement) is replaced.

Parameters:

connection - the connection

putNodeConnectionIfNotExisting

void putNodeConnectionIfNotExisting(INodeConnectorItem connection)

Put node connection if not existing. An already present connection (identified via the unique ids of the connection member IOptimizationElement) is kept.

Parameters:

connection - the connection

putNodeConnection

@Deprecated
void putNodeConnection(String from,
                                   String too,
                                   INodeConnectorItem connection)

Deprecated. please use putNodeConnection(INodeConnectorItem) or putNodeConnections(List) instead

Deprecated method.

Parameters:

from - the string the start of the connection

too - the string the end of the connection

connection - the iNodeConnectorItem where the distance is saved

putNodeConnectionIfNotExisting

@Deprecated
void putNodeConnectionIfNotExisting(String from,
                                                String too,
                                                INodeConnectorItem connection)

Deprecated. please use putNodeConnectionIfNotExisting(INodeConnectorItem) instead

Deprecated method.

Parameters:

from - the string the start of the connection

too - the string the end of the connection

connection - the iNodeConnectorItem where the distance is saved

getNodeConnection

INodeConnectorItem getNodeConnection(String fromId,
                                     String tooId)

Gets a specific node connection between two IOptimizationElement ids. In case the connections was not provided by the user the IBackupElementConnector is used to create the connection.

Parameters:

fromId - the from

tooId - the too

Returns:

the node connection

cleanUp

Set<String> cleanUp(List<IOptimizationElement> presentItems,
                    List<String> presentIdemIds)

Cleans up the connections table by removing connections with no present items.

Parameters:

presentItems - the present items to be kept

presentIdemIds - the present items ids to be kept.

Returns:

the set strings of the removed nodeConnectorIds

removeConnection

boolean removeConnection(IOptimizationElement removeElement)

Removes a connection.

Parameters:

removeElement - the remove element

Returns:

true, if successful

removeConnection

boolean removeConnection(IOptimizationElement removeElement,
                         Optional<Set<String>> protectedIdsOpt)

Removes the connection. A connections is only protected, if both (from and too element) are on the list of protected ids.

Parameters:

removeElement - the remove element

protectedIdsOpt - the protected ids opt

Returns:

true, if successful

setBackupElementConnector

void setBackupElementConnector(IBackupElementConnector backUpConnector)

Sets the IBackupElementConnector which is used if the INodeEdgeConnector cannot find a requested connection. The IBackupElementConnector defines how the item is created.

By default the DefaultFlatEarthAverageSpeedBackupElementConnector is used.

Parameters:

backUpConnector - the iBackupElementConnector which is used as a fall back

getBackupElementConnector

IBackupElementConnector getBackupElementConnector()

Gets the systems default or user provided backup element connector.

Returns:

the backup element connector

setExternalConnectionProvider

void setExternalConnectionProvider(IExternalConnectionProvider externalConnectionProvider)

getExternalConnectionProvider

Optional<IExternalConnectionProvider> getExternalConnectionProvider()

attachSeparatedTestConnectionProvider

void attachSeparatedTestConnectionProvider(ISeparatedTestConnectionProvider separatedTestConnectionProvider)

getSeparatedTestConnectionProvider

Optional<ISeparatedTestConnectionProvider> getSeparatedTestConnectionProvider()

dropSeparatedTestConnectionProvider

void dropSeparatedTestConnectionProvider()

removeConnectionFromElements

void removeConnectionFromElements(IOptimizationElement removeElement)

putNodeConnectionsIfNotExisting

void putNodeConnectionsIfNotExisting(List<INodeConnectorItem> connections)

refactorNodeConnectorConnection

void refactorNodeConnectorConnection(IOptimizationElement oldElement,
                                     IOptimizationElement newElement,
                                     boolean reAddConnections)

hasConnectionToOrFrom

boolean hasConnectionToOrFrom(String elementId)