com.agenarisk.api.model

Class CrossNetworkLink

java.lang.Object

com.agenarisk.api.model.Link

com.agenarisk.api.model.CrossNetworkLink

All Implemented Interfaces:

Storable, Comparable<Link>

public class CrossNetworkLink
extends Link
implements Storable

CrossNetworkLink represents a link between Nodes in different Networks.
It is a special case of a general Link due to the underlying requirements of AgenaRisk logic.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CrossNetworkLink.Field This is set of fields for input/output to XML and JSON format
static class	CrossNetworkLink.Type Possible types of data that the Link will pass

Method Summary

Modifier and Type	Method and Description
protected static CrossNetworkLink	createCrossNetworkLink(Node fromNode, Node toNode, CrossNetworkLink.Type type, String stateToPass) Factory method to create a CrossNetworkLink instance.
protected void	createLogicLink() This will create a link in the underlying logic.
protected void	destroyLogicLink() Destroys the underlying logic link.
protected uk.co.agena.minerva.model.MessagePassingLink	getLogicLink() Returns the underlying logical link.
String	getStateToPass() Returns the state to pass with this cross-network link.
CrossNetworkLink.Type	getType() Returns the type of this cross-network link.
org.json.JSONObject	toJson() Creates a JSON representing this Link, ready for file storage.

Methods inherited from class com.agenarisk.api.model.Link

compareTo, createLink, equals, getFromNode, getToNode, hashCode, setGraphics, toString, toStringExtra

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createCrossNetworkLink

protected static CrossNetworkLink createCrossNetworkLink(Node fromNode,
                                                         Node toNode,
                                                         CrossNetworkLink.Type type,
                                                         String stateToPass)
                                                  throws LinkException

Factory method to create a CrossNetworkLink instance.
Does not create the underlying logical link.
Should be used by Node.linkNodes().

Parameters:

fromNode - the source Link node

toNode - the target Link node

type - the type of CrossNetworkLink

stateToPass - state to pass (if any)

Returns:

CrossNetworkLink created

Throws:

LinkException - if source and target are in the same Network; no CrossNetworkLink type specified; type passes state, but state not specified; type does not pass a state but state specified

createLogicLink

protected void createLogicLink()
                        throws LinkException

This will create a link in the underlying logic.
The underlying table of the child node will be reset to some default value.

Overrides:

createLogicLink in class Link

Throws:

LinkException - if logical link already exists or target Node already has parents; link has invalid type; or error/inconsistency in the underlying logic

destroyLogicLink

protected void destroyLogicLink()

Destroys the underlying logic link.
Has no effect if there is no link or the underlying logical networks do not contain either of the nodes.

Overrides:

destroyLogicLink in class Link

getLogicLink

protected uk.co.agena.minerva.model.MessagePassingLink getLogicLink()

Returns the underlying logical link.

Returns:

the underlying logical link

getType

public CrossNetworkLink.Type getType()

Returns the type of this cross-network link.

Returns:

link type

getStateToPass

public String getStateToPass()

Returns the state to pass with this cross-network link.

Returns:

the state to pass with this cross-network link or null if not passing a state

toJson

public org.json.JSONObject toJson()

Creates a JSON representing this Link, ready for file storage.

Specified by:

toJson in interface Storable

Overrides:

toJson in class Link

Returns:

JSONObject representing this Link