org.dmg.pmml

Class TreeModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.TreeModel

All Implemented Interfaces:

com.sun.xml.bind.Locatable, Serializable, HasExtensions, Visitable

public class TreeModel
extends Model
implements com.sun.xml.bind.Locatable, 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_1}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_1}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}Node"/>
         <element ref="{http://www.dmg.org/PMML-4_1}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_1}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="missingValueStrategy" type="{http://www.dmg.org/PMML-4_1}MISSING-VALUE-STRATEGY" default="none" />
       <attribute name="missingValuePenalty" type="{http://www.dmg.org/PMML-4_1}PROB-NUMBER" default="1.0" />
       <attribute name="noTrueChildStrategy" type="{http://www.dmg.org/PMML-4_1}NO-TRUE-CHILD-STRATEGY" default="returnNullPrediction" />
       <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.SplitCharacteristic Java class for null.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	algorithmName
protected List<Extension>	extensions
protected MiningFunctionType	functionName
protected LocalTransformations	localTransformations
protected Locator	locator
protected MiningSchema	miningSchema
protected Double	missingValuePenalty
protected MissingValueStrategyType	missingValueStrategy
protected ModelExplanation	modelExplanation
protected String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected Node	node
protected NoTrueChildStrategyType	noTrueChildStrategy
protected Output	output
protected Boolean	scorable
protected TreeModel.SplitCharacteristic	splitCharacteristic
protected Targets	targets

Constructor Summary

Constructors

Constructor and Description
TreeModel() Deprecated.
TreeModel(MiningSchema miningSchema, Node node, MiningFunctionType functionName)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
String	getAlgorithmName() Gets the value of the algorithmName property.
List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
double	getMissingValuePenalty() Gets the value of the missingValuePenalty property.
MissingValueStrategyType	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.
NoTrueChildStrategyType	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	isScorable() Gets the value of the scorable property.
void	setAlgorithmName(String value) Sets the value of the algorithmName property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setMissingValuePenalty(Double value) Sets the value of the missingValuePenalty property.
void	setMissingValueStrategy(MissingValueStrategyType value) Sets the value of the missingValueStrategy property.
void	setModelExplanation(ModelExplanation value) Sets the value of the modelExplanation property.
void	setModelName(String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setNode(Node value) Sets the value of the node property.
void	setNoTrueChildStrategy(NoTrueChildStrategyType value) Sets the value of the noTrueChildStrategy property.
void	setOutput(Output value) Sets the value of the output property.
void	setScorable(Boolean value) Sets the value of the scorable property.
void	setSourceLocation(Locator newLocator)
void	setSplitCharacteristic(TreeModel.SplitCharacteristic value) Sets the value of the splitCharacteristic property.
void	setTargets(Targets value) Sets the value of the targets property.
Locator	sourceLocation()
TreeModel	withAlgorithmName(String value)
TreeModel	withExtensions(Collection<Extension> values)
TreeModel	withExtensions(Extension... values)
TreeModel	withFunctionName(MiningFunctionType value)
TreeModel	withLocalTransformations(LocalTransformations value)
TreeModel	withMiningSchema(MiningSchema value)
TreeModel	withMissingValuePenalty(Double value)
TreeModel	withMissingValueStrategy(MissingValueStrategyType value)
TreeModel	withModelExplanation(ModelExplanation value)
TreeModel	withModelName(String value)
TreeModel	withModelStats(ModelStats value)
TreeModel	withModelVerification(ModelVerification value)
TreeModel	withNode(Node value)
TreeModel	withNoTrueChildStrategy(NoTrueChildStrategyType value)
TreeModel	withOutput(Output value)
TreeModel	withScorable(Boolean value)
TreeModel	withSplitCharacteristic(TreeModel.SplitCharacteristic value)
TreeModel	withTargets(Targets value)

Methods inherited from class java.lang.Object

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

Field Detail

extensions

protected List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

output

protected Output output

modelStats

protected ModelStats modelStats

modelExplanation

protected ModelExplanation modelExplanation

targets

protected Targets targets

localTransformations

protected LocalTransformations localTransformations

node

protected Node node

modelVerification

protected ModelVerification modelVerification

modelName

protected String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected String algorithmName

missingValueStrategy

protected MissingValueStrategyType missingValueStrategy

missingValuePenalty

protected Double missingValuePenalty

noTrueChildStrategy

protected NoTrueChildStrategyType noTrueChildStrategy

splitCharacteristic

protected TreeModel.SplitCharacteristic splitCharacteristic

scorable

protected Boolean scorable

locator

protected Locator locator

Constructor Detail

TreeModel

@Deprecated
public TreeModel()

Deprecated.

TreeModel

public TreeModel(MiningSchema miningSchema,
         Node node,
         MiningFunctionType functionName)

Method Detail

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 void setMiningSchema(MiningSchema value)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

value - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Returns:

possible object is Output

setOutput

public void setOutput(Output value)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

value - 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 void setModelStats(ModelStats value)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

value - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Parameters:

value - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public void setTargets(Targets value)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Parameters:

value - 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 void setLocalTransformations(LocalTransformations value)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

value - allowed object is LocalTransformations

getNode

public Node getNode()

Gets the value of the node property.

Returns:

possible object is Node

setNode

public void setNode(Node value)

Sets the value of the node property.

Parameters:

value - allowed object is Node

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Returns:

possible object is ModelVerification

setModelVerification

public void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Parameters:

value - allowed object is ModelVerification

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public void setModelName(String value)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

value - allowed object is String

getFunctionName

public MiningFunctionType getFunctionName()

Gets the value of the functionName property.

Specified by:

getFunctionName in class Model

Returns:

possible object is MiningFunctionType

setFunctionName

public void setFunctionName(MiningFunctionType value)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

value - allowed object is MiningFunctionType

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(String value)

Sets the value of the algorithmName property.

Parameters:

value - allowed object is String

getMissingValueStrategy

public MissingValueStrategyType getMissingValueStrategy()

Gets the value of the missingValueStrategy property.

Returns:

possible object is MissingValueStrategyType

setMissingValueStrategy

public void setMissingValueStrategy(MissingValueStrategyType value)

Sets the value of the missingValueStrategy property.

Parameters:

value - allowed object is MissingValueStrategyType

getMissingValuePenalty

public double getMissingValuePenalty()

Gets the value of the missingValuePenalty property.

Returns:

possible object is String

setMissingValuePenalty

public void setMissingValuePenalty(Double value)

Sets the value of the missingValuePenalty property.

Parameters:

value - allowed object is String

getNoTrueChildStrategy

public NoTrueChildStrategyType getNoTrueChildStrategy()

Gets the value of the noTrueChildStrategy property.

Returns:

possible object is NoTrueChildStrategyType

setNoTrueChildStrategy

public void setNoTrueChildStrategy(NoTrueChildStrategyType value)

Sets the value of the noTrueChildStrategy property.

Parameters:

value - allowed object is NoTrueChildStrategyType

getSplitCharacteristic

public TreeModel.SplitCharacteristic getSplitCharacteristic()

Gets the value of the splitCharacteristic property.

Returns:

possible object is TreeModel.SplitCharacteristic

setSplitCharacteristic

public void setSplitCharacteristic(TreeModel.SplitCharacteristic value)

Sets the value of the splitCharacteristic property.

Parameters:

value - 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 void setScorable(Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - allowed object is Boolean

withExtensions

public TreeModel withExtensions(Extension... values)

withExtensions

public TreeModel withExtensions(Collection<Extension> values)

withMiningSchema

public TreeModel withMiningSchema(MiningSchema value)

withOutput

public TreeModel withOutput(Output value)

withModelStats

public TreeModel withModelStats(ModelStats value)

withModelExplanation

public TreeModel withModelExplanation(ModelExplanation value)

withTargets

public TreeModel withTargets(Targets value)

withLocalTransformations

public TreeModel withLocalTransformations(LocalTransformations value)

withNode

public TreeModel withNode(Node value)

withModelVerification

public TreeModel withModelVerification(ModelVerification value)

withModelName

public TreeModel withModelName(String value)

withFunctionName

public TreeModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public TreeModel withAlgorithmName(String value)

withMissingValueStrategy

public TreeModel withMissingValueStrategy(MissingValueStrategyType value)

withMissingValuePenalty

public TreeModel withMissingValuePenalty(Double value)

withNoTrueChildStrategy

public TreeModel withNoTrueChildStrategy(NoTrueChildStrategyType value)

withSplitCharacteristic

public TreeModel withSplitCharacteristic(TreeModel.SplitCharacteristic value)

withScorable

public TreeModel withScorable(Boolean value)

sourceLocation

public Locator sourceLocation()

Specified by:

sourceLocation in interface com.sun.xml.bind.Locatable

Specified by:

sourceLocation in class PMMLObject

setSourceLocation

public void setSourceLocation(Locator newLocator)

Specified by:

setSourceLocation in class PMMLObject

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable