org.dmg.pmml

Class PredictiveModelQuality

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.PredictiveModelQuality

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class PredictiveModelQuality
extends PMMLObject
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}ConfusionMatrix" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LiftData" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ROC" minOccurs="0"/>
       </sequence>
       <attribute name="targetField" use="required" type="{http://www.dmg.org/PMML-4_3}FIELD-NAME" />
       <attribute name="dataName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="dataUsage" default="training">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="training"/>
             <enumeration value="test"/>
             <enumeration value="validation"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="meanError" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="meanAbsoluteError" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="meanSquaredError" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="rootMeanSquaredError" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="r-squared" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="adj-r-squared" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="sumSquaredError" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="sumSquaredRegression" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="numOfRecords" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="numOfRecordsWeighted" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="numOfPredictors" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="degreesOfFreedom" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="fStatistic" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="AIC" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="BIC" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
       <attribute name="AICc" type="{http://www.dmg.org/PMML-4_3}NUMBER" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredictiveModelQuality.DataUsage Java class for null.

Constructor Summary

Constructors

Constructor and Description
PredictiveModelQuality()
PredictiveModelQuality(FieldName targetField)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
PredictiveModelQuality	addExtensions(Extension... extensions)
PredictiveModelQuality	addLiftDatas(LiftData... liftDatas)
Double	getAdjRSquared() Gets the value of the adjRSquared property.
Double	getAIC() Gets the value of the aic property.
Double	getAICc() Gets the value of the aiCc property.
Double	getBIC() Gets the value of the bic property.
ConfusionMatrix	getConfusionMatrix() Gets the value of the confusionMatrix property.
String	getDataName() Gets the value of the dataName property.
PredictiveModelQuality.DataUsage	getDataUsage() Gets the value of the dataUsage property.
Double	getDegreesOfFreedom() Gets the value of the degreesOfFreedom property.
List<Extension>	getExtensions() Gets the value of the extensions property.
Double	getFStatistic() Gets the value of the fStatistic property.
List<LiftData>	getLiftDatas() Gets the value of the liftDatas property.
Double	getMeanAbsoluteError() Gets the value of the meanAbsoluteError property.
Double	getMeanError() Gets the value of the meanError property.
Double	getMeanSquaredError() Gets the value of the meanSquaredError property.
Double	getNumOfPredictors() Gets the value of the numOfPredictors property.
Double	getNumOfRecords() Gets the value of the numOfRecords property.
Double	getNumOfRecordsWeighted() Gets the value of the numOfRecordsWeighted property.
ROC	getROC() Gets the value of the roc property.
Double	getRootMeanSquaredError() Gets the value of the rootMeanSquaredError property.
Double	getRSquared() Gets the value of the rSquared property.
Double	getSumSquaredError() Gets the value of the sumSquaredError property.
Double	getSumSquaredRegression() Gets the value of the sumSquaredRegression property.
FieldName	getTargetField() Gets the value of the targetField property.
boolean	hasExtensions()
boolean	hasLiftDatas()
PredictiveModelQuality	setAdjRSquared(Double adjRSquared) Sets the value of the adjRSquared property.
PredictiveModelQuality	setAIC(Double aic) Sets the value of the aic property.
PredictiveModelQuality	setAICc(Double aiCc) Sets the value of the aiCc property.
PredictiveModelQuality	setBIC(Double bic) Sets the value of the bic property.
PredictiveModelQuality	setConfusionMatrix(ConfusionMatrix confusionMatrix) Sets the value of the confusionMatrix property.
PredictiveModelQuality	setDataName(String dataName) Sets the value of the dataName property.
PredictiveModelQuality	setDataUsage(PredictiveModelQuality.DataUsage dataUsage) Sets the value of the dataUsage property.
PredictiveModelQuality	setDegreesOfFreedom(Double degreesOfFreedom) Sets the value of the degreesOfFreedom property.
PredictiveModelQuality	setFStatistic(Double fStatistic) Sets the value of the fStatistic property.
PredictiveModelQuality	setMeanAbsoluteError(Double meanAbsoluteError) Sets the value of the meanAbsoluteError property.
PredictiveModelQuality	setMeanError(Double meanError) Sets the value of the meanError property.
PredictiveModelQuality	setMeanSquaredError(Double meanSquaredError) Sets the value of the meanSquaredError property.
PredictiveModelQuality	setNumOfPredictors(Double numOfPredictors) Sets the value of the numOfPredictors property.
PredictiveModelQuality	setNumOfRecords(Double numOfRecords) Sets the value of the numOfRecords property.
PredictiveModelQuality	setNumOfRecordsWeighted(Double numOfRecordsWeighted) Sets the value of the numOfRecordsWeighted property.
PredictiveModelQuality	setROC(ROC roc) Sets the value of the roc property.
PredictiveModelQuality	setRootMeanSquaredError(Double rootMeanSquaredError) Sets the value of the rootMeanSquaredError property.
PredictiveModelQuality	setRSquared(Double rSquared) Sets the value of the rSquared property.
PredictiveModelQuality	setSumSquaredError(Double sumSquaredError) Sets the value of the sumSquaredError property.
PredictiveModelQuality	setSumSquaredRegression(Double sumSquaredRegression) Sets the value of the sumSquaredRegression property.
PredictiveModelQuality	setTargetField(FieldName targetField) Sets the value of the targetField 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

PredictiveModelQuality

public PredictiveModelQuality()

PredictiveModelQuality

public PredictiveModelQuality(FieldName targetField)

Method Detail

getTargetField

public FieldName getTargetField()

Gets the value of the targetField property.

Returns:

possible object is String

setTargetField

public PredictiveModelQuality setTargetField(FieldName targetField)

Sets the value of the targetField property.

Parameters:

targetField - allowed object is String

getDataName

public String getDataName()

Gets the value of the dataName property.

Returns:

possible object is String

setDataName

public PredictiveModelQuality setDataName(String dataName)

Sets the value of the dataName property.

Parameters:

dataName - allowed object is String

getDataUsage

public PredictiveModelQuality.DataUsage getDataUsage()

Gets the value of the dataUsage property.

Returns:

possible object is PredictiveModelQuality.DataUsage

setDataUsage

public PredictiveModelQuality setDataUsage(PredictiveModelQuality.DataUsage dataUsage)

Sets the value of the dataUsage property.

Parameters:

dataUsage - allowed object is PredictiveModelQuality.DataUsage

getMeanError

public Double getMeanError()

Gets the value of the meanError property.

Returns:

possible object is Double

setMeanError

public PredictiveModelQuality setMeanError(Double meanError)

Sets the value of the meanError property.

Parameters:

meanError - allowed object is Double

getMeanAbsoluteError

public Double getMeanAbsoluteError()

Gets the value of the meanAbsoluteError property.

Returns:

possible object is Double

setMeanAbsoluteError

public PredictiveModelQuality setMeanAbsoluteError(Double meanAbsoluteError)

Sets the value of the meanAbsoluteError property.

Parameters:

meanAbsoluteError - allowed object is Double

getMeanSquaredError

public Double getMeanSquaredError()

Gets the value of the meanSquaredError property.

Returns:

possible object is Double

setMeanSquaredError

public PredictiveModelQuality setMeanSquaredError(Double meanSquaredError)

Sets the value of the meanSquaredError property.

Parameters:

meanSquaredError - allowed object is Double

getRootMeanSquaredError

public Double getRootMeanSquaredError()

Gets the value of the rootMeanSquaredError property.

Returns:

possible object is Double

setRootMeanSquaredError

public PredictiveModelQuality setRootMeanSquaredError(Double rootMeanSquaredError)

Sets the value of the rootMeanSquaredError property.

Parameters:

rootMeanSquaredError - allowed object is Double

getRSquared

public Double getRSquared()

Gets the value of the rSquared property.

Returns:

possible object is Double

setRSquared

public PredictiveModelQuality setRSquared(Double rSquared)

Sets the value of the rSquared property.

Parameters:

rSquared - allowed object is Double

getAdjRSquared

public Double getAdjRSquared()

Gets the value of the adjRSquared property.

Returns:

possible object is Double

setAdjRSquared

public PredictiveModelQuality setAdjRSquared(Double adjRSquared)

Sets the value of the adjRSquared property.

Parameters:

adjRSquared - allowed object is Double

getSumSquaredError

public Double getSumSquaredError()

Gets the value of the sumSquaredError property.

Returns:

possible object is Double

setSumSquaredError

public PredictiveModelQuality setSumSquaredError(Double sumSquaredError)

Sets the value of the sumSquaredError property.

Parameters:

sumSquaredError - allowed object is Double

getSumSquaredRegression

public Double getSumSquaredRegression()

Gets the value of the sumSquaredRegression property.

Returns:

possible object is Double

setSumSquaredRegression

public PredictiveModelQuality setSumSquaredRegression(Double sumSquaredRegression)

Sets the value of the sumSquaredRegression property.

Parameters:

sumSquaredRegression - allowed object is Double

getNumOfRecords

public Double getNumOfRecords()

Gets the value of the numOfRecords property.

Returns:

possible object is Double

setNumOfRecords

public PredictiveModelQuality setNumOfRecords(Double numOfRecords)

Sets the value of the numOfRecords property.

Parameters:

numOfRecords - allowed object is Double

getNumOfRecordsWeighted

public Double getNumOfRecordsWeighted()

Gets the value of the numOfRecordsWeighted property.

Returns:

possible object is Double

setNumOfRecordsWeighted

public PredictiveModelQuality setNumOfRecordsWeighted(Double numOfRecordsWeighted)

Sets the value of the numOfRecordsWeighted property.

Parameters:

numOfRecordsWeighted - allowed object is Double

getNumOfPredictors

public Double getNumOfPredictors()

Gets the value of the numOfPredictors property.

Returns:

possible object is Double

setNumOfPredictors

public PredictiveModelQuality setNumOfPredictors(Double numOfPredictors)

Sets the value of the numOfPredictors property.

Parameters:

numOfPredictors - allowed object is Double

getDegreesOfFreedom

public Double getDegreesOfFreedom()

Gets the value of the degreesOfFreedom property.

Returns:

possible object is Double

setDegreesOfFreedom

public PredictiveModelQuality setDegreesOfFreedom(Double degreesOfFreedom)

Sets the value of the degreesOfFreedom property.

Parameters:

degreesOfFreedom - allowed object is Double

getFStatistic

public Double getFStatistic()

Gets the value of the fStatistic property.

Returns:

possible object is Double

setFStatistic

public PredictiveModelQuality setFStatistic(Double fStatistic)

Sets the value of the fStatistic property.

Parameters:

fStatistic - allowed object is Double

getAIC

public Double getAIC()

Gets the value of the aic property.

Returns:

possible object is Double

setAIC

public PredictiveModelQuality setAIC(Double aic)

Sets the value of the aic property.

Parameters:

aic - allowed object is Double

getBIC

public Double getBIC()

Gets the value of the bic property.

Returns:

possible object is Double

setBIC

public PredictiveModelQuality setBIC(Double bic)

Sets the value of the bic property.

Parameters:

bic - allowed object is Double

getAICc

public Double getAICc()

Gets the value of the aiCc property.

Returns:

possible object is Double

setAICc

public PredictiveModelQuality setAICc(Double aiCc)

Sets the value of the aiCc property.

Parameters:

aiCc - allowed object is Double

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

getConfusionMatrix

public ConfusionMatrix getConfusionMatrix()

Gets the value of the confusionMatrix property.

Returns:

possible object is ConfusionMatrix

setConfusionMatrix

public PredictiveModelQuality setConfusionMatrix(ConfusionMatrix confusionMatrix)

Sets the value of the confusionMatrix property.

Parameters:

confusionMatrix - allowed object is ConfusionMatrix

getLiftDatas

public List<LiftData> getLiftDatas()

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

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

    getLiftDatas().add(newItem);
 

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

getROC

public ROC getROC()

Gets the value of the roc property.

Returns:

possible object is ROC

setROC

public PredictiveModelQuality setROC(ROC roc)

Sets the value of the roc property.

Parameters:

roc - allowed object is ROC

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public PredictiveModelQuality addExtensions(Extension... extensions)

hasLiftDatas

public boolean hasLiftDatas()

addLiftDatas

public PredictiveModelQuality addLiftDatas(LiftData... liftDatas)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable