org.dmg.pmml.tree

Class TreeModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.tree.TreeModel

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class TreeModel
extends Model
implements HasExtensions

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.dmg.org/PMML-4_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Node"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelVerification" minOccurs="0"/>
       </sequence>
       <attribute name="modelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="functionName" use="required" type="{http://www.dmg.org/PMML-4_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="missingValueStrategy" default="none">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="lastPrediction"/>
             <enumeration value="nullPrediction"/>
             <enumeration value="defaultChild"/>
             <enumeration value="weightedConfidence"/>
             <enumeration value="aggregateNodes"/>
             <enumeration value="none"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="missingValuePenalty" type="{http://www.dmg.org/PMML-4_3}PROB-NUMBER" default="1.0" />
       <attribute name="noTrueChildStrategy" default="returnNullPrediction">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="returnNullPrediction"/>
             <enumeration value="returnLastPrediction"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="splitCharacteristic" default="multiSplit">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="binarySplit"/>
             <enumeration value="multiSplit"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeModel.MissingValueStrategy Java class for null.
static class	TreeModel.NoTrueChildStrategy Java class for null.
static class	TreeModel.SplitCharacteristic Java class for null.

Constructor Summary

Constructors

Constructor and Description
TreeModel()
TreeModel(MiningFunction miningFunction, MiningSchema miningSchema, Node node)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
TreeModel	addExtensions(Extension... extensions)
String	getAlgorithmName() Gets the value of the algorithmName property.
List<Extension>	getExtensions() Gets the value of the extensions property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningFunction	getMiningFunction() Gets the value of the miningFunction property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
Double	getMissingValuePenalty() Gets the value of the missingValuePenalty property.
TreeModel.MissingValueStrategy	getMissingValueStrategy() Gets the value of the missingValueStrategy property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
String	getModelName() Gets the value of the modelName property.
ModelStats	getModelStats() Gets the value of the modelStats property.
ModelVerification	getModelVerification() Gets the value of the modelVerification property.
Node	getNode() Gets the value of the node property.
TreeModel.NoTrueChildStrategy	getNoTrueChildStrategy() Gets the value of the noTrueChildStrategy property.
Output	getOutput() Gets the value of the output property.
TreeModel.SplitCharacteristic	getSplitCharacteristic() Gets the value of the splitCharacteristic property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasExtensions()
boolean	isScorable() Gets the value of the scorable property.
TreeModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
TreeModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
TreeModel	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
TreeModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
TreeModel	setMissingValuePenalty(Double missingValuePenalty) Sets the value of the missingValuePenalty property.
TreeModel	setMissingValueStrategy(TreeModel.MissingValueStrategy missingValueStrategy) Sets the value of the missingValueStrategy property.
TreeModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
TreeModel	setModelName(String modelName) Sets the value of the modelName property.
TreeModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
TreeModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
TreeModel	setNode(Node node) Sets the value of the node property.
TreeModel	setNoTrueChildStrategy(TreeModel.NoTrueChildStrategy noTrueChildStrategy) Sets the value of the noTrueChildStrategy property.
TreeModel	setOutput(Output output) Sets the value of the output property.
TreeModel	setScorable(Boolean scorable) Sets the value of the scorable property.
TreeModel	setSplitCharacteristic(TreeModel.SplitCharacteristic splitCharacteristic) Sets the value of the splitCharacteristic property.
TreeModel	setTargets(Targets targets) Sets the value of the targets property.

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeModel

public TreeModel()

TreeModel

public TreeModel(MiningFunction miningFunction,
         MiningSchema miningSchema,
         Node node)

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public TreeModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public TreeModel setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public TreeModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getMissingValueStrategy

public TreeModel.MissingValueStrategy getMissingValueStrategy()

Gets the value of the missingValueStrategy property.

Returns:

possible object is TreeModel.MissingValueStrategy

setMissingValueStrategy

public TreeModel setMissingValueStrategy(TreeModel.MissingValueStrategy missingValueStrategy)

Sets the value of the missingValueStrategy property.

Parameters:

missingValueStrategy - allowed object is TreeModel.MissingValueStrategy

getMissingValuePenalty

public Double getMissingValuePenalty()

Gets the value of the missingValuePenalty property.

Returns:

possible object is Double

setMissingValuePenalty

public TreeModel setMissingValuePenalty(Double missingValuePenalty)

Sets the value of the missingValuePenalty property.

Parameters:

missingValuePenalty - allowed object is Double

getNoTrueChildStrategy

public TreeModel.NoTrueChildStrategy getNoTrueChildStrategy()

Gets the value of the noTrueChildStrategy property.

Returns:

possible object is TreeModel.NoTrueChildStrategy

setNoTrueChildStrategy

public TreeModel setNoTrueChildStrategy(TreeModel.NoTrueChildStrategy noTrueChildStrategy)

Sets the value of the noTrueChildStrategy property.

Parameters:

noTrueChildStrategy - allowed object is TreeModel.NoTrueChildStrategy

getSplitCharacteristic

public TreeModel.SplitCharacteristic getSplitCharacteristic()

Gets the value of the splitCharacteristic property.

Returns:

possible object is TreeModel.SplitCharacteristic

setSplitCharacteristic

public TreeModel setSplitCharacteristic(TreeModel.SplitCharacteristic splitCharacteristic)

Sets the value of the splitCharacteristic property.

Parameters:

splitCharacteristic - allowed object is TreeModel.SplitCharacteristic

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public TreeModel setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

getExtensions

public List<Extension> getExtensions()

Gets the value of the extensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.

For example, to add a new item, do as follows:

    getExtensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Extension

Specified by:

getExtensions in interface HasExtensions

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public TreeModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public TreeModel setOutput(Output output)

Sets the value of the output property.

Overrides:

setOutput in class Model

Parameters:

output - allowed object is Output

getModelStats

public ModelStats getModelStats()

Gets the value of the modelStats property.

Specified by:

getModelStats in class Model

Returns:

possible object is ModelStats

setModelStats

public TreeModel setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Overrides:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public TreeModel setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Overrides:

setModelExplanation in class Model

Parameters:

modelExplanation - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Overrides:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public TreeModel setTargets(Targets targets)

Sets the value of the targets property.

Overrides:

setTargets in class Model

Parameters:

targets - allowed object is Targets

getLocalTransformations

public LocalTransformations getLocalTransformations()

Gets the value of the localTransformations property.

Specified by:

getLocalTransformations in class Model

Returns:

possible object is LocalTransformations

setLocalTransformations

public TreeModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getNode

public Node getNode()

Gets the value of the node property.

Returns:

possible object is Node

setNode

public TreeModel setNode(Node node)

Sets the value of the node property.

Parameters:

node - allowed object is Node

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public TreeModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public TreeModel addExtensions(Extension... extensions)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable