APIModeling (Bayesia Engine Javadoc)

java.lang.Object
- com.bayesia.api.APIModeling

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class APIModeling
extends java.lang.Object
implements java.io.Closeable
```
The class APIModeling is used to create bayesian networks. The bayesian network is loaded from an xbl file. This format is generated by BayesiaLab from Bayesia.
It allows creating dicrete or continuous (label or interval) nodes, constraint, decision and utility nodes as well as function nodes.
It allows also using temporal relationships between chance nodes and a time counter that is very useful to describe a time-dependent node.
It provides methods to create and remove arcs and nodes, to set the conditional probability tables, the decision tables and the utility tables. You can also generate automatically these tables by creating formulas. The creation of formulas is described in a specification document.
The created network can be saved to a file with the xbl format used by BayesiaLab and can be exported through the BayesianNetworkTransferHandler interface in order to be used directly with the APIModeling.
All the methods of this class can throw an instance of IllegalOperationException which is a subclass of RuntimeException so you can avoid to catch them.

Version:

4.2

Author:

Bayesia S.A.S.

Constructor Summary

Constructors
Constructor and Description
`APIModeling(BayesianNetworkTransferHandler networkHandler, java.lang.String licenseKey)` Create a new `APIModeling` with the network stored in the specified `BayesianNetworkTransferHandler`.
`APIModeling(BayesianNetworkTransferHandler networkHandler, java.lang.String licenseServerHost, int licenseServerPort, java.lang.String userName, java.lang.String password, java.lang.String account)` Create a new `APIModeling` with the network stored in the specified `BayesianNetworkTransferHandler`.
`APIModeling(java.io.InputStream stream, java.lang.String licenseKey)` Creates a new `APIModeling` with the network read from the specified InputStream.
`APIModeling(java.io.InputStream stream, java.lang.String licenseServerHost, int licenseServerPort, java.lang.String userName, java.lang.String password, java.lang.String account)` Creates a new `APIModeling` with the network read from the specified InputStream.
`APIModeling(java.lang.String licenseKey)` Create a new `APIModeling` with an empty bayesian network named new.xbl.
`APIModeling(java.lang.String licenseServerHost, int licenseServerPort, java.lang.String userName, java.lang.String password, java.lang.String account)` Create a new `APIModeling` with an empty bayesian network named new.xbl.
`APIModeling(java.lang.String fileName, java.lang.String licenseKey)` Create a new `APIModeling` with the network stored in the specified file.
`APIModeling(java.lang.String fileName, java.lang.String licenseServerHost, int licenseServerPort, java.lang.String userName, java.lang.String password, java.lang.String account)` Create a new `APIModeling` with the network stored in the specified file.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addArc(java.lang.String nodeName1, java.lang.String nodeName2)` Tries to add an arc from `nodeName1` to `nodeName2`.
`void`	`addBooleanConstant(java.lang.String constantName, boolean value)` Adds a constant with the given name, with a BOOLEAN type and a `boolean` value.
`void`	`addChanceIntervalNode(java.lang.String nodeName, java.lang.String[] states, double[][] intervals)` Deprecated. As of release 3.1, replaced by `addIntervalNode(String, String[], double[][])` Creates a new continuous (interval) chance node with the specified states and the specified limits for each interval and add it to the network. The number of intervals is equal to the number of states. The intervals are given in an array containing, for each one, an array storing the minimum and the maximum of this interval. The intervals are contiguous, i.e. the maximum of an interval is equal to the minimum of the following interval. Its conditional probability table is automatically generated and initialized with default probabilities. Its name must not exist in the network and must not be "t". "t" is a reserved name for the time counter.
`void`	`addChanceLabelNode(java.lang.String nodeName, java.lang.String[] states)` Deprecated. As of release 3.1, replaced by `addLabelNode(String, String[])` Creates a new discrete chance node with the specified states and add it to the network. Its conditional probability table is automatically generated and initialized with default probabilities. Its name must not exist in the network and must not be "t". "t" is a reserved name for the time counter.
`void`	`addClassToNode(java.lang.String className, java.lang.String nodeName)` Add a class named `className` to the specified node.
`void`	`addConstraintNode(java.lang.String nodeName)` Adds a constraint node with two boolean states.
`void`	`addDecisionIntervalNode(java.lang.String nodeName, java.lang.String[] decisionNames, double[][] intervals)` Adds a new continuous (interval) decision node with the specified names for the decisions and the specified intervals.
`void`	`addDecisionLabelNode(java.lang.String nodeName, java.lang.String[] decisionNames)` Add a new discrete decision node with the specified names for the decisions.
`void`	`addFunctionNode(java.lang.String nodeName)` Adds a new function node to the network.
`void`	`addIntConstant(java.lang.String constantName, int value)` Adds a constant with the given name, with a INTEGER type and a `int` value.
`void`	`addIntervalNode(java.lang.String nodeName, java.lang.String[] states, double[][] intervals)` Creates a new continuous (interval) node with the specified states and the specified limits for each interval and add it to the network.
`void`	`addLabelNode(java.lang.String nodeName, java.lang.String[] states)` Creates a new discrete node with the specified states and add it to the network.
`void`	`addRealConstant(java.lang.String constantName, double value)` Adds a constant with the given name, with a REAL type and a `double` value.
`void`	`addStringConstant(java.lang.String constantName, java.lang.String value)` Adds a constant with the given name, with a STRING type and a `String` value.
`boolean`	`addTemporalArc(java.lang.String nodeName1, java.lang.String nodeName2)` Tries to add a temporal arc from `nodeName1` to `nodeName2`.
`void`	`addUtilityNode(java.lang.String nodeName)` Adds a new utility node to the network.
`void`	`arrangeNodePositions()` Changes the positions of the nodes in order to place them on a rectangular grid separated by 100.
`void`	`close()` Method used to close the current instance of `APIModeling`.
`BayesianNetworkTransferHandler`	`exportNetwork(java.lang.String networkName)` Exports the created network with the specified name into a `BayesianNetworkTransferHandler` in order to used it with the `APIModeling` for example.
`java.lang.String`	`getArcComment(java.lang.String nodeName1, java.lang.String nodeName2)` Return the html comment associated to the arc between the nodes named `nodeName1` and `nodeName2`.
`int`	`getArcOrientationBetween(java.lang.String nodeName1, java.lang.String nodeName2)` Returns the orientation of the arc between `nodeName1` and `nodeName2`.
`java.lang.String`	`getArcStringComment(java.lang.String nodeName1, java.lang.String nodeName2)` Return the comment string associated to the arc between the nodes named `nodeName1` and `nodeName2`.
`ResizableIcon`	`getBackgroundImage()` Gets the image associated to the network.
`java.lang.String[]`	`getChanceNodeNames()` Deprecated. As of release 3.1, removed Return an array containing the name of the chance nodes in the network
`int`	`getChanceNodeNumber()` Deprecated. As of release 3.1, removed Return the number of chance nodes in the network
`java.lang.String[]`	`getChildren(java.lang.String nodeName)` Returns the name of the children of the specified node
`java.lang.String[]`	`getClasses()` Returns an array containing the name of the classes declared in the network.
`java.lang.String[]`	`getClassNodes(java.lang.String className)` Returns an array containing the list of the node belonging to the given class.
`java.lang.String`	`getComment()` Return the html comment associated to the network.
`double[]`	`getConditionalProbabilityTable(java.lang.String nodeName)` Gets the conditional probability table for the specified node.
`boolean`	`getConstantBooleanValue(java.lang.String constantName)` Returns the `boolean` value of the specified BOOLEAN constant.
`int`	`getConstantIntValue(java.lang.String constantName)` Returns the `int` value of the specified INTEGER constant.
`java.lang.String[]`	`getConstantNames()` Retrieves the list of the constants by its names present in the network.
`double`	`getConstantRealValue(java.lang.String constantName)` Returns the `double` value of the specified REAL constant.
`java.lang.String`	`getConstantStringValue(java.lang.String constantName)` Returns the `String` value of the specified STRING constant.
`java.lang.String[]`	`getConstraintNodeNames()` Returns the list of the names of constraint nodes.
`int`	`getConstraintNodeNumber()` Return the number of constraint nodes in the network
`java.lang.String[]`	`getContinuousNodeNames()` Returns the list of the names of simple continuous nodes (neither discrete nor constraint nor decision nor utility nor function).
`int`	`getContinuousNodeNumber()` Return the number of standard continuous nodes in the network
`java.lang.String[]`	`getDecisionNodeNames()` Returns the list of the names of decision nodes.
`int`	`getDecisionNodeNumber()` Return the number of decision nodes in the network
`double[]`	`getDecisionTable(java.lang.String nodeName)` Gets the decision table for the specified node.
`java.lang.String[]`	`getDiscreteNodeNames()` Returns the list of the names of simple discrete nodes (neither interval nor constraint nor decision nor utility nor function).
`int`	`getDiscreteNodeNumber()` Return the number of standard discrete nodes in the network
`int`	`getExcludedNodeNumber()` Return the number of excluded nodes in the network.
`java.lang.String`	`getFormula(java.lang.String nodeName)` Returns the formula associated to the node as `String`.
`long`	`getFormulaFixedSeed(java.lang.String nodeName)` Returns the fixed seed used by the random number generator of the formula.
`int`	`getFormulaSampleNumber(java.lang.String nodeName)` Returns the number of samples the formula uses to evaluate the probabilities or the decisions for an interval node.
`int`	`getFormulaSmoothingPower(java.lang.String nodeName)` Returns the smoothing power of the formula of the specified node.
`java.lang.String[]`	`getFunctionNodeNames()` Returns the list of the names of function nodes.
`int`	`getFunctionNodeNumber()` Return the number of function nodes in the network
`double[][]`	`getIntervals(java.lang.String nodeName)` Returns an array containing the minimum and the maximum of each interval of the node as doubles.
`int[]`	`getIntValues(java.lang.String nodeName)` Returns an array containing the states of the node as integers if the node is an integer node.
`java.lang.String`	`getName()` Return the name of the loaded network.
`java.lang.String[]`	`getNodeClasses(java.lang.String nodeName)` Returns the classes of which the given node is associated.
`java.awt.Color`	`getNodeColor(java.lang.String nodeName)` Returns the `Color` associated to the node or null if there is no associated color.
`java.lang.String`	`getNodeComment(java.lang.String nodeName)` Return the html comment associated to the specified node
`double`	`getNodeCost(java.lang.String nodeName)` Returns the cost associated to the node or null if there is no cost.
`short`	`getNodeFilteredState(java.lang.String nodeName)` Returns the index of the node's filtered state.
`ResizableIcon`	`getNodeImage(java.lang.String nodeName)` Gets the image as an instance of `ResizableIcon` associated to the node or null if there is no associated image.
`java.lang.String`	`getNodeLongName(java.lang.String nodeName)` Return the long name associated to the specified node or null if there is no long name
`java.lang.String[]`	`getNodeNames()` Return an array containing the name of the nodes in the network
`int`	`getNodeNumber()` Return the number of not excuded nodes in the network.
`java.awt.geom.Point2D`	`getNodePosition(java.lang.String nodeName)` Returns the position of the center of the node as a point with double precision.
`java.lang.Integer`	`getNodeStateVirtualNumber(java.lang.String nodeName)` Returns the state virtual number of the specified node or null if there is no specified virtual state number.
`java.lang.String`	`getNodeStringComment(java.lang.String nodeName)` Return the comment string associated to the specified node
`double`	`getNodeStructuralCoefficient(java.lang.String nodeName)` Returns the value of the node's structural coefficient used for learning.
`java.lang.Integer`	`getNodeTemporalIndex(java.lang.String nodeName)` Resturn the temporal index associated to the chance node or null if there is no temporal index.
`java.lang.String[]`	`getParents(java.lang.String nodeName)` Returns the name of the parents of the specified node
`double[]`	`getRealValues(java.lang.String nodeName)` Returns an array containing the states of the node as doubles if the node is a node with real numberts as values.
`java.lang.String[]`	`getSortedChanceNodeNames(APIUtils.NODE_SORTING_METHOD sortingMethod, boolean increase)` Deprecated. As of release 3.1, replaced by `sortNodeNames(String[], APIUtils.NODE_SORTING_METHOD, boolean)` Return an array containing the name of the chance nodes in the network sorted according to the `APIUtils.NODE_SORTING_METHOD`
`java.lang.String[]`	`getSortedFunctionNodeNames(APIUtils.NODE_SORTING_METHOD sortingMethod, boolean increase)` Deprecated. As of release 3.1, replaced by `sortNodeNames(String[], APIUtils.NODE_SORTING_METHOD, boolean)` Return an array containing the name of the function nodes in the network sorted according to the `APIUtils.NODE_SORTING_METHOD`
`java.lang.String[]`	`getSortedNodeNames(APIUtils.NODE_SORTING_METHOD sortingMethod, boolean increase)` Deprecated. As of release 3.1, replaced by `sortNodeNames(String[], APIUtils.NODE_SORTING_METHOD, boolean)` Return an array containing the name of the nodes in the network sorted according to the `APIUtils.NODE_SORTING_METHOD`
`java.lang.String[]`	`getStandardNodeNames()` Returns the list of the names of standard chance nodes (neither constraint nor decision nor utility nor function).
`int`	`getStandardNodeNumber()` Return the number of standard nodes in the network
`int`	`getStateCount(java.lang.String nodeName)` Returns the number of states of the specified node.
`java.lang.String`	`getStateLongNameAt(java.lang.String nodeName, int state)` Returns the long names of a given state for a given node.
`java.lang.String[]`	`getStateLongNames(java.lang.String nodeName)` Returns an array of `String` containing the long name for each state of the specified node.
`java.lang.Double`	`getStateValueAt(java.lang.String nodeName, int state)` Returns the value associated to the given state of the given node.
`java.lang.Double[]`	`getStateValues(java.lang.String nodeName)` Returns an array of `Double` containing the values associated to each state of the given node.
`java.lang.String`	`getStringComment()` Return the comment as string associated to the network.
`java.lang.String[]`	`getStringValues(java.lang.String nodeName)` Returns an array containing the states of the node as `String`.
`java.lang.Double`	`getStructuralCoefficient()` Returns the global structural coefficient of the network used for learning.
`java.lang.String[]`	`getUtilityNodeNames()` Returns the list of the names of utility nodes.
`int`	`getUtilityNodeNumber()` Return the number of utility nodes in the network
`double[]`	`getUtilityTable(java.lang.String nodeName)` Gets the utility table for the specified decision node.
`boolean`	`hasArcBetween(java.lang.String nodeName1, java.lang.String nodeName2)` Tests if there is an arc between the specified nodes
`boolean`	`hasTemporalArcBetween(java.lang.String nodeName1, java.lang.String nodeName2)` Tests if there is a temporal arc between the specified nodes
`boolean`	`isBoolean(java.lang.String nodeName)` Tests if the specified node is boolean, i.e. its values are equivalent to true and false.
`boolean`	`isBooleanConstant(java.lang.String constantName)` Tests if the specified constant is a BOOLEAN constant.
`boolean`	`isChildOf(java.lang.String nodeName1, java.lang.String nodeName2)` Tests if there is an arc from `nodeName2` to `nodeName1`
`boolean`	`isConstraint(java.lang.String nodeName)` Tests if the node is a constraint node.
`boolean`	`isDecision(java.lang.String nodeName)` Tests if the node is a decision node.
`boolean`	`isFormulaProbabilist(java.lang.String nodeName)` Test if the formula of the specified node is probabilist or not.
`boolean`	`isFormulaUseFixedSeed(java.lang.String nodeName)` Returns true if the formula use a fixed seed, false otherwise.
`boolean`	`isFunction(java.lang.String nodeName)` Tests if the node is a function node.
`boolean`	`isIntConstant(java.lang.String constantName)` Tests if the specified constant is an INTEGER constant.
`boolean`	`isInteger(java.lang.String nodeName)` Tests if all the values of the specified node are integers.
`boolean`	`isInterval(java.lang.String nodeName)` Tests if the node is described by a list of consecutives intervals.
`boolean`	`isNodeExcluded(java.lang.String nodeName)` Returns the exclusion property of the node.
`boolean`	`isParentOf(java.lang.String nodeName1, java.lang.String nodeName2)` Tests if there is an arc from `nodeName1` to `nodeName2`
`boolean`	`isReal(java.lang.String nodeName)` Tests if all the values of the specified node are reals.
`boolean`	`isRealConstant(java.lang.String constantName)` Tests if the specified constant is a REAL constant.
`boolean`	`isStringConstant(java.lang.String constantName)` Tests if the specified constant is a STRING constant.
`boolean`	`isTemporal()` Tests if the network is temporal.
`boolean`	`isTimeUsed()` Returns true if the time is used in the network.
`boolean`	`isUtility(java.lang.String nodeName)` Tests if the node is a utility node.
`void`	`removeArc(java.lang.String nodeName1, java.lang.String nodeName2)` Removes the arc between the specified nodes.
`void`	`removeClassFromNode(java.lang.String className, java.lang.String nodeName)` Removes the specified class from the given node.
`void`	`removeConstant(java.lang.String constantName)` Removes the specified constant from the network.
`void`	`removeNode(java.lang.String nodeName)` Removes the specified node.
`void`	`save(java.io.OutputStream stream)` Saves the created network into the specified `OutputStream`.
`void`	`save(java.lang.String path)` Saves the created network to the file specified by the given path.
`void`	`setArcComment(java.lang.String nodeName1, java.lang.String nodeName2, java.lang.String comment)` Set the comment associated to the arc between the nodes named `nodeName1` and `nodeName2`.
`void`	`setBackgroundImage(ResizableIcon image)` Sets the image associated to the network.
`void`	`setClassFunctionNodeBooleanFormatter(java.lang.String className, BooleanFormatter formatter)` Sets the Boolean formatter to each not excluded function node of the given class.
`void`	`setClassFunctionNodeNumberFormatter(java.lang.String className, NumberFormatter formatter)` Sets the Number formatter to each not excluded function node of the given class.
`void`	`setClassFunctionNodeStringFormatter(java.lang.String className, StringFormatter formatter)` Sets the String formatter to each not excluded function node of the given class.
`void`	`setClassNodeColor(java.lang.String className, java.awt.Color color)` Sets the color for each node of the given class.
`void`	`setClassNodeCost(java.lang.String className, java.lang.Double cost)` Sets a cost to each not excluded node of the given class.
`void`	`setClassNodeExcluded(java.lang.String className, boolean excluded)` Indicates if each node of the the given class will be excluded or not from the structural learning.
`void`	`setClassNodeImage(java.lang.String className, ResizableIcon image)` Sets an image to each node of the given class.
`void`	`setClassNodeStateVirtualNumber(java.lang.String className, java.lang.Double coefficient)` Sets the structural coefficient to each not excluded node of the given class.
`void`	`setClassNodeStateVirtualNumber(java.lang.String className, java.lang.Integer stateVirtualNumber)` Sets the state virtual number to each not excluded node of the given class.
`void`	`setClassNodeTemporalIndex(java.lang.String className, java.lang.Integer temporalIndex)` Sets a temporal index to each not excluded node of the given class.
`void`	`setComment(java.lang.String comment)` Sets the comment associated to the network.
`void`	`setConditionalProbabilityTable(java.lang.String nodeName, double[] table)` Sets the conditional probability table for the specified node.
`void`	`setDecisionTable(java.lang.String nodeName, double[] table)` Sets the decision table for the specified node.
`void`	`setFormula(java.lang.String nodeName, java.lang.String formula, boolean probabilist, int sampleNumber, int smoothingPower, boolean fixedSeed, long seed, boolean intervalExtended)` Sets the formula describing the conditional probability table for the given node.
`void`	`setFunctionNodeBooleanFormatter(java.lang.String nodeName, BooleanFormatter formatter)` Sets the Boolean formatter of the function node.
`void`	`setFunctionNodeNumberFormatter(java.lang.String nodeName, NumberFormatter formatter)` Sets the Number formatter of the function node.
`void`	`setFunctionNodeStringFormatter(java.lang.String nodeName, StringFormatter formatter)` Sets the String formatter of the function node.
`void`	`setNodeColor(java.lang.String nodeName, java.awt.Color color)` Sets the color of the node.
`void`	`setNodeComment(java.lang.String nodeName, java.lang.String comment)` Set the comment associated to the specified node.
`void`	`setNodeCost(java.lang.String nodeName, java.lang.Double cost)` Sets the cost of the node to the given `double` value.
`void`	`setNodeExcluded(java.lang.String nodeName, boolean excluded)` Indicates if the given node will be excluded or not from the structural learning.
`void`	`setNodeFilteredState(java.lang.String nodeName, short index)` Sets the node's filtered state.
`void`	`setNodeImage(java.lang.String nodeName, ResizableIcon image)` Sets an image to the node.
`void`	`setNodeLongName(java.lang.String nodeName, java.lang.String longName)` Set the long name associated to the specified node.
`void`	`setNodePosition(java.lang.String nodeName, double x, double y)` Sets the position of the center of the node in double coordinates.
`void`	`setNodeStateVirtualNumber(java.lang.String nodeName, java.lang.Integer stateVirtualNumber)` Sets the state virtual number of the node to the given `Integer` value.
`void`	`setNodeStructuralCoefficient(java.lang.String nodeName, java.lang.Double coefficient)` Sets the structural coefficient used for learning to the given `Double` value.
`void`	`setNodeTemporalIndex(java.lang.String nodeName, java.lang.Integer temporalIndex)` Sets the temporal index of the node to the given value.
`void`	`setStateLongNameAt(java.lang.String nodeName, java.lang.String longName, int state)` Sets the long name of the given state for the given node.
`void`	`setStateLongNames(java.lang.String nodeName, java.lang.String[] longNames)` Sets the long names for the states of the specified node.
`void`	`setStateValueAt(java.lang.String nodeName, java.lang.Double stateValue, int state)` Sets a value to the given state of the given node.
`void`	`setStateValues(java.lang.String nodeName, java.lang.Double[] stateValues)` Sets the values for each state of the given node.
`void`	`setStructuralCoefficient(java.lang.Double coefficient)` Sets the global structural coefficient of the network for learning.
`void`	`setTimeUsed(boolean b)` Specifies we want to use the time counter in the network.
`void`	`setUtilityTable(java.lang.String nodeName, double[] table)` Set the utility table for the specified decision node.
`void`	`sortNodeNames(java.lang.String[] nodeNames, APIUtils.NODE_SORTING_METHOD sortingMethod, boolean increase)` Sort the given array containing the name of the nodes in the network sorted according to the `APIUtils.NODE_SORTING_METHOD`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - APIModeling
```
public APIModeling(java.lang.String licenseKey)
```
    Create a new APIModeling with an empty bayesian network named new.xbl. You must provide a valid license key for modeling.
    
    Parameters:
    
    licenseKey - the key of the license.
  - APIModeling
```
public APIModeling(java.lang.String licenseServerHost,
                   int licenseServerPort,
                   java.lang.String userName,
                   java.lang.String password,
                   java.lang.String account)
```
    Create a new APIModeling with an empty bayesian network named new.xbl. You must provide the host and the port of the license server. You must provide also the user name and the password of an access added to the license. This access must be associated to this license on the LicenseServer by using the Management Console of BayesiaLicenseServer. Use this constructor if you use a license server.
    
    Parameters:
    
    licenseServerHost - the host of the license server.
    
    licenseServerPort - the port of the license server.
    
    userName - the user name corresponding to an existing access added to the license on the license server. Cannot be null.
    
    password - the password corresponding to the access added to the license on the license server. Cannot be null.
    
    account - the account corresponding to the license. Cannot be null, but can be set as empty String on dedicated BLS.
  - APIModeling
```
public APIModeling(java.lang.String fileName,
                   java.lang.String licenseKey)
```
    Create a new APIModeling with the network stored in the specified file. You must provide a valid license key for modeling.
    
    Parameters:
    
    fileName - the name of the xbl file containing the network
    
    licenseKey - the key of the license.
  - APIModeling
```
public APIModeling(java.io.InputStream stream,
                   java.lang.String licenseKey)
```
    Creates a new APIModeling with the network read from the specified InputStream. You must provide a valid licence key for modeling.
    
    Parameters:
    
    stream - the stream of the xbl file containing the network
    
    licenseKey - the key of the licence.
  - APIModeling
```
public APIModeling(java.lang.String fileName,
                   java.lang.String licenseServerHost,
                   int licenseServerPort,
                   java.lang.String userName,
                   java.lang.String password,
                   java.lang.String account)
```
    Create a new APIModeling with the network stored in the specified file. You must provide the host and the port of the license server. You must provide also the user name and the password of an access added to the license. This access must be associated to this license on the LicenseServer by using the Management Console of BayesiaLicenseServer. Use this constructor if you use a license server.
    
    Parameters:
    
    fileName - the name of the xbl file containing the network
    
    licenseServerHost - the host of the license server.
    
    licenseServerPort - the port of the license server.
    
    userName - the user name corresponding to an existing access added to the license on the license server. Cannot be null.
    
    password - the passord corresponding to the access added to the license on the license server. Cannot be null.
    
    account - the account corresponding to the license. Cannot be null, but can be set as empty String on dedicated BLS.
  - APIModeling
```
public APIModeling(java.io.InputStream stream,
                   java.lang.String licenseServerHost,
                   int licenseServerPort,
                   java.lang.String userName,
                   java.lang.String password,
                   java.lang.String account)
```
    Creates a new APIModeling with the network read from the specified InputStream. You must provide the host and the port of the license server. You must provide also the user name and the password of an access added to the license. This access must be associated to this license on the LicenseServer by using the Management Console of BayesiaLicenseServer. Use this constructor if you use a license server.
    
    Parameters:
    
    stream - the stream of the xbl file containing the network
    
    licenseServerHost - the host of the license server.
    
    licenseServerPort - the port of the license server.
    
    userName - the user name corresponding to an existing access added to the license on the license server. Cannot be null.
    
    password - the passord corresponding to the access added to the license on the license server. Cannot be null.
    
    account - the account corresponding to the license. Cannot be null, but can be set as empty String on dedicated BLS.
  - APIModeling
```
public APIModeling(BayesianNetworkTransferHandler networkHandler,
                   java.lang.String licenseKey)
```
    Create a new APIModeling with the network stored in the specified BayesianNetworkTransferHandler. You must provide a valid license key for modeling.
    
    Parameters:
    
    networkHandler - the transfer handler containing the network
    
    licenseKey - the key of the license.
  - APIModeling
```
public APIModeling(BayesianNetworkTransferHandler networkHandler,
                   java.lang.String licenseServerHost,
                   int licenseServerPort,
                   java.lang.String userName,
                   java.lang.String password,
                   java.lang.String account)
```
    Create a new APIModeling with the network stored in the specified BayesianNetworkTransferHandler. You must provide the host and the port of the license server. You must provide also the user name and the password of an access added to the license. This access must be associated to this license on the LicenseServer by using the Management Console of BayesiaLicenseServer. Use this constructor if you use a license server.
    
    Parameters:
    
    networkHandler - the transfer handler containing the network
    
    licenseServerHost - the host of the license server.
    
    licenseServerPort - the port of the license server.
    
    userName - the user name corresponding to an existing access added to the license on the license server. Cannot be null.
    
    password - the passord corresponding to the access added to the license on the license server. Cannot be null.
    
    account - the account corresponding to the license. Cannot be null, but can be set as empty String on dedicated BLS.
- Method Detail
  - getName
```
public final java.lang.String getName()
```
    Return the name of the loaded network.
    
    Returns:
    
    the name of the network
  - getNodeNames
```
public final java.lang.String[] getNodeNames()
```
    Return an array containing the name of the nodes in the network
    
    Returns:
    
    the node names
  - getChanceNodeNames
```
@Deprecated
public final java.lang.String[] getChanceNodeNames()
```
    Deprecated. As of release 3.1, removed Return an array containing the name of the chance nodes in the network
    
    Returns:
    
    the chance node names
  - getStandardNodeNames
```
public final java.lang.String[] getStandardNodeNames()
```
    Returns the list of the names of standard chance nodes (neither constraint nor decision nor utility nor function).
    
    Returns:
    
    the standard chance node names
  - getDiscreteNodeNames
```
public final java.lang.String[] getDiscreteNodeNames()
```
    Returns the list of the names of simple discrete nodes (neither interval nor constraint nor decision nor utility nor function).
    
    Returns:
    
    the discrete node names
  - getContinuousNodeNames
```
public final java.lang.String[] getContinuousNodeNames()
```
    Returns the list of the names of simple continuous nodes (neither discrete nor constraint nor decision nor utility nor function).
    
    Returns:
    
    the continuous node names
  - getConstraintNodeNames
```
public final java.lang.String[] getConstraintNodeNames()
```
    Returns the list of the names of constraint nodes.
    
    Returns:
    
    the constraint node names
  - getDecisionNodeNames
```
public final java.lang.String[] getDecisionNodeNames()
```
    Returns the list of the names of decision nodes.
    
    Returns:
    
    the decision node names
  - getUtilityNodeNames
```
public final java.lang.String[] getUtilityNodeNames()
```
    Returns the list of the names of utility nodes.
    
    Returns:
    
    the utility node names
  - getFunctionNodeNames
```
public final java.lang.String[] getFunctionNodeNames()
```
    Returns the list of the names of function nodes.
    
    Returns:
    
    the function node names
  - sortNodeNames
```
public final void sortNodeNames(java.lang.String[] nodeNames,
                                APIUtils.NODE_SORTING_METHOD sortingMethod,
                                boolean increase)
```
    Sort the given array containing the name of the nodes in the network sorted according to the APIUtils.NODE_SORTING_METHOD
    
    Parameters:
    
    nodeNames - the node names to sort
    
    sortingMethod - the sorting method
    
    increase - true if you want an increasing order, false if you want a decreasing order
  - getSortedNodeNames
```
@Deprecated
public final java.lang.String[] getSortedNodeNames(APIUtils.NODE_SORTING_METHOD sortingMethod,
                                                                boolean increase)
```
    Deprecated. As of release 3.1, replaced by sortNodeNames(String[], APIUtils.NODE_SORTING_METHOD, boolean) Return an array containing the name of the nodes in the network sorted according to the APIUtils.NODE_SORTING_METHOD
    
    Parameters:
    
    sortingMethod - the sorting method
    
    increase - true if you want an increasing order, false if you want a decreasing order
    
    Returns:
    
    the sorted node names
  - getSortedChanceNodeNames
```
@Deprecated
public final java.lang.String[] getSortedChanceNodeNames(APIUtils.NODE_SORTING_METHOD sortingMethod,
                                                                      boolean increase)
```
    Deprecated. As of release 3.1, replaced by sortNodeNames(String[], APIUtils.NODE_SORTING_METHOD, boolean) Return an array containing the name of the chance nodes in the network sorted according to the APIUtils.NODE_SORTING_METHOD
    
    Parameters:
    
    sortingMethod - the sorting method
    
    increase - true if you want an increasing order, false if you want a decreasing order
    
    Returns:
    
    the sorted chance node names
  - getSortedFunctionNodeNames
```
@Deprecated
public final java.lang.String[] getSortedFunctionNodeNames(APIUtils.NODE_SORTING_METHOD sortingMethod,
                                                                        boolean increase)
```
    Deprecated. As of release 3.1, replaced by sortNodeNames(String[], APIUtils.NODE_SORTING_METHOD, boolean) Return an array containing the name of the function nodes in the network sorted according to the APIUtils.NODE_SORTING_METHOD
    
    Parameters:
    
    sortingMethod - the sorting method
    
    increase - true if you want an increasing order, false if you want a decreasing order
    
    Returns:
    
    the sorted function node names
  - getNodeNumber
```
public final int getNodeNumber()
```
    Return the number of not excuded nodes in the network. It is the number of not excluded nodes of any type.
    
    Returns:
    
    the number of all not excluded nodes
  - getChanceNodeNumber
```
@Deprecated
public final int getChanceNodeNumber()
```
    Deprecated. As of release 3.1, removed Return the number of chance nodes in the network
    
    Returns:
    
    the number of chance nodes
  - getStandardNodeNumber
```
public final int getStandardNodeNumber()
```
    Return the number of standard nodes in the network
    
    Returns:
    
    the number of standard nodes
  - getDiscreteNodeNumber
```
public final int getDiscreteNodeNumber()
```
    Return the number of standard discrete nodes in the network
    
    Returns:
    
    the number of standard discrete nodes
  - getContinuousNodeNumber
```
public final int getContinuousNodeNumber()
```
    Return the number of standard continuous nodes in the network
    
    Returns:
    
    the number of standard continuous nodes
  - getConstraintNodeNumber
```
public final int getConstraintNodeNumber()
```
    Return the number of constraint nodes in the network
    
    Returns:
    
    the number of constraint nodes
  - getDecisionNodeNumber
```
public final int getDecisionNodeNumber()
```
    Return the number of decision nodes in the network
    
    Returns:
    
    the number of decision nodes
  - getUtilityNodeNumber
```
public final int getUtilityNodeNumber()
```
    Return the number of utility nodes in the network
    
    Returns:
    
    the number of utility nodes
  - getFunctionNodeNumber
```
public final int getFunctionNodeNumber()
```
    Return the number of function nodes in the network
    
    Returns:
    
    the number of function nodes
  - getExcludedNodeNumber
```
public final int getExcludedNodeNumber()
```
    Return the number of excluded nodes in the network.
    
    Returns:
    
    the number of all excluded nodes
  - getComment
```
public final java.lang.String getComment()
```
    Return the html comment associated to the network.
    
    Returns:
    
    the comment associated to the network.
  - getStringComment
```
public final java.lang.String getStringComment()
```
    Return the comment as string associated to the network.
    
    Returns:
    
    the comment associated to the network.
  - setComment
```
public final void setComment(java.lang.String comment)
```
    Sets the comment associated to the network. The comment can be in html format or a simple string. In this last case, the string is converted into an html format.
    
    Parameters:
    
    comment - the comment associated to the network.
  - getBackgroundImage
```
public final ResizableIcon getBackgroundImage()
```
    Gets the image associated to the network.
    
    Returns:
    
    an instance of ResizableIcon or null if there is no image
    
    See Also:
    
    ResizableIcon
  - setBackgroundImage
```
public final void setBackgroundImage(ResizableIcon image)
```
    Sets the image associated to the network. If the parameter is null, the image is removed from the network.
    
    Parameters:
    
    image - the image associated to the network
    
    See Also:
    
    ResizableIcon, APIUtils.getResizableIcon(BufferedImage), APIUtils.getResizableIcon(java.net.URL)
  - arrangeNodePositions
```
public final void arrangeNodePositions()
```
    Changes the positions of the nodes in order to place them on a rectangular grid separated by 100.
  - getNodeLongName
```
public final java.lang.String getNodeLongName(java.lang.String nodeName)
```
    Return the long name associated to the specified node or null if there is no long name
    
    Parameters:
    
    nodeName - the name of the node we want the long name
    
    Returns:
    
    the long name of the node
  - setNodeLongName
```
public final void setNodeLongName(java.lang.String nodeName,
                                  java.lang.String longName)
```
    Set the long name associated to the specified node. The long name is a simple string or null to remove the previous long name.
    
    Parameters:
    
    nodeName - the name of the node we want to set the long name
    
    longName - the new long name
  - getNodeComment
```
public final java.lang.String getNodeComment(java.lang.String nodeName)
```
    Return the html comment associated to the specified node
    
    Parameters:
    
    nodeName - the name of the node we want the html comment
    
    Returns:
    
    the html comment of the node
  - getNodeStringComment
```
public final java.lang.String getNodeStringComment(java.lang.String nodeName)
```
    Return the comment string associated to the specified node
    
    Parameters:
    
    nodeName - the name of the node we want the comment
    
    Returns:
    
    the html comment of the node converted into a simple string
  - setNodeComment
```
public final void setNodeComment(java.lang.String nodeName,
                                 java.lang.String comment)
```
    Set the comment associated to the specified node. The comment can be in html format or a simple string. In this last case, the string is converted into an html format.
    
    Parameters:
    
    nodeName - the name of the node we want to set the comment
    
    comment - the new comment
  - getArcComment
```
public final java.lang.String getArcComment(java.lang.String nodeName1,
                                            java.lang.String nodeName2)
```
    Return the html comment associated to the arc between the nodes named nodeName1 and nodeName2.
    
    Parameters:
    
    nodeName1 - the name of the first extremity node
    
    nodeName2 - the name of the second extremity node
    
    Returns:
    
    the comment of the arc
  - getArcStringComment
```
public final java.lang.String getArcStringComment(java.lang.String nodeName1,
                                                  java.lang.String nodeName2)
```
    Return the comment string associated to the arc between the nodes named nodeName1 and nodeName2.
    
    Parameters:
    
    nodeName1 - the name of the first extremity node
    
    nodeName2 - the name of the second extremity node
    
    Returns:
    
    the comment of the arc
  - setArcComment
```
public final void setArcComment(java.lang.String nodeName1,
                                java.lang.String nodeName2,
                                java.lang.String comment)
```
    Set the comment associated to the arc between the nodes named nodeName1 and nodeName2. The comment can be in html format or a simple string. In this last case, the string is converted into an html format.
    
    Parameters:
    
    nodeName1 - the name of the first extremity node
    
    nodeName2 - the name of the second extremity node
    
    comment - the new comment of the arc
  - getNodePosition
```
public final java.awt.geom.Point2D getNodePosition(java.lang.String nodeName)
```
    Returns the position of the center of the node as a point with double precision.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the position of the node as a point with double coordinates
  - setNodePosition
```
public final void setNodePosition(java.lang.String nodeName,
                                  double x,
                                  double y)
```
    Sets the position of the center of the node in double coordinates.
    
    Parameters:
    
    nodeName - the name of the node
    
    x - the x position
    
    y - the y position
  - getNodeColor
```
public final java.awt.Color getNodeColor(java.lang.String nodeName)
```
    Returns the Color associated to the node or null if there is no associated color.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an instance of Color or null if no color is associated
  - setNodeColor
```
public final void setNodeColor(java.lang.String nodeName,
                               java.awt.Color color)
```
    Sets the color of the node. If the parameter is null, the node's color is removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    color - the new color of the node
  - setClassNodeColor
```
public final void setClassNodeColor(java.lang.String className,
                                    java.awt.Color color)
```
    Sets the color for each node of the given class. If the parameter is null, the node colors are removed.
    
    Parameters:
    
    className - the name of the class
    
    color - the new color for each node of the class
  - getNodeImage
```
public final ResizableIcon getNodeImage(java.lang.String nodeName)
```
    Gets the image as an instance of ResizableIcon associated to the node or null if there is no associated image.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an instance of ResizableIcon if there is an image or null otherwise
    
    See Also:
    
    ResizableIcon
  - setNodeImage
```
public final void setNodeImage(java.lang.String nodeName,
                               ResizableIcon image)
```
    Sets an image to the node. If the parameter is null, the node's image is removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    image - the new image of the node
    
    See Also:
    
    ResizableIcon, APIUtils.getResizableIcon(BufferedImage), APIUtils.getResizableIcon(java.net.URL)
  - setClassNodeImage
```
public final void setClassNodeImage(java.lang.String className,
                                    ResizableIcon image)
```
    Sets an image to each node of the given class. If the parameter is null, the node images are removed.
    
    Parameters:
    
    className - the name of the class
    
    image - the new image for each node of the class
    
    See Also:
    
    ResizableIcon, APIUtils.getResizableIcon(BufferedImage), APIUtils.getResizableIcon(java.net.URL)
  - getNodeTemporalIndex
```
public final java.lang.Integer getNodeTemporalIndex(java.lang.String nodeName)
```
    Resturn the temporal index associated to the chance node or null if there is no temporal index.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the temporal index of the node
  - setNodeTemporalIndex
```
public final void setNodeTemporalIndex(java.lang.String nodeName,
                                       java.lang.Integer temporalIndex)
```
    Sets the temporal index of the node to the given value. If the parameter is null, the temporal index is removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    temporalIndex - an Integer representing the temporal index of the node or null if there is no temporal index
  - setClassNodeTemporalIndex
```
public final void setClassNodeTemporalIndex(java.lang.String className,
                                            java.lang.Integer temporalIndex)
```
    Sets a temporal index to each not excluded node of the given class. If the parameter is null, the temporal indices are removed.
    
    Parameters:
    
    className - the name of the class
    
    temporalIndex - an Integer representing the temporal index of each node of the class or null if there is no temporal index
  - getNodeCost
```
public final double getNodeCost(java.lang.String nodeName)
```
    Returns the cost associated to the node or null if there is no cost.
    
    Parameters:
    
    nodeName - the node of the name
    
    Returns:
    
    the cost of the node
  - setNodeCost
```
public final void setNodeCost(java.lang.String nodeName,
                              java.lang.Double cost)
```
    Sets the cost of the node to the given double value. It reprensents the cost for an evidence to be set to the node. If the parameter is negative or null, the cost is removed from the node.
    
    Parameters:
    
    nodeName - the name of the node
    
    cost - a double representing the cost of the node or null if there is no cost
  - setClassNodeCost
```
public final void setClassNodeCost(java.lang.String className,
                                   java.lang.Double cost)
```
    Sets a cost to each not excluded node of the given class. If the parameter is negative or null, the costs are removed.
    
    Parameters:
    
    className - the name of the class
    
    cost - a double representing the cost of each node of the class or null if there is no cost
  - getNodeStateVirtualNumber
```
public final java.lang.Integer getNodeStateVirtualNumber(java.lang.String nodeName)
```
    Returns the state virtual number of the specified node or null if there is no specified virtual state number. This property is used during learning instead of the real number of states, if it exists.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the state virtual number associated to the node
  - setNodeStateVirtualNumber
```
public final void setNodeStateVirtualNumber(java.lang.String nodeName,
                                            java.lang.Integer stateVirtualNumber)
```
    Sets the state virtual number of the node to the given Integer value. It represents the number of states used during the learning instead of the real number of state. If the parameter is less than 2 or null, the state virtual number is removed from the node.
    
    Parameters:
    
    nodeName - the name of the node
    
    stateVirtualNumber - an Integer representing the state virtual number of the node or null if there is no state virtual number
  - setClassNodeStateVirtualNumber
```
public final void setClassNodeStateVirtualNumber(java.lang.String className,
                                                 java.lang.Integer stateVirtualNumber)
```
    Sets the state virtual number to each not excluded node of the given class. If the parameter is less than 2 or null, the state virtual number are removed.
    
    Parameters:
    
    className - the name of the class
    
    stateVirtualNumber - an Integer representing the state virtual number of each node of the class or null if there is no state virtual number
  - getNodeStructuralCoefficient
```
public final double getNodeStructuralCoefficient(java.lang.String nodeName)
```
    Returns the value of the node's structural coefficient used for learning. The default value is 1. If the value if less than 1, the learning algorithm can add mode parents to the node. If the value is greater than 1, the learning algorithm will restrict the number of added parents.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the learning structural coefficient associated to this node
  - setNodeStructuralCoefficient
```
public final void setNodeStructuralCoefficient(java.lang.String nodeName,
                                               java.lang.Double coefficient)
```
    Sets the structural coefficient used for learning to the given Double value. It allows the learning algorithm to add parents with less correlation if the values is less than 1 and only parents strongly correlated if the value is greater than 1. If the parameter is negative or null, the structural coefficient is reset to 1.
    
    Parameters:
    
    nodeName - the name of the node
    
    coefficient - a Double representing the learning structural of the node
  - setClassNodeStateVirtualNumber
```
public final void setClassNodeStateVirtualNumber(java.lang.String className,
                                                 java.lang.Double coefficient)
```
    Sets the structural coefficient to each not excluded node of the given class. If the parameter is negative or null, the structural coefficients are reset to 1.
    
    Parameters:
    
    className - the name of the class
    
    coefficient - a Double representing the learning structural of each node of the class
  - isNodeExcluded
```
public final boolean isNodeExcluded(java.lang.String nodeName)
```
    Returns the exclusion property of the node. If a node is excluded, it won't be taken into account during structural learning.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    a boolean indicating if the node is excluded from learning
  - setNodeExcluded
```
public final void setNodeExcluded(java.lang.String nodeName,
                                  boolean excluded)
```
    Indicates if the given node will be excluded or not from the structural learning.
    
    Parameters:
    
    nodeName - the name of the node
    
    excluded - the exclusion state of the node
  - setClassNodeExcluded
```
public final void setClassNodeExcluded(java.lang.String className,
                                       boolean excluded)
```
    Indicates if each node of the the given class will be excluded or not from the structural learning.
    
    Parameters:
    
    className - the name of the class
    
    excluded - the exclusion state of the each node of the class
  - getNodeFilteredState
```
public final short getNodeFilteredState(java.lang.String nodeName)
```
    Returns the index of the node's filtered state. If the value equals -1, the node doesn't have any filterd state.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the index of the filtered state or -1 if there is no filtered state
  - setNodeFilteredState
```
public final void setNodeFilteredState(java.lang.String nodeName,
                                       short index)
```
    Sets the node's filtered state. The index must be greater or equal to 0 and less than the number of states. To remove the filtered state, the given index must be -1.
    
    Parameters:
    
    nodeName - the name of the node
    
    index - the index of the filtered state or -1 if there is no filtered state
  - setFunctionNodeStringFormatter
```
public final void setFunctionNodeStringFormatter(java.lang.String nodeName,
                                                 StringFormatter formatter)
```
    Sets the String formatter of the function node. The computed FunctionValue will use this formatter to format the output String. If the parameter is null, the String formatter is removed.
    
    Parameters:
    
    nodeName - the name of the function node
    
    formatter - a StringFormatter allowing to format the output when the computed value is a String.
  - setClassFunctionNodeStringFormatter
```
public final void setClassFunctionNodeStringFormatter(java.lang.String className,
                                                      StringFormatter formatter)
```
    Sets the String formatter to each not excluded function node of the given class. Each computed FunctionValue will use this formatter to format the output String. If the parameter is null, the String formatters are removed.
    
    Parameters:
    
    className - the name of the class
    
    formatter - a StringFormatter allowing to format the output when the computed value is a String.
  - setFunctionNodeNumberFormatter
```
public final void setFunctionNodeNumberFormatter(java.lang.String nodeName,
                                                 NumberFormatter formatter)
```
    Sets the Number formatter of the function node. The computed FunctionValue will use this formatter to format the output Number. If the parameter is null, the Number formatter is removed.
    
    Parameters:
    
    nodeName - the name of the function node
    
    formatter - a NumberFormatter allowing to format the output when the computed value is a Number.
  - setClassFunctionNodeNumberFormatter
```
public final void setClassFunctionNodeNumberFormatter(java.lang.String className,
                                                      NumberFormatter formatter)
```
    Sets the Number formatter to each not excluded function node of the given class. Each computed FunctionValue will use this formatter to format the output Number. If the parameter is null, the Number formatters are removed.
    
    Parameters:
    
    className - the name of the class
    
    formatter - a NumberFormatter allowing to format the output when the computed value is a Number.
  - setFunctionNodeBooleanFormatter
```
public final void setFunctionNodeBooleanFormatter(java.lang.String nodeName,
                                                  BooleanFormatter formatter)
```
    Sets the Boolean formatter of the function node. The computed FunctionValue will use this formatter to format the output Boolean. If the parameter is null, the Boolean formatter is removed.
    
    Parameters:
    
    nodeName - the name of the function node
    
    formatter - a BooleanFormatter allowing to format the output when the computed value is a Boolean.
  - setClassFunctionNodeBooleanFormatter
```
public final void setClassFunctionNodeBooleanFormatter(java.lang.String className,
                                                       BooleanFormatter formatter)
```
    Sets the Boolean formatter to each not excluded function node of the given class. Each computed FunctionValue will use this formatter to format the output Boolean. If the parameter is null, the Boolean formatters are removed.
    
    Parameters:
    
    className - the name of the class
    
    formatter - a BooleanFormatter allowing to format the output when the computed value is a Boolean.
  - isTimeUsed
```
public final boolean isTimeUsed()
```
    Returns true if the time is used in the network.
    
    Returns:
    
    true if the time is used in the network.
    
    See Also:
    
    setTimeUsed(boolean)
  - setTimeUsed
```
public final void setTimeUsed(boolean b)
```
    Specifies we want to use the time counter in the network. It is useful when you need to use it in the formula of a node. When it is set to true, the variable ?t? can be used in formulas as an positive integer variable.
    Warning: Do not forget to set the time to false if it was previously set to true and it is not used in any formula.
    
    Parameters:
    
    b - true if the time should be used, false otherwise.
    
    See Also:
    
    isTimeUsed()
  - getStructuralCoefficient
```
public final java.lang.Double getStructuralCoefficient()
```
    Returns the global structural coefficient of the network used for learning.
    
    Returns:
    
    a Double representing the global structural coefficient of the network
  - setStructuralCoefficient
```
public final void setStructuralCoefficient(java.lang.Double coefficient)
```
    Sets the global structural coefficient of the network for learning. The default value is 1. If the value if less than 1, the learning algorithm can add mode parents to each node, i.e. it increases the global connectivity of the network. If the value is greater than 1, the learning algorithm will restrict the number of parents added to each node, i.e. it reduces the global connectivity of the network. If the paraemter is negative or null, it will be reset to 1.
    
    Parameters:
    
    coefficient - the global structural coefficient of the network
  - getParents
```
public final java.lang.String[] getParents(java.lang.String nodeName)
```
    Returns the name of the parents of the specified node
    
    Parameters:
    
    nodeName - the name of the node we want the parents
    
    Returns:
    
    and array containing the name of the parents
  - getChildren
```
public final java.lang.String[] getChildren(java.lang.String nodeName)
```
    Returns the name of the children of the specified node
    
    Parameters:
    
    nodeName - the name of the node we want the children
    
    Returns:
    
    and array containing the name of the children
  - hasArcBetween
```
public final boolean hasArcBetween(java.lang.String nodeName1,
                                   java.lang.String nodeName2)
```
    Tests if there is an arc between the specified nodes
    
    Parameters:
    
    nodeName1 - the name of one extremity
    
    nodeName2 - the name of the other extremity
    
    Returns:
    
    true if there is an arc between the specified nodes, false otherwise
  - hasTemporalArcBetween
```
public final boolean hasTemporalArcBetween(java.lang.String nodeName1,
                                           java.lang.String nodeName2)
```
    Tests if there is a temporal arc between the specified nodes
    
    Parameters:
    
    nodeName1 - the name of one extremity
    
    nodeName2 - the name of the other extremity
    
    Returns:
    
    true if there is an arc between the specified nodes and this arc is temporal, false otherwise
  - isParentOf
```
public final boolean isParentOf(java.lang.String nodeName1,
                                java.lang.String nodeName2)
```
    Tests if there is an arc from nodeName1 to nodeName2
    
    Parameters:
    
    nodeName1 - the name of the supposed parent
    
    nodeName2 - the name of the supposed child
    
    Returns:
    
    true if nodeName1 is parent of nodeName2
  - isChildOf
```
public final boolean isChildOf(java.lang.String nodeName1,
                               java.lang.String nodeName2)
```
    Tests if there is an arc from nodeName2 to nodeName1
    
    Parameters:
    
    nodeName1 - the name of the supposed child
    
    nodeName2 - the name of the supposed parent
    
    Returns:
    
    true if nodeName1 is child of nodeName2
  - getArcOrientationBetween
```
public final int getArcOrientationBetween(java.lang.String nodeName1,
                                          java.lang.String nodeName2)
```
    Returns the orientation of the arc between nodeName1 and nodeName2. The possible values are : -1 if there is no arc, 0 if there is an arc from nodeName1 to nodeName2 and 1 if there is an arc from nodeName2 to nodeName1
    
    Parameters:
    
    nodeName1 - the name of one extremity
    
    nodeName2 - the name of the other extremity
    
    Returns:
    
    the orientation of the arc between nodeName1 and nodeName2
  - addLabelNode
```
public final void addLabelNode(java.lang.String nodeName,
                               java.lang.String[] states)
```
    Creates a new discrete node with the specified states and add it to the network. Its conditional probability table is automatically generated and initialized with default probabilities. Its name must not exist in the network and must not be "t". "t" is a reserved name for the time counter.
    
    Parameters:
    
    nodeName - the name of the new node.
    
    states - an array containing the name of the states
  - addChanceLabelNode
```
@Deprecated
public final void addChanceLabelNode(java.lang.String nodeName,
                                                  java.lang.String[] states)
```
    Deprecated. As of release 3.1, replaced by addLabelNode(String, String[]) Creates a new discrete chance node with the specified states and add it to the network. Its conditional probability table is automatically generated and initialized with default probabilities. Its name must not exist in the network and must not be "t". "t" is a reserved name for the time counter.
    
    Parameters:
    
    nodeName - the name of the new node.
    
    states - an array containing the name of the states
  - addIntervalNode
```
public final void addIntervalNode(java.lang.String nodeName,
                                  java.lang.String[] states,
                                  double[][] intervals)
```
    Creates a new continuous (interval) node with the specified states and the specified limits for each interval and add it to the network. The number of intervals is equal to the number of states. The intervals are given in an array containing, for each one, an array storing the minimum and the maximum of this interval. The intervals are contiguous, i.e. the maximum of an interval is equal to the minimum of the following interval. Its conditional probability table is automatically generated and initialized with default probabilities. Its name must not exist in the network and must not be "t". "t" is a reserved name for the time counter.
    
    Parameters:
    
    nodeName - the name of the new node.
    
    states - an array containing the name of the states
    
    intervals - an array containing arrays storing the minimum and the maximum of each interval
  - addChanceIntervalNode
```
@Deprecated
public final void addChanceIntervalNode(java.lang.String nodeName,
                                                     java.lang.String[] states,
                                                     double[][] intervals)
```
    Deprecated. As of release 3.1, replaced by addIntervalNode(String, String[], double[][]) Creates a new continuous (interval) chance node with the specified states and the specified limits for each interval and add it to the network. The number of intervals is equal to the number of states. The intervals are given in an array containing, for each one, an array storing the minimum and the maximum of this interval. The intervals are contiguous, i.e. the maximum of an interval is equal to the minimum of the following interval. Its conditional probability table is automatically generated and initialized with default probabilities. Its name must not exist in the network and must not be "t". "t" is a reserved name for the time counter.
    
    Parameters:
    
    nodeName - the name of the new node.
    
    states - an array containing the name of the states
    
    intervals - an array containing arrays storing the minimum and the maximum of each interval
  - addConstraintNode
```
public final void addConstraintNode(java.lang.String nodeName)
```
    Adds a constraint node with two boolean states.
    
    Parameters:
    
    nodeName - the name of the node
  - addUtilityNode
```
public final void addUtilityNode(java.lang.String nodeName)
```
    Adds a new utility node to the network. A utility node cannot have children.
    
    Parameters:
    
    nodeName - the name of the node.
  - addDecisionLabelNode
```
public final void addDecisionLabelNode(java.lang.String nodeName,
                                       java.lang.String[] decisionNames)
```
    Add a new discrete decision node with the specified names for the decisions. The node must have at least two decisions.
    
    Parameters:
    
    nodeName - the name of the node
    
    decisionNames - an array containing the names of the decisions.
  - addDecisionIntervalNode
```
public final void addDecisionIntervalNode(java.lang.String nodeName,
                                          java.lang.String[] decisionNames,
                                          double[][] intervals)
```
    Adds a new continuous (interval) decision node with the specified names for the decisions and the specified intervals. The node must have at least two decisions. The rules for the intervals are the same as in the interval chance node.
    
    Parameters:
    
    nodeName - the name of the node
    
    decisionNames - an array containing the names of the decisions.
    
    intervals - an array containing arrays storing the minimum and the maximum of each interval
  - addFunctionNode
```
public final void addFunctionNode(java.lang.String nodeName)
```
    Adds a new function node to the network. A utility node cannot have children.
    
    Parameters:
    
    nodeName - the name of the node.
  - addArc
```
public final boolean addArc(java.lang.String nodeName1,
                            java.lang.String nodeName2)
```
    Tries to add an arc from nodeName1 to nodeName2. If there is an arc between the two nodes or if the new arc introduces a cycle in the network, the new arc is not added and false is returned.
    
    Parameters:
    
    nodeName1 - the parent node
    
    nodeName2 - the child node
    
    Returns:
    
    true if the arc is added, false otherwise.
  - addTemporalArc
```
public final boolean addTemporalArc(java.lang.String nodeName1,
                                    java.lang.String nodeName2)
```
    Tries to add a temporal arc from nodeName1 to nodeName2. If there is an arc between the two nodes, if the new arc introduces a cycle in the network or if the nodes are not compatible, the new arc is not added and false is returned. The nodes must be compatible, i.e. they must have the same states. A temporal arc can be added from node1 to node2, if and only if there is no temporal arc from any parent of node1 towards node1, there is no temporal arc from node1 towards any child of node1 and there is no temoral arc from node2 towards any child of node2. All these cases throw a IllegalOperationException.
    
    Parameters:
    
    nodeName1 - the parent chance node
    
    nodeName2 - the child chance node
    
    Returns:
    
    true if the arc is added, false otherwise.
  - removeArc
```
public final void removeArc(java.lang.String nodeName1,
                            java.lang.String nodeName2)
```
    Removes the arc between the specified nodes. If the child node have a formula, it is removed. The conditional probability table of the child node is recreated to be consistent with the network.
    
    Parameters:
    
    nodeName1 - the name of one extremity
    
    nodeName2 - the name of the other extremity
  - removeNode
```
public final void removeNode(java.lang.String nodeName)
```
    Removes the specified node. It removes also all the arcs between this node and its parents and the arcs between this node and its children. For each child, the formula is removed and the conditional probability table is recreated to be consistent with the network.
    
    Parameters:
    
    nodeName - the name of the node we want to remove
  - getConditionalProbabilityTable
```
public final double[] getConditionalProbabilityTable(java.lang.String nodeName)
```
    Gets the conditional probability table for the specified node. The node must not be a utility or a decision node. The table contains the probability between 0 and 1 for each combination of the values of the node and the values of its parents.
    The probabilities are enumerated with a specific order; it follows the enumeration of the parents, for examples : Node N with 3 states (Values ni), Parents X with 2 states(xj), Y with 3 modalitites(yk) : the size of the table if 3*2*3 = 18 and the order of the probabilities will be :
    n0x0y0, n0x0y1, n0x0y2, n0x1y0, n0x1y1, n0x1y2, n1x0y0, n1x0y1, n1x0y2, n1x1y0, n1x1y1, n1x1y2, n2x0y0, n2x0y1, n2x0y2, n2x1y0, n2x1y1, n2x1y2
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the conditional probability table of the specified node.
  - setConditionalProbabilityTable
```
public final void setConditionalProbabilityTable(java.lang.String nodeName,
                                                 double[] table)
```
    Sets the conditional probability table for the specified node. The node must not be a utility or a decision node. The table should contains the probability between 0 and 1 for each combination of the values of the node and the values of its parents. If the table is not normalized, it will be automatically normalized.
    The probabilities are enumerated with a specific order; it follows the enumeration of the parents, for examples : Node N with 3 states (Values ni), Parents X with 2 states(xj), Y with 3 modalitites(yk) : the size of the table if 3*2*3 = 18 and the order of the probabilities will be :
    
    n0x0y0, n0x0y1, n0x0y2, n0x1y0, n0x1y1, n0x1y2, n1x0y0, n1x0y1, n1x0y2, n1x1y0, n1x1y1, n1x1y2, n2x0y0, n2x0y1, n2x0y2, n2x1y0, n2x1y1, n2x1y2
    Note: If a formula was previously set for this node, it is removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    table - the new conditional probability table
  - getDecisionTable
```
public final double[] getDecisionTable(java.lang.String nodeName)
```
    Gets the decision table for the specified node. The node must be a decision node. The table contains the decision as double for each combination of the values of the node and the values of its parents.
    The decisions are enumerated with a specific order; it follows the enumeration of the parents, for examples : Node N with 3 states (Values ni), Parents X with 2 states(xj), Y with 3 modalitites(yk) : the size of the table if 3*2*3 = 18 and the order of the decisions will be :
    
    n0x0y0, n0x0y1, n0x0y2, n0x1y0, n0x1y1, n0x1y2, n1x0y0, n1x0y1, n1x0y2, n1x1y0, n1x1y1, n1x1y2, n2x0y0, n2x0y1, n2x0y2, n2x1y0, n2x1y1, n2x1y2
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the decision table of the specified decision node
  - setDecisionTable
```
public final void setDecisionTable(java.lang.String nodeName,
                                   double[] table)
```
    Sets the decision table for the specified node. The node must be a decision node. The table should contains the decision as double for each combination of the values of the node and the values of its parents.
    The decisions are enumerated with a specific order; it follows the enumeration of the parents, for examples : Node N with 3 states (Values ni), Parents X with 2 states(xj), Y with 3 modalitites(yk) : the size of the table if 3*2*3 = 18 and the order of the decisions will be :
    
    n0x0y0, n0x0y1, n0x0y2, n0x1y0, n0x1y1, n0x1y2, n1x0y0, n1x0y1, n1x0y2, n1x1y0, n1x1y1, n1x1y2, n2x0y0, n2x0y1, n2x0y2, n2x1y0, n2x1y1, n2x1y2
    Note: If a formula was previously set for this node, it is removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    table - the new decision table
  - getUtilityTable
```
public final double[] getUtilityTable(java.lang.String nodeName)
```
    Gets the utility table for the specified decision node. The node must be a utility node. The table contains the utilities as double for each combination of the values of its parents.
    The utilities are enumerated with a specific order; it follows the enumeration of the parents, for examples : Parents X with 2 states(xj), Y with 3 modalitites(yk) : the size of the table if 2*3 = 6 and the order of the decisions will be :
    x0y0, x0y1, x0y2, x1y0, x1y1, x1y2
    If there is no parent, the size of the table is 1.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the utility table of the specified utility node
  - setUtilityTable
```
public final void setUtilityTable(java.lang.String nodeName,
                                  double[] table)
```
    Set the utility table for the specified decision node. The node must be a utility node. The table should contains the utilities as double for each combination of the values of its parents.
    The utilities are enumerated with a specific order; it follows the enumeration of the parents, for examples : Parents X with 2 states(xj), Y with 3 modalitites(yk) : the size of the table if 2*3 = 6 and the order of the decisions will be :
    x0y0, x0y1, x0y2, x1y0, x1y1, x1y2
    If there is no parent, the size of the table is 1. Note: If a formula was previously set for this node, it is removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    table - the new utility table
  - setFormula
```
public final void setFormula(java.lang.String nodeName,
                             java.lang.String formula,
                             boolean probabilist,
                             int sampleNumber,
                             int smoothingPower,
                             boolean fixedSeed,
                             long seed,
                             boolean intervalExtended)
```
    Sets the formula describing the conditional probability table for the given node.
    
    Parameters:
    
    nodeName - the name of the node
    
    formula - the formula
    
    probabilist - true if the formula is probabilist, false if is determinist
    
    sampleNumber - > 0 if the node is an interval node.
    
    smoothingPower - > 0 if you want to smooth the probabilities or 0 if you don't want.
    
    fixedSeed - true if you want to use the specified long as seed of the random number generator, false otherwise (random seed used).
    
    seed - ≥ 0 the seed used by the random number generator if the parameter fixedSeed is true. If fixedSeed is false, this parameter is not used.
    
    intervalExtended - true if you yo extends the intervals' limits to the computed values outside the range of the intervals. Otherwise, it produces an exception if a computed value is outside. This parameter is only used by chance interval nodes.
  - isInteger
```
public final boolean isInteger(java.lang.String nodeName)
```
    Tests if all the values of the specified node are integers.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node values are integers, false otherwise
  - isReal
```
public final boolean isReal(java.lang.String nodeName)
```
    Tests if all the values of the specified node are reals.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node values are reals, false otherwise
  - isBoolean
```
public final boolean isBoolean(java.lang.String nodeName)
```
    Tests if the specified node is boolean, i.e. its values are equivalent to true and false.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the is boolean, false otherwise
  - isInterval
```
public final boolean isInterval(java.lang.String nodeName)
```
    Tests if the node is described by a list of consecutives intervals.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node is an interval node, false otherwise
  - isDecision
```
public final boolean isDecision(java.lang.String nodeName)
```
    Tests if the node is a decision node.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node is a decision node, false otherwise
  - isUtility
```
public final boolean isUtility(java.lang.String nodeName)
```
    Tests if the node is a utility node.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node is a utility node, false otherwise
  - isConstraint
```
public final boolean isConstraint(java.lang.String nodeName)
```
    Tests if the node is a constraint node.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node is a constraint node, false otherwise
  - isFunction
```
public final boolean isFunction(java.lang.String nodeName)
```
    Tests if the node is a function node.
    
    Parameters:
    
    nodeName - the name of the tested node
    
    Returns:
    
    true if the node is a function node, false otherwise
  - getClasses
```
public final java.lang.String[] getClasses()
```
    Returns an array containing the name of the classes declared in the network.
    
    Returns:
    
    an array of String representing the list of the classes or null if there is no class in the network
  - getNodeClasses
```
public final java.lang.String[] getNodeClasses(java.lang.String nodeName)
```
    Returns the classes of which the given node is associated.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array of String representing the list of the classes or null if there is no class in which the node is involved
  - getClassNodes
```
public final java.lang.String[] getClassNodes(java.lang.String className)
```
    Returns an array containing the list of the node belonging to the given class.
    
    Parameters:
    
    className - the name of the class
    
    Returns:
    
    an array of String containing the name of the nodes belonging to the class
  - addClassToNode
```
public final void addClassToNode(java.lang.String className,
                                 java.lang.String nodeName)
```
    Add a class named className to the specified node. If the class already exists in the network, it simply added to the node, otherwise a new class is created and added to the node.
    
    Parameters:
    
    className - the name of the class
    
    nodeName - the name of the node
  - removeClassFromNode
```
public final void removeClassFromNode(java.lang.String className,
                                      java.lang.String nodeName)
```
    Removes the specified class from the given node. If no more node belongs to this class, this class is removed from the network.
    
    Parameters:
    
    className - the name of the class
    
    nodeName - the name of the node
  - getStateCount
```
public final int getStateCount(java.lang.String nodeName)
```
    Returns the number of states of the specified node. It can't be used on constraint and utility nodes.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the number of values of the node
  - getStringValues
```
public final java.lang.String[] getStringValues(java.lang.String nodeName)
```
    Returns an array containing the states of the node as String. It can't be used on constraint and utility nodes.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array containing the values of the node.
  - getIntValues
```
public final int[] getIntValues(java.lang.String nodeName)
```
    Returns an array containing the states of the node as integers if the node is an integer node. It can't be used on constraint and utility nodes.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array containing the values of the node.
  - getRealValues
```
public final double[] getRealValues(java.lang.String nodeName)
```
    Returns an array containing the states of the node as doubles if the node is a node with real numberts as values. It can't be used on constraint and utility nodes.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array containing the values of the node.
  - getIntervals
```
public final double[][] getIntervals(java.lang.String nodeName)
```
    Returns an array containing the minimum and the maximum of each interval of the node as doubles. For each interval, the minimum is at index 0 and the maximum at index 1. It can be used only interval nodes.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array containing the minimum and the maximum values of the intervals of the node.
  - getStateLongNames
```
public final java.lang.String[] getStateLongNames(java.lang.String nodeName)
```
    Returns an array of String containing the long name for each state of the specified node. A state can have a long name or not. In this last case, the value will be null.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array of String containing the state long names
  - getStateLongNameAt
```
public final java.lang.String getStateLongNameAt(java.lang.String nodeName,
                                                 int state)
```
    Returns the long names of a given state for a given node. If the state doesn't have a long name, it returns null.
    
    Parameters:
    
    nodeName - the name of the node
    
    state - the index of the state
    
    Returns:
    
    a String representing the long name
  - setStateLongNames
```
public final void setStateLongNames(java.lang.String nodeName,
                                    java.lang.String[] longNames)
```
    Sets the long names for the states of the specified node. The array can be null if you want to remove all the long names.
    
    Parameters:
    
    nodeName - the naem of the nodes
    
    longNames - an array of String containing the long names of the states
  - setStateLongNameAt
```
public final void setStateLongNameAt(java.lang.String nodeName,
                                     java.lang.String longName,
                                     int state)
```
    Sets the long name of the given state for the given node. If the parameter longName is null, the long name corresponding to the state will be removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    longName - the new long name associated to the state
    
    state - the index of the state
  - getStateValues
```
public final java.lang.Double[] getStateValues(java.lang.String nodeName)
```
    Returns an array of Double containing the values associated to each state of the given node. If a state has no value associated, the corresponding Double will be null in the array. If no state has an associated value, null is returned.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    an array of Double or null if there is no values associated to any state
  - getStateValueAt
```
public final java.lang.Double getStateValueAt(java.lang.String nodeName,
                                              int state)
```
    Returns the value associated to the given state of the given node. If the state has no associated value, null is returned.
    
    Parameters:
    
    nodeName - the name of the node
    
    state - the index of the state we want the value
    
    Returns:
    
    a Double representing the associated value
  - setStateValues
```
public final void setStateValues(java.lang.String nodeName,
                                 java.lang.Double[] stateValues)
```
    Sets the values for each state of the given node. If the parameter is null, all the values associated to the states will be removed.
    
    Parameters:
    
    nodeName - the name of the node
    
    stateValues - an array of Double containing the values associated to the node
  - setStateValueAt
```
public final void setStateValueAt(java.lang.String nodeName,
                                  java.lang.Double stateValue,
                                  int state)
```
    Sets a value to the given state of the given node. This value can be null if you want to remove the associated value.
    
    Parameters:
    
    nodeName - the name of the node
    
    stateValue - a Double representing the associated value
    
    state - the index of the concerned state
  - getConstantNames
```
public java.lang.String[] getConstantNames()
```
    Retrieves the list of the constants by its names present in the network. The constants are used as typed variables with a constant value in the formulas.
    
    Returns:
    
    an array containing the names of the constants
  - addStringConstant
```
public void addStringConstant(java.lang.String constantName,
                              java.lang.String value)
```
    Adds a constant with the given name, with a STRING type and a String value.
    Used in formulas by its name, this constant will be interpreted as a STRING.
    
    Parameters:
    
    constantName - the name of the new STRING constant
    
    value - the value of the constant as String
  - isStringConstant
```
public boolean isStringConstant(java.lang.String constantName)
```
    Tests if the specified constant is a STRING constant.
    
    Parameters:
    
    constantName - the name of the constant
    
    Returns:
    
    true if the constant's type is STRING, false otherwise
  - getConstantStringValue
```
public java.lang.String getConstantStringValue(java.lang.String constantName)
```
    Returns the String value of the specified STRING constant.
    
    Parameters:
    
    constantName - the name of the STRING constant
    
    Returns:
    
    the value of the constant as String
  - addIntConstant
```
public void addIntConstant(java.lang.String constantName,
                           int value)
```
    Adds a constant with the given name, with a INTEGER type and a int value.
    Used in formulas by its name, this constant will be interpreted as an INTEGER.
    
    Parameters:
    
    constantName - the name of the new INTEGER constant
    
    value - the value of the constant as int
  - isIntConstant
```
public boolean isIntConstant(java.lang.String constantName)
```
    Tests if the specified constant is an INTEGER constant.
    
    Parameters:
    
    constantName - the name of the constant
    
    Returns:
    
    true if the constant's type is INTEGER, false otherwise
  - getConstantIntValue
```
public int getConstantIntValue(java.lang.String constantName)
```
    Returns the int value of the specified INTEGER constant.
    
    Parameters:
    
    constantName - the name of the INTEGER constant
    
    Returns:
    
    the value of the constant as int
  - addRealConstant
```
public void addRealConstant(java.lang.String constantName,
                            double value)
```
    Adds a constant with the given name, with a REAL type and a double value.
    Used in formulas by its name, this constant will be interpreted as a REAL.
    
    Parameters:
    
    constantName - the name of the new REAL constant
    
    value - the value of the constant as double
  - isRealConstant
```
public boolean isRealConstant(java.lang.String constantName)
```
    Tests if the specified constant is a REAL constant.
    
    Parameters:
    
    constantName - the name of the constant
    
    Returns:
    
    true if the constant's type is REAL, false otherwise
  - getConstantRealValue
```
public double getConstantRealValue(java.lang.String constantName)
```
    Returns the double value of the specified REAL constant.
    
    Parameters:
    
    constantName - the name of the REAL constant
    
    Returns:
    
    the value of the constant as double
  - addBooleanConstant
```
public void addBooleanConstant(java.lang.String constantName,
                               boolean value)
```
    Adds a constant with the given name, with a BOOLEAN type and a boolean value.
    Used in formulas by its name, this constant will be interpreted as a BOOLEAN.
    
    Parameters:
    
    constantName - the name of the new BOOLEAN constant
    
    value - the value of the constant as boolean
  - isBooleanConstant
```
public boolean isBooleanConstant(java.lang.String constantName)
```
    Tests if the specified constant is a BOOLEAN constant.
    
    Parameters:
    
    constantName - the name of the constant
    
    Returns:
    
    true if the constant's type is BOOLEAN, false otherwise
  - getConstantBooleanValue
```
public boolean getConstantBooleanValue(java.lang.String constantName)
```
    Returns the boolean value of the specified BOOLEAN constant.
    
    Parameters:
    
    constantName - the name of the BOOLEAN constant
    
    Returns:
    
    the value of the constant as boolean
  - removeConstant
```
public void removeConstant(java.lang.String constantName)
```
    Removes the specified constant from the network. Be sure to check the formulas if it is used in.
    
    Parameters:
    
    constantName - the name of the removed constant
  - getFormula
```
public final java.lang.String getFormula(java.lang.String nodeName)
```
    Returns the formula associated to the node as String. If the node doesn't have a formula it returns null.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    a String representing the formula of the node
  - isFormulaProbabilist
```
public final boolean isFormulaProbabilist(java.lang.String nodeName)
```
    Test if the formula of the specified node is probabilist or not.
    
    Parameters:
    
    nodeName - the name of the node we want to test the formula
    
    Returns:
    
    true if the formula is probabilist, false if it is determinist
  - getFormulaSampleNumber
```
public final int getFormulaSampleNumber(java.lang.String nodeName)
```
    Returns the number of samples the formula uses to evaluate the probabilities or the decisions for an interval node. For the discrete node, this parameter is not used.
    
    Parameters:
    
    nodeName - the name of the interval node
    
    Returns:
    
    the number of samples used by the formula
  - getFormulaSmoothingPower
```
public final int getFormulaSmoothingPower(java.lang.String nodeName)
```
    Returns the smoothing power of the formula of the specified node. Return 0 if there is no smoothing used in the formula.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the smoothing power used by the formula
  - isFormulaUseFixedSeed
```
public final boolean isFormulaUseFixedSeed(java.lang.String nodeName)
```
    Returns true if the formula use a fixed seed, false otherwise.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    true if the formulat use a fixed seed
  - getFormulaFixedSeed
```
public final long getFormulaFixedSeed(java.lang.String nodeName)
```
    Returns the fixed seed used by the random number generator of the formula. If no fixed seed is used, the returned value is 0.
    
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    the fixed seed used by the formula or 0
  - isTemporal
```
public final boolean isTemporal()
```
    Tests if the network is temporal.
    
    Returns:
    
    true if the network is temporal, false otherwise.
  - save
```
public final void save(java.lang.String path)
```
    Saves the created network to the file specified by the given path. The extension of the file must be xbl. The name of the network is now the name of the file.
    
    Parameters:
    
    path - the path to an xbl file
  - save
```
public final void save(java.io.OutputStream stream)
```
    Saves the created network into the specified OutputStream.
    
    Parameters:
    
    stream - the output stream where the network is saved
  - exportNetwork
```
public final BayesianNetworkTransferHandler exportNetwork(java.lang.String networkName)
```
    Exports the created network with the specified name into a BayesianNetworkTransferHandler in order to used it with the APIModeling for example. The name of the network must be terminated by .xbl
    
    Parameters:
    
    networkName - the new name of the network with the xbl extension
    
    Returns:
    
    a handler containing the network
  - close
```
public final void close()
```
    Method used to close the current instance of APIModeling.
    WARNING: If you use a license server, this method must be called once you don't need the instance anymore. It allows to release the license on the license server.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable

Class APIModeling

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APIModeling

APIModeling

APIModeling

APIModeling

APIModeling

APIModeling

APIModeling

APIModeling

Method Detail

getName

getNodeNames

getChanceNodeNames

getStandardNodeNames

getDiscreteNodeNames

getContinuousNodeNames

getConstraintNodeNames

getDecisionNodeNames

getUtilityNodeNames

getFunctionNodeNames

sortNodeNames

getSortedNodeNames

getSortedChanceNodeNames

getSortedFunctionNodeNames

getNodeNumber

getChanceNodeNumber

getStandardNodeNumber

getDiscreteNodeNumber

getContinuousNodeNumber

getConstraintNodeNumber

getDecisionNodeNumber

getUtilityNodeNumber

getFunctionNodeNumber

getExcludedNodeNumber

getComment

getStringComment

setComment

getBackgroundImage

setBackgroundImage

arrangeNodePositions

getNodeLongName

setNodeLongName

getNodeComment

getNodeStringComment

setNodeComment

getArcComment

getArcStringComment

setArcComment

getNodePosition

setNodePosition

getNodeColor

setNodeColor

setClassNodeColor

getNodeImage

setNodeImage

setClassNodeImage

getNodeTemporalIndex

setNodeTemporalIndex

setClassNodeTemporalIndex

getNodeCost

setNodeCost

setClassNodeCost

getNodeStateVirtualNumber

setNodeStateVirtualNumber

setClassNodeStateVirtualNumber

getNodeStructuralCoefficient

setNodeStructuralCoefficient

setClassNodeStateVirtualNumber

isNodeExcluded

setNodeExcluded

setClassNodeExcluded

getNodeFilteredState

setNodeFilteredState

setFunctionNodeStringFormatter

setClassFunctionNodeStringFormatter

setFunctionNodeNumberFormatter