oracle.dmt.odm.model
Class AdaptiveBayesNetworkModel

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.model.MiningModel
                    |
                    +--oracle.dmt.odm.model.SupervisedModel
                          |
                          +--oracle.dmt.odm.model.AdaptiveBayesNetworkModel
All Implemented Interfaces:
java.io.Serializable

public class AdaptiveBayesNetworkModel
extends SupervisedModel

An instance of AdaptiveBayesNetworkModel contains the metadata and rules tables from a model build. The metadata is sufficient to determine whether a model can be applied to given data. AdaptiveBayesNetworkModel is an adaptive conditional independence model that uses the minimum description length principle to construct and prune an array of conditionally independent NetworkFeatures. Each NetworkFeature consists of one or more ConditionalProbabilityExpressions. The collection of NetworkFeatures forms a product model that provides estimates of the target class probabilities. In addition, rules can be extracted from the AdaptiveBayesNetworkModel as CompoundPredicates. The Predicate form enables the user to depict a decision tree as a set of "IF, THEN" predicates whose internal nodes have a splitting predictor and a highest probability predicted target class. The leaves have only a highest probability predicted target class. The root node has only a splitting predictor. An array of decision trees, one per NetworkFeature, can be extracted from the AdpativeBayesNetworkModel. Each decision tree is represented as an array of TreeNodes.

Since:
9.2.0
See Also:
Serialized Form

Method Summary
TypeMethod
static TreeNode[] getDecisionTree(Connection dmsConn, java.lang.String modelName)
          Returns the array of TreeNodes forming a decision tree.
static int getEstimateTimeToConstructAFeature(Connection dmsConn, java.lang.String modelName)
          Returns an estimate of the time required to construct a network feature in minutes.
static ABNModelBuildState getModelBuildState(Connection dmsConn, java.lang.String modelName)
          Returns an ABNModelBuildState instance indicating the model build state.
static ModelTimingRecord[] getModelTimingRecords(Connection dmsConn, java.lang.String modelName)
          Returns an array of ModelTimingRecords.
static NetworkFeature[] getNetworkFeatures(Connection dmsConn, java.lang.String modelName)
          Returns an array of NetworkFeatures.
 java.lang.String getNodeTableName()
          For internal use only
 java.lang.String getParentChildTableName()
          For internal use only
static MiningRuleSet getRules(Connection dmsConn, java.lang.String modelName)
          Returns the decision tree MiningRuleSet.
static NetworkFeature getTargetPrior(Connection dmsConn, java.lang.String modelName)
          Returns the target prior.
 java.lang.String getTimingTableName()
          For internal use only
 java.lang.String getValueTableName()
          For internal use only
 
Methods inherited from class oracle.dmt.odm.model.SupervisedModel
apply, apply, apply, computeLift, getConditionsTableName, getCostMatrixTableName, getNumberOfConditions, getNumberOfPriors, getPriorsTableName, getTargetValueCount, restore, restore, test
 
Methods inherited from class oracle.dmt.odm.model.MiningModel
build, getBinCategoricalTableName, getBinNumericTableName, getMiningAlgorithm, getMiningFunction, getMiningFunctionSettings, getModelName, listContents, listContents, listContents, listContents, remove, setModelNameForMig
 
Methods inherited from class oracle.dmt.odm.LocatableObject
deserialize, serialize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getParentChildTableName

public java.lang.String getParentChildTableName()
For internal use only

getNodeTableName

public java.lang.String getNodeTableName()
For internal use only

getValueTableName

public java.lang.String getValueTableName()
For internal use only

getTimingTableName

public java.lang.String getTimingTableName()
For internal use only

getNetworkFeatures

public static NetworkFeature[] getNetworkFeatures(Connection dmsConn,
                                                  java.lang.String modelName)
                                           throws java.sql.SQLException,
                                                  MiningObjectException,
                                                  InvalidArgumentException,
                                                  ODMException
Returns an array of NetworkFeatures.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the network features are extracted
Returns:
NetworkFeature[] - the array of network features.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the model meta data cannot be retrieved
See Also:
NetworkFeature

getDecisionTree

public static TreeNode[] getDecisionTree(Connection dmsConn,
                                         java.lang.String modelName)
                                  throws java.sql.SQLException,
                                         MiningObjectException,
                                         InvalidArgumentException,
                                         ODMException
Returns the array of TreeNodes forming a decision tree.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the tree nodes are extracted
Returns:
TreeNode[] - the array of tree nodes.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the model meta data cannot be retrieved
See Also:
TreeNode

getRules

public static MiningRuleSet getRules(Connection dmsConn,
                                     java.lang.String modelName)
                              throws java.sql.SQLException,
                                     MiningObjectException,
                                     InvalidArgumentException,
                                     ODMException
Returns the decision tree MiningRuleSet.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the mining rule set is extracted
Returns:
MiningRuleSet - the mining rule set.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the model meta data cannot be retrieved

getTargetPrior

public static NetworkFeature getTargetPrior(Connection dmsConn,
                                            java.lang.String modelName)
                                     throws java.sql.SQLException,
                                            MiningObjectException,
                                            InvalidArgumentException,
                                            ODMException
Returns the target prior. Each AdaptiveBayesNetworkModel contains a special NetworkFeature, termed the TargetPrior. The TargetPrior is the global (unconditional) probability of the various target values.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the target prior is extracted
Returns:
NetworkFeature - the target prior.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the model meta data cannot be retrieved

getModelTimingRecords

public static ModelTimingRecord[] getModelTimingRecords(Connection dmsConn,
                                                        java.lang.String modelName)
                                                 throws java.sql.SQLException,
                                                        MiningObjectException,
                                                        InvalidArgumentException,
                                                        ODMException
Returns an array of ModelTimingRecords.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the model timing records are extracted
Returns:
ModelTimingRecord[] - the array of model timing records.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the model meta data cannot be retrieved
See Also:
ModelTimingRecord

getEstimateTimeToConstructAFeature

public static int getEstimateTimeToConstructAFeature(Connection dmsConn,
                                                     java.lang.String modelName)
                                              throws java.sql.SQLException,
                                                     MiningObjectException,
                                                     InvalidArgumentException,
                                                     ODMException
Returns an estimate of the time required to construct a network feature in minutes.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the estimated time to construct a network feature is extracted
Returns:
int - the estimate time to construct a network feature in minute.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the internal method call failed

getModelBuildState

public static ABNModelBuildState getModelBuildState(Connection dmsConn,
                                                    java.lang.String modelName)
                                             throws java.sql.SQLException,
                                                    MiningObjectException,
                                                    InvalidArgumentException,
                                                    ODMException
Returns an ABNModelBuildState instance indicating the model build state.
Parameters:
dmsConn - The connection to the data mining server
modelName - Name of the model from which the model build state is extracted
Returns:
ABNModelBuildState - the model build state.
Throws:
InvalidArgumentException - is thrown
- when the dmsConn/modelName are null
- when the modelName length > 64 characters
MiningObjectException - is thrown
- when the model cannot be opened
SQLException - is thrown
- when the internal method call failed
See Also:
ABNModelBuildState