org.dmg.pmml

Class RegressionModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.RegressionModel

All Implemented Interfaces:

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

public class RegressionModel
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}RegressionTable" maxOccurs="unbounded"/>
         <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="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_1}FIELD-NAME" />
       <attribute name="normalizationMethod" type="{http://www.dmg.org/PMML-4_1}REGRESSIONNORMALIZATIONMETHOD" default="none" />
       <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.

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 ModelExplanation	modelExplanation
protected String	modelName
protected ModelStats	modelStats
protected RegressionModel.ModelType	modelType
protected ModelVerification	modelVerification
protected RegressionNormalizationMethodType	normalizationMethod
protected Output	output
protected List<RegressionTable>	regressionTables
protected Boolean	scorable
protected FieldName	targetFieldName
protected Targets	targets

Constructor Summary

Constructors

Constructor and Description
RegressionModel() Deprecated.
RegressionModel(MiningSchema miningSchema, 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.
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.
RegressionNormalizationMethodType	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	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	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	setModelType(RegressionModel.ModelType value) Sets the value of the modelType property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setNormalizationMethod(RegressionNormalizationMethodType value) Sets the value of the normalizationMethod 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	setTargetFieldName(FieldName value) Sets the value of the targetFieldName property.
void	setTargets(Targets value) Sets the value of the targets property.
Locator	sourceLocation()
RegressionModel	withAlgorithmName(String value)
RegressionModel	withExtensions(Collection<Extension> values)
RegressionModel	withExtensions(Extension... values)
RegressionModel	withFunctionName(MiningFunctionType value)
RegressionModel	withLocalTransformations(LocalTransformations value)
RegressionModel	withMiningSchema(MiningSchema value)
RegressionModel	withModelExplanation(ModelExplanation value)
RegressionModel	withModelName(String value)
RegressionModel	withModelStats(ModelStats value)
RegressionModel	withModelType(RegressionModel.ModelType value)
RegressionModel	withModelVerification(ModelVerification value)
RegressionModel	withNormalizationMethod(RegressionNormalizationMethodType value)
RegressionModel	withOutput(Output value)
RegressionModel	withRegressionTables(Collection<RegressionTable> values)
RegressionModel	withRegressionTables(RegressionTable... values)
RegressionModel	withScorable(Boolean value)
RegressionModel	withTargetFieldName(FieldName value)
RegressionModel	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

regressionTables

protected List<RegressionTable> regressionTables

modelVerification

protected ModelVerification modelVerification

modelName

protected String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected String algorithmName

modelType

protected RegressionModel.ModelType modelType

targetFieldName

protected FieldName targetFieldName

normalizationMethod

protected RegressionNormalizationMethodType normalizationMethod

scorable

protected Boolean scorable

locator

protected Locator locator

Constructor Detail

RegressionModel

@Deprecated
public RegressionModel()

Deprecated.

RegressionModel

public RegressionModel(MiningSchema miningSchema,
               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

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.

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

getModelType

public RegressionModel.ModelType getModelType()

Gets the value of the modelType property.

Returns:

possible object is RegressionModel.ModelType

setModelType

public void setModelType(RegressionModel.ModelType value)

Sets the value of the modelType property.

Parameters:

value - allowed object is RegressionModel.ModelType

getTargetFieldName

public FieldName getTargetFieldName()

Gets the value of the targetFieldName property.

Returns:

possible object is String

setTargetFieldName

public void setTargetFieldName(FieldName value)

Sets the value of the targetFieldName property.

Parameters:

value - allowed object is String

getNormalizationMethod

public RegressionNormalizationMethodType getNormalizationMethod()

Gets the value of the normalizationMethod property.

Returns:

possible object is RegressionNormalizationMethodType

setNormalizationMethod

public void setNormalizationMethod(RegressionNormalizationMethodType value)

Sets the value of the normalizationMethod property.

Parameters:

value - allowed object is RegressionNormalizationMethodType

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 RegressionModel withExtensions(Extension... values)

withExtensions

public RegressionModel withExtensions(Collection<Extension> values)

withMiningSchema

public RegressionModel withMiningSchema(MiningSchema value)

withOutput

public RegressionModel withOutput(Output value)

withModelStats

public RegressionModel withModelStats(ModelStats value)

withModelExplanation

public RegressionModel withModelExplanation(ModelExplanation value)

withTargets

public RegressionModel withTargets(Targets value)

withLocalTransformations

public RegressionModel withLocalTransformations(LocalTransformations value)

withRegressionTables

public RegressionModel withRegressionTables(RegressionTable... values)

withRegressionTables

public RegressionModel withRegressionTables(Collection<RegressionTable> values)

withModelVerification

public RegressionModel withModelVerification(ModelVerification value)

withModelName

public RegressionModel withModelName(String value)

withFunctionName

public RegressionModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public RegressionModel withAlgorithmName(String value)

withModelType

public RegressionModel withModelType(RegressionModel.ModelType value)

withTargetFieldName

public RegressionModel withTargetFieldName(FieldName value)

withNormalizationMethod

public RegressionModel withNormalizationMethod(RegressionNormalizationMethodType value)

withScorable

public RegressionModel 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