com.agenarisk.api.model

Class Link

java.lang.Object

com.agenarisk.api.model.Link

All Implemented Interfaces:

Storable, Comparable<Link>

Direct Known Subclasses:

CrossNetworkLink

public class Link
extends Object
implements Comparable<Link>, Storable

Link represents a link between two nodes.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Link.Field This is set of fields for input/output to XML and JSON format

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Link(Node fromNode, Node toNode) Deprecated. For internal use only. Use createLink() instead

Method Summary

Modifier and Type	Method and Description
int	compareTo(Link o) Compares this Link object to another based on its underlying logic network and node IDs.
protected static Link	createLink(Node fromNode, Node toNode) Creates a Link object without manipulating the nodes themselves.
protected void	createLogicLink() This will create a link in the underlying logic.
protected void	destroyLogicLink() Destroys the underlying logic link Has no effect if the underlying logical network does not contain either of the nodes.
boolean	equals(Object obj) Checks equality of a given object to this Link.
Node	getFromNode() Returns the source Link Node.
Node	getToNode() Returns the target Link Node.
int	hashCode() Returns a hash code value for this object.
protected void	setGraphics(org.json.JSONObject graphics) Stores Link's graphics.
org.json.JSONObject	toJson() Creates a JSON representing this Link, ready for file storage.
String	toString() Returns toStringExtra().
String	toStringExtra() Returns the string representation of the Link as: `Net1`.`Node1` → `Net2`.`Node2`.

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

@Deprecated
protected Link(Node fromNode,
                            Node toNode)

Deprecated. For internal use only. Use createLink() instead

Creates the Link object. Only for use by Link class and its subclasses.

Parameters:

fromNode - source Node of the Link

toNode - target Node of the Link

Method Detail

createLink

protected static Link createLink(Node fromNode,
                                 Node toNode)
                          throws LinkException

Creates a Link object without manipulating the nodes themselves.

Parameters:

fromNode - source Node of the Link

toNode - target Node of the Link

Returns:

the created Link object

Throws:

LinkException - if Nodes are in different Network (in that case CrossNetworkLink should haves been used)

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.

Throws:

LinkException - if logical link was not created

destroyLogicLink

protected void destroyLogicLink()

Destroys the underlying logic link
Has no effect if the underlying logical network does not contain either of the nodes.

getFromNode

public Node getFromNode()

Returns the source Link Node.

Returns:

the source Link Node

getToNode

public Node getToNode()

Returns the target Link Node.

Returns:

the target Link Node

toString

public String toString()

Returns toStringExtra().

Overrides:

toString in class Object

Returns:

toStringExtra()

toStringExtra

public String toStringExtra()

Returns the string representation of the Link as: `Net1`.`Node1` → `Net2`.`Node2`.

Returns:

string representation of the Link

compareTo

public int compareTo(Link o)

Compares this Link object to another based on its underlying logic network and node IDs.

Specified by:

compareTo in interface Comparable<Link>

Parameters:

o - another Link object

Returns:

String comparison of toStringExtra() of both Links

equals

public boolean equals(Object obj)

Checks equality of a given object to this Link.

Overrides:

equals in class Object

Parameters:

obj - The object to compare this Link against

Returns:

true if the two object references are the same

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

setGraphics

protected void setGraphics(org.json.JSONObject graphics)

Stores Link's graphics.

Parameters:

graphics - the graphics json to store

toJson

public org.json.JSONObject toJson()

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

Specified by:

toJson in interface Storable

Returns:

JSONObject representing this Link