com.agenarisk.api.model

Class State

java.lang.Object

com.agenarisk.api.model.State

public class State
extends Object

Node class corresponds to a State in AgenaRisk Desktop or ExtendedState in AgenaRisk Java API v1.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static String	computeLabel(uk.co.agena.minerva.model.extendedbn.ExtendedNode en, uk.co.agena.minerva.model.extendedbn.ExtendedState es) Computes a label for a logical state.
protected static State	createState(Node node, String label) Creates a State instance for the given Node with the given Label.
String	getLabel() Gets the state's label.
uk.co.agena.minerva.model.extendedbn.ExtendedState	getLogicState() Deprecated. Will be affected by module architecture in the future and should not be used.
Node	getNode() Gets the state's Node.
protected static State	getState(Node node, String label) Find a state by given label in the given Node's underlying logic node.
protected void	setLogicState(uk.co.agena.minerva.model.extendedbn.ExtendedState logicState) Links this State to an underlying API1 State object.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createState

protected static State createState(Node node,
                                   String label)
                            throws StateException

Creates a State instance for the given Node with the given Label.
Will not create an underlying logic state if one already exists with this label for the associated logic node.

Parameters:

node - State's Node

label - State's label (or string representation of corresponding range in format :lower - upper)

Returns:

State instance

Throws:

StateException - if numeric values in the label could not be parsed or range's upper bound is smaller than its lower bound

getState

protected static State getState(Node node,
                                String label)

Find a state by given label in the given Node's underlying logic node.

Parameters:

node - Node to get the state from

label - label of the required state

Returns:

state with given label or null if such state does not exist

getLabel

public String getLabel()

Gets the state's label.

Returns:

state's label

getNode

public Node getNode()

Gets the state's Node.

Returns:

state's Node

getLogicState

public uk.co.agena.minerva.model.extendedbn.ExtendedState getLogicState()

Deprecated. Will be affected by module architecture in the future and should not be used.

Returns the underlying API1 State object.

Returns:

underlying logic state

computeLabel

public static String computeLabel(uk.co.agena.minerva.model.extendedbn.ExtendedNode en,
                                  uk.co.agena.minerva.model.extendedbn.ExtendedState es)

Computes a label for a logical state.
Returns a range if the node is not Ranked and the state has an associated range. The range is in format: lower - upper.
Otherwise returns state short name.

Parameters:

en - node containing the state

es - logical state

Returns:

computed node label

setLogicState

protected void setLogicState(uk.co.agena.minerva.model.extendedbn.ExtendedState logicState)

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

Parameters:

logicState - the logical state

toString

public String toString()

Overrides:

toString in class Object