com.dna.jopt.member.unit.nodeedge

Class AbstractNodeEdgeConnector

java.lang.Object

com.dna.jopt.member.unit.nodeedge.AbstractNodeEdgeConnector

All Implemented Interfaces:

INodeEdgeConnector, Serializable

Direct Known Subclasses:

NodeEdgeConnector

public abstract class AbstractNodeEdgeConnector
extends Object
implements INodeEdgeConnector, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractNodeEdgeConnector()
AbstractNodeEdgeConnector(IBackupElementConnector backUpConnector)
AbstractNodeEdgeConnector(IBackupElementConnector backUpConnector, IExternalConnectionProvider externalConnectionProvider)
AbstractNodeEdgeConnector(IExternalConnectionProvider externalConnectionProvider)

Method Summary

Modifier and Type	Method and Description
void	attachSeparatedTestConnectionProvider(ISeparatedTestConnectionProvider consumableProvider)
void	dropSeparatedTestConnectionProvider()
IBackupElementConnector	getBackupElementConnector() Gets the systems default or user provided backup element connector.
Optional<IExternalConnectionProvider>	getExternalConnectionProvider()
INodeConnectorItem	getNodeConnection(String from, String too) Gets a specific node connection between two IOptimizationElement ids.
List<INodeConnectorItem>	getNodeConnections() Gets all connections as a list instead of a table.
protected com.google.common.collect.Table<String,String,INodeConnectorItem>	getNodeConnectorTable()
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) 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	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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dna.jopt.member.unit.nodeedge.INodeEdgeConnector

cleanUp, getNodeConnection, getNodeConnection, refactorNodeConnectorConnection, removeConnection, removeConnection, removeConnectionFromElements

Constructor Detail

AbstractNodeEdgeConnector

public AbstractNodeEdgeConnector()

AbstractNodeEdgeConnector

public AbstractNodeEdgeConnector(IBackupElementConnector backUpConnector)

AbstractNodeEdgeConnector

public AbstractNodeEdgeConnector(IExternalConnectionProvider externalConnectionProvider)

AbstractNodeEdgeConnector

public AbstractNodeEdgeConnector(IBackupElementConnector backUpConnector,
                                 IExternalConnectionProvider externalConnectionProvider)

Method Detail

getNodeConnectorTable

protected com.google.common.collect.Table<String,String,INodeConnectorItem> getNodeConnectorTable()

setNodeConnections

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

Description copied from interface: INodeEdgeConnector

Sets the node connections table.

Specified by:

setNodeConnections in interface INodeEdgeConnector

Parameters:

table - the table

setBackupElementConnector

public void setBackupElementConnector(IBackupElementConnector backUpConnector)

Description copied from interface: INodeEdgeConnector

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.

Specified by:

setBackupElementConnector in interface INodeEdgeConnector

Parameters:

backUpConnector - the iBackupElementConnector which is used as a fall back

getBackupElementConnector

public IBackupElementConnector getBackupElementConnector()

Description copied from interface: INodeEdgeConnector

Gets the systems default or user provided backup element connector.

Specified by:

getBackupElementConnector in interface INodeEdgeConnector

Returns:

the backup element connector

setExternalConnectionProvider

public void setExternalConnectionProvider(IExternalConnectionProvider externalConnectionProvider)

Specified by:

setExternalConnectionProvider in interface INodeEdgeConnector

getExternalConnectionProvider

public Optional<IExternalConnectionProvider> getExternalConnectionProvider()

Specified by:

getExternalConnectionProvider in interface INodeEdgeConnector

attachSeparatedTestConnectionProvider

public void attachSeparatedTestConnectionProvider(ISeparatedTestConnectionProvider consumableProvider)

Specified by:

attachSeparatedTestConnectionProvider in interface INodeEdgeConnector

getSeparatedTestConnectionProvider

public Optional<ISeparatedTestConnectionProvider> getSeparatedTestConnectionProvider()

Specified by:

getSeparatedTestConnectionProvider in interface INodeEdgeConnector

dropSeparatedTestConnectionProvider

public void dropSeparatedTestConnectionProvider()

Specified by:

dropSeparatedTestConnectionProvider in interface INodeEdgeConnector

getNodeConnection

public INodeConnectorItem getNodeConnection(String from,
                                            String too)

Description copied from interface: INodeEdgeConnector

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.

Specified by:

getNodeConnection in interface INodeEdgeConnector

Parameters:

from - the from

too - the too

Returns:

the node connection

hasConnectionToOrFrom

public boolean hasConnectionToOrFrom(String elementId)

Specified by:

hasConnectionToOrFrom in interface INodeEdgeConnector

getNodeConnections

public List<INodeConnectorItem> getNodeConnections()

Description copied from interface: INodeEdgeConnector

Gets all connections as a list instead of a table.

Specified by:

getNodeConnections in interface INodeEdgeConnector

Returns:

the node connections

putNodeConnections

public void putNodeConnections(List<INodeConnectorItem> connections)

Description copied from interface: INodeEdgeConnector

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.

Specified by:

putNodeConnections in interface INodeEdgeConnector

Parameters:

connections - the connections

putNodeConnection

public void putNodeConnection(INodeConnectorItem connection)

Description copied from interface: INodeEdgeConnector

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

Specified by:

putNodeConnection in interface INodeEdgeConnector

Parameters:

connection - the connection

putNodeConnectionsIfNotExisting

public void putNodeConnectionsIfNotExisting(List<INodeConnectorItem> connections)

Specified by:

putNodeConnectionsIfNotExisting in interface INodeEdgeConnector

putNodeConnectionIfNotExisting

public void putNodeConnectionIfNotExisting(INodeConnectorItem connection)

Description copied from interface: INodeEdgeConnector

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

Specified by:

putNodeConnectionIfNotExisting in interface INodeEdgeConnector

Parameters:

connection - the connection

putNodeConnection

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

Deprecated. please use putNodeConnection(INodeConnectorItem) instead

Deprecated method

Specified by:

putNodeConnection in interface INodeEdgeConnector

Parameters:

from - string start location

too - string end location

connection - the iNodeConnectoritem to write start and end locations to

putNodeConnectionIfNotExisting

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

Deprecated. please use putNodeConnectionIfNotExisting(INodeConnectorItem) instead

Deprecated method

Specified by:

putNodeConnectionIfNotExisting in interface INodeEdgeConnector

Parameters:

from - string start location

too - string end location

connection - the iNodeConnectoritem to write start and end locations to