com.agenarisk.api.model

Class Network

java.lang.Object

com.agenarisk.api.model.Network

All Implemented Interfaces:

IdContainer<NetworkException>, Identifiable<NetworkException>, Named, Networked<Network>, Storable, Comparable<Network>

public class Network
extends Object
implements Networked<Network>, Comparable<Network>, Identifiable<NetworkException>, IdContainer<NetworkException>, Storable, Named

Network class represents an equivalent to a Risk Object in AgenaRisk Desktop or ExtendedBN in AgenaRisk Java API v1.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(Network o) Compares this Network object to another based on the Id of this object.
protected static Network	createNetwork(Model model, org.json.JSONObject jsonNetwork) Factory method to be called by a Model object that is trying to add a Network to itself.
protected static Network	createNetwork(Model model, org.json.JSONObject jsonNetwork, boolean withTables) Factory method to be called by a Model object that is trying to add a Network to itself.
protected static Network	createNetwork(Model model, String id, String name) Factory method to be called by a Model object that is trying to add a Network to itself.
Node	createNode(org.json.JSONObject jsonNode) Creates a Node from its JSONObject specification and adds it to this Network.
Node	createNode(org.json.JSONObject jsonNode, boolean withTables) Creates a Node from its JSONObject specification and adds it to this Network.
Node	createNode(String id, Node.Type type) Creates a Node and adds it to this Network.
Node	createNode(String id, String name, Node.Type type) Creates a Node and adds it to this Network.
boolean	equals(Object obj) Checks equality of a given object to this Network.
Set<Network>	getChildren() Builds and returns a set of Networks, which are children of this Network.
String	getDescription() Gets the description of this Network.
String	getId() Gets the ID of this Network.
Map<Id,? extends Identifiable>	getIdMap(Class<? extends Identifiable> idClassType) Deprecated. For internal use only
List<Link>	getLinksIn() Returns a copy of the incoming Links list.
List<Link>	getLinksOut() Returns a copy of the outgoing Links list.
uk.co.agena.minerva.model.extendedbn.ExtendedBN	getLogicNetwork() Deprecated. Will be made module-restricted in the future.
Model	getModel() Returns the Model that this Network belongs to.
String	getName() Gets the name of this Network.
Node	getNode(String id) Gets Node from the Network by its unique ID.
List<Node>	getNodeList() Returns Nodes of this Network as a list
Map<String,Node>	getNodes() Returns a copy of ID-Node map.
Set<Network>	getParents() Builds and returns a set of Networks, which are parents of this Network.
int	hashCode() Returns a hash code value for this object.
protected void	regenerateNPTs() Regenerates Node NPTs in the Network, in descending order of the number of ancestors a Node has, starting from the root(s) of the Network. Skips simulated and input nodes.
void	removeNode(Node node) Removes the provided node from the model, severing its links to other Nodes and then removing it from its Network.
void	setDescription(String description) Sets the description of this Network.
void	setId(String id) Changes the ID of this Network to the provided ID, if the new ID is not already taken.
protected void	setLogicNetwork(uk.co.agena.minerva.model.extendedbn.ExtendedBN logicNetwork) Links this Network to an underlying Minerva Network object.
void	setName(String name) Sets the name of this Network.
void	throwIdExistsException(String id) Deprecated. For internal use only
void	throwOldIdNullException(String id) Deprecated. For internal use only
org.json.JSONObject	toJson() Creates a JSON representing this Network, ready for file storage.
String	toString() Returns toStringExtra().
String	toStringExtra() Returns the ID of the underlying network surrounded by back ticks.
boolean	unlink(Network network) Removes all links (if any exist) between the two networks.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.agenarisk.api.model.interfaces.Networked

hasAncestor, hasDescendant

Methods inherited from interface com.agenarisk.api.model.interfaces.IdContainer

changeContainedId

Method Detail

createNetwork

protected static Network createNetwork(Model model,
                                       String id,
                                       String name)

Factory method to be called by a Model object that is trying to add a Network to itself.

Parameters:

model - the Model to add a Network to

id - the ID of the Network

name - the name of the Network

Returns:

the created Network

createNetwork

protected static Network createNetwork(Model model,
                                       org.json.JSONObject jsonNetwork)
                                throws org.json.JSONException,
                                       NetworkException

Factory method to be called by a Model object that is trying to add a Network to itself.
Note: loading node tables will fail if parent nodes do not exist in the model. In that case load all nodes first without tables and then use setTable(JSONObject) after all nodes, states, intra and cross network links had been created.

Parameters:

model - the Model to add a Network to

jsonNetwork - JSONObject representing the network, including structure, tables, graphics etc

Returns:

the created Network

Throws:

org.json.JSONException - if JSON configuration is incomplete or invalid

NetworkException - if failed to load a network or node or if an object not found

See Also:

Node.setTable(JSONObject)

createNetwork

protected static Network createNetwork(Model model,
                                       org.json.JSONObject jsonNetwork,
                                       boolean withTables)
                                throws org.json.JSONException,
                                       NetworkException

Factory method to be called by a Model object that is trying to add a Network to itself.
Note: loading node tables will fail if parent nodes do not exist in the model. In that case load all nodes first without tables and then use setTable(JSONObject) after all nodes, states, intra and cross network links had been created.

Parameters:

model - the Model to add a Network to

jsonNetwork - JSONObject representing the network, including structure, tables, graphics etc

withTables - whether to load node tables from JSON

Returns:

the created Network

Throws:

org.json.JSONException - if JSON configuration is incomplete or invalid

NetworkException - if failed to load a network or node or if an object not found

See Also:

Node.setTable(JSONObject)

createNode

public Node createNode(String id,
                       String name,
                       Node.Type type)
                throws NetworkException

Creates a Node and adds it to this Network.

Parameters:

id - ID of the Node

name - name of the Node

type - type of the Node

Returns:

the created Node

Throws:

NetworkException - if Node creation failed

createNode

public Node createNode(String id,
                       Node.Type type)
                throws NetworkException

Creates a Node and adds it to this Network.

Parameters:

id - ID of the Node

type - type of the Node

Returns:

the created Node

Throws:

NetworkException - if Node creation failed

createNode

public Node createNode(org.json.JSONObject jsonNode,
                       boolean withTables)
                throws NetworkException

Creates a Node from its JSONObject specification and adds it to this Network.
Note: loading node tables will fail if parent nodes do not exist in the model. In that case load all nodes first without tables and then use setTable(JSONObject) after all nodes, states, intra and cross network links had been created.

Parameters:

jsonNode - JSONObject with full Node's configuration

withTables - whether to load node tables from JSON

Returns:

the created Node

Throws:

NetworkException - if Node creation failed (Node with given ID already exists; or JSON configuration is missing required attributes)

See Also:

Node.setTable(JSONObject)

createNode

public Node createNode(org.json.JSONObject jsonNode)
                throws NetworkException

Creates a Node from its JSONObject specification and adds it to this Network.
Note: loading node tables will fail if parent nodes do not exist in the model. In that case load all nodes first without tables and then use setTable(JSONObject) after all nodes, states, intra and cross network links had been created.

Parameters:

jsonNode - JSONObject with full Node's configuration

Returns:

the created Node

Throws:

NetworkException - if Node creation failed (Node with given ID already exists; or JSON configuration is missing required attributes)

See Also:

Node.setTable(JSONObject)

getId

public final String getId()

Gets the ID of this Network.

Specified by:

getId in interface Identifiable<NetworkException>

Returns:

the ID of this Network

setId

public final void setId(String id)
                 throws NetworkException

Changes the ID of this Network to the provided ID, if the new ID is not already taken.
Will lock IDContainer.class while doing so.

Specified by:

setId in interface Identifiable<NetworkException>

Parameters:

id - the new ID

Throws:

NetworkException - if fails to change ID

getLogicNetwork

public final uk.co.agena.minerva.model.extendedbn.ExtendedBN getLogicNetwork()

Deprecated. Will be made module-restricted in the future.

Returns the underlying logical ExtendedBN network.
Using logic objects directly is unsafe and is likely to break something.

Returns:

the underlying logical ExtendedBN network

getModel

public final Model getModel()

Returns the Model that this Network belongs to.

Returns:

the Model that this Network belongs to

compareTo

public int compareTo(Network o)

Compares this Network object to another based on the Id of this object.

Specified by:

compareTo in interface Comparable<Network>

Parameters:

o - another Network object

Returns:

a negative integer, zero, or a positive integer if the value of this object's ID precedes the one of the specified object's ID

See Also:

Id.compareTo(Id)

equals

public boolean equals(Object obj)

Checks equality of a given object to this Network. Returns true if logic networks of both objects are the same.

Overrides:

equals in class Object

Parameters:

obj - The object to compare this Network against

Returns:

true if the given object represents the same Network as this Network, false otherwise

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.

toString

public String toString()

Returns toStringExtra().

Overrides:

toString in class Object

Returns:

toStringExtra()

toStringExtra

public String toStringExtra()

Returns the ID of the underlying network surrounded by back ticks.

Returns:

the ID of the underlying network surrounded by back ticks

getParents

public Set<Network> getParents()

Builds and returns a set of Networks, which are parents of this Network.
Networks are connected with Links between their Nodes.
So for two Networks Net1 and Net2 and Nodes Node1 and Node2, where Node1 belongs to Net1 and Node2 belongs to Net2, and Node1 → Node2, Net2 is the child of Net1.

Specified by:

getParents in interface Networked<Network>

Returns:

a set of Networks that are parents of this Network

getChildren

public Set<Network> getChildren()

Builds and returns a set of Networks, which are children of this Network.
Networks are connected with Links between their Nodes.
So for two Networks Net1 and Net2 and Nodes Node1 and Node2, where Node1 belongs to Net1 and Node2 belongs to Net2, and Node1 → Node2, Net2 is the child of Net1.

Specified by:

getChildren in interface Networked<Network>

Returns:

a set of Networks that are children of this Network

getLinksIn

public List<Link> getLinksIn()

Returns a copy of the incoming Links list.

Specified by:

getLinksIn in interface Networked<Network>

Returns:

a copy of the incoming Links list

getLinksOut

public List<Link> getLinksOut()

Returns a copy of the outgoing Links list.

Specified by:

getLinksOut in interface Networked<Network>

Returns:

a copy of the outgoing Links list

unlink

public boolean unlink(Network network)

Removes all links (if any exist) between the two networks.

Specified by:

unlink in interface Networked<Network>

Parameters:

network - the Network to sever connections with

Returns:

false if Network objects are the same, true otherwise

getIdMap

@Deprecated
public Map<Id,? extends Identifiable> getIdMap(Class<? extends Identifiable> idClassType)
                                                     throws NetworkException

Deprecated. For internal use only

Description copied from interface: IdContainer

Returns the map of identifiable items based on.

Specified by:

getIdMap in interface IdContainer<NetworkException>

Parameters:

idClassType - the class of identifiable object

Returns:

ID-Identifiable map

Throws:

NetworkException - when invalid type requested

throwIdExistsException

@Deprecated
public void throwIdExistsException(String id)
                                         throws NetworkException

Deprecated. For internal use only

Description copied from interface: IdContainer

Throws an Exception with message e.g. "Object with id `id` already exists", localised for the implementing class.

Specified by:

throwIdExistsException in interface IdContainer<NetworkException>

Parameters:

id - ID of the existing object

Throws:

NetworkException - when invoked

throwOldIdNullException

@Deprecated
public void throwOldIdNullException(String id)
                                          throws NetworkException

Deprecated. For internal use only

Description copied from interface: IdContainer

Throws an Exception with message e.g. "No such object or old ID is null", localised for the implementing class.

Specified by:

throwOldIdNullException in interface IdContainer<NetworkException>

Parameters:

id - ID of the existing object

Throws:

NetworkException - when invoked

getNode

public Node getNode(String id)

Gets Node from the Network by its unique ID.

Parameters:

id - the ID of the Node

Returns:

the Node with the given ID or null if no such node exists in the Network

getNodes

public Map<String,Node> getNodes()

Returns a copy of ID-Node map.
Once generated, membership of this map is not maintained.

Returns:

copy of ID-Node map

getNodeList

public List<Node> getNodeList()

Returns Nodes of this Network as a list

Returns:

list of Nodes

toJson

public org.json.JSONObject toJson()

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

Specified by:

toJson in interface Storable

Returns:

JSONObject representing this Network

setName

public void setName(String name)

Sets the name of this Network.

Specified by:

setName in interface Named

Parameters:

name - new name

getName

public String getName()

Gets the name of this Network.

Specified by:

getName in interface Named

Returns:

the name of this Network

setDescription

public void setDescription(String description)

Sets the description of this Network.

Specified by:

setDescription in interface Named

Parameters:

description - new description

getDescription

public String getDescription()

Gets the description of this Network.

Specified by:

getDescription in interface Named

Returns:

the description of this Network

setLogicNetwork

protected void setLogicNetwork(uk.co.agena.minerva.model.extendedbn.ExtendedBN logicNetwork)

Links this Network to an underlying Minerva Network object. Should only be used while wrapping a new Model around the Minerva Model.

Parameters:

logicNetwork - the logical network

removeNode

public void removeNode(Node node)
                throws NodeException

Removes the provided node from the model, severing its links to other Nodes and then removing it from its Network.

Parameters:

node - Node to remove

Throws:

NodeException - if the operation fails

regenerateNPTs

protected void regenerateNPTs()
                       throws NetworkException

Regenerates Node NPTs in the Network, in descending order of the number of ancestors a Node has, starting from the root(s) of the Network.
Skips simulated and input nodes.

Throws:

NetworkException - if regeneration fails in the logic