javax.datamining.modeldetail.tree
Interface TreeModelDetail

All Superinterfaces:
ModelDetail

public interface TreeModelDetail
extends ModelDetail

TreeModelDetail holds details of a tree model. TreeModelDetail is a recursive partitioning of a multidimensional space that attempts to create partitions that are homogeneous with respect to a target. A single step of the partitioning is done via a predicate that splits a node into two or more children.

Author:
JSR-73 Java Data Mining Expert Group
See Also:
ModelDetail

Method Summary
 TreeNode getNode(int nodeId)
          Returns the tree node with the specified identifier.
 int[] getNodeIdentifiers()
          Returns an array of node identifiers with the tree model.
 TreeNode[] getNodes()
          Returns all nodes of the decision tree in an arbitrary order.
 TreeNode getRootNode()
          Returns the top most node of the decision tree.
 Rule getRule(int nodeId)
          Returns the rule associated with the specified node.
 java.util.Collection getRules()
          Returns a collection for the rules contained in the tree model details.
 

Method Detail

getNode

public TreeNode getNode(int nodeId)
                 throws JDMException
Returns the tree node with the specified identifier. Returns null if there is no such tree node.

Parameters:
nodeId - The identifier of the node to be returned.
Returns:
TreeNode
Throws:
JDMException

getNodeIdentifiers

public int[] getNodeIdentifiers()
Returns an array of node identifiers with the tree model.

Returns:
int[]

getNodes

public TreeNode[] getNodes()
                    throws JDMException
Returns all nodes of the decision tree in an arbitrary order.

Returns:
TreeNode[]
Throws:
JDMException

getRootNode

public TreeNode getRootNode()
                     throws JDMException
Returns the top most node of the decision tree.

Returns:
TreeNode
Throws:
JDMException

getRule

public Rule getRule(int nodeId)
             throws JDMException
Returns the rule associated with the specified node.

Parameters:
nodeId - The node ID of the tree model.
Returns:
Rule
Throws:
JDMException

getRules

public java.util.Collection getRules()
                              throws JDMException
Returns a collection for the rules contained in the tree model details.

Returns:
Collection
Throws:
JDMException