org.dmg.pmml.regression

Class RegressionModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.regression.RegressionModel

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class RegressionModel
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}RegressionTable" maxOccurs="unbounded"/>
         <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="modelType">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="linearRegression"/>
             <enumeration value="stepwisePolynomialRegression"/>
             <enumeration value="logisticRegression"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="targetFieldName" type="{http://www.dmg.org/PMML-4_3}FIELD-NAME" />
       <attribute name="normalizationMethod" default="none">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="none"/>
             <enumeration value="simplemax"/>
             <enumeration value="softmax"/>
             <enumeration value="logit"/>
             <enumeration value="probit"/>
             <enumeration value="cloglog"/>
             <enumeration value="exp"/>
             <enumeration value="loglog"/>
             <enumeration value="cauchit"/>
           </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	RegressionModel.ModelType Java class for null.
static class	RegressionModel.NormalizationMethod Java class for null.

Constructor Summary

Constructors

Constructor and Description
RegressionModel()
RegressionModel(MiningFunction miningFunction, MiningSchema miningSchema, List<RegressionTable> regressionTables)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
RegressionModel	addExtensions(Extension... extensions)
RegressionModel	addRegressionTables(RegressionTable... regressionTables)
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.
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.
RegressionModel.ModelType	getModelType() Gets the value of the modelType property.
ModelVerification	getModelVerification() Gets the value of the modelVerification property.
RegressionModel.NormalizationMethod	getNormalizationMethod() Gets the value of the normalizationMethod property.
Output	getOutput() Gets the value of the output property.
List<RegressionTable>	getRegressionTables() Gets the value of the regressionTables property.
FieldName	getTargetFieldName() Gets the value of the targetFieldName property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasExtensions()
boolean	hasRegressionTables()
boolean	isScorable() Gets the value of the scorable property.
RegressionModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
RegressionModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
RegressionModel	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
RegressionModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
RegressionModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
RegressionModel	setModelName(String modelName) Sets the value of the modelName property.
RegressionModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
RegressionModel	setModelType(RegressionModel.ModelType modelType) Sets the value of the modelType property.
RegressionModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
RegressionModel	setNormalizationMethod(RegressionModel.NormalizationMethod normalizationMethod) Sets the value of the normalizationMethod property.
RegressionModel	setOutput(Output output) Sets the value of the output property.
RegressionModel	setScorable(Boolean scorable) Sets the value of the scorable property.
RegressionModel	setTargetFieldName(FieldName targetFieldName) Sets the value of the targetFieldName property.
RegressionModel	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

RegressionModel

public RegressionModel()

RegressionModel

public RegressionModel(MiningFunction miningFunction,
               MiningSchema miningSchema,
               List<RegressionTable> regressionTables)

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 RegressionModel 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 RegressionModel 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 RegressionModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getModelType

public RegressionModel.ModelType getModelType()

Gets the value of the modelType property.

Returns:

possible object is RegressionModel.ModelType

setModelType

public RegressionModel setModelType(RegressionModel.ModelType modelType)

Sets the value of the modelType property.

Parameters:

modelType - allowed object is RegressionModel.ModelType

getTargetFieldName

public FieldName getTargetFieldName()

Gets the value of the targetFieldName property.

Returns:

possible object is String

setTargetFieldName

public RegressionModel setTargetFieldName(FieldName targetFieldName)

Sets the value of the targetFieldName property.

Parameters:

targetFieldName - allowed object is String

getNormalizationMethod

public RegressionModel.NormalizationMethod getNormalizationMethod()

Gets the value of the normalizationMethod property.

Returns:

possible object is RegressionModel.NormalizationMethod

setNormalizationMethod

public RegressionModel setNormalizationMethod(RegressionModel.NormalizationMethod normalizationMethod)

Sets the value of the normalizationMethod property.

Parameters:

normalizationMethod - allowed object is RegressionModel.NormalizationMethod

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

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

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getRegressionTables

public List<RegressionTable> getRegressionTables()

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

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

    getRegressionTables().add(newItem);
 

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

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

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

hasRegressionTables

public boolean hasRegressionTables()

addRegressionTables

public RegressionModel addRegressionTables(RegressionTable... regressionTables)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable