org.dmg.pmml

Class MiningModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.MiningModel

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class MiningModel
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_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element ref="{http://www.dmg.org/PMML-4_2}Regression"/>
           <element ref="{http://www.dmg.org/PMML-4_2}DecisionTree"/>
         </choice>
         <element ref="{http://www.dmg.org/PMML-4_2}Segmentation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}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_2}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MiningModel()
MiningModel(MiningFunctionType functionName, MiningSchema miningSchema)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
MiningModel	addEmbeddedModels(EmbeddedModel... embeddedModels)
MiningModel	addExtensions(Extension... extensions)
String	getAlgorithmName() Gets the value of the algorithmName property.
List<EmbeddedModel>	getEmbeddedModels() Gets the value of the embeddedModels 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.
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.
Output	getOutput() Gets the value of the output property.
Segmentation	getSegmentation() Gets the value of the segmentation property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasEmbeddedModels()
boolean	hasExtensions()
boolean	isScorable() Gets the value of the scorable property.
MiningModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
MiningModel	setFunctionName(MiningFunctionType functionName) Sets the value of the functionName property.
MiningModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
MiningModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
MiningModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
MiningModel	setModelName(String modelName) Sets the value of the modelName property.
MiningModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
MiningModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
MiningModel	setOutput(Output output) Sets the value of the output property.
MiningModel	setScorable(Boolean scorable) Sets the value of the scorable property.
MiningModel	setSegmentation(Segmentation segmentation) Sets the value of the segmentation property.
MiningModel	setTargets(Targets targets) Sets the value of the targets property.

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator

Methods inherited from class java.lang.Object

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

Constructor Detail

MiningModel

public MiningModel()

MiningModel

public MiningModel(MiningFunctionType functionName,
           MiningSchema miningSchema)

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 MiningModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - 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 MiningModel setFunctionName(MiningFunctionType functionName)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

functionName - allowed object is MiningFunctionType

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public MiningModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public MiningModel 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 MiningModel 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 MiningModel 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 MiningModel 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 MiningModel 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 MiningModel 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 MiningModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getEmbeddedModels

public List<EmbeddedModel> getEmbeddedModels()

Gets the value of the embeddedModels 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 embeddedModels property.

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

    getEmbeddedModels().add(newItem);
 

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

getSegmentation

public Segmentation getSegmentation()

Gets the value of the segmentation property.

Returns:

possible object is Segmentation

setSegmentation

public MiningModel setSegmentation(Segmentation segmentation)

Sets the value of the segmentation property.

Parameters:

segmentation - allowed object is Segmentation

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public MiningModel 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 MiningModel addExtensions(Extension... extensions)

hasEmbeddedModels

public boolean hasEmbeddedModels()

addEmbeddedModels

public MiningModel addEmbeddedModels(EmbeddedModel... embeddedModels)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable