PredictiveModelQuality (JPMML class model 1.1.6 API)

java.lang.Object
- org.dmg.pmml.PMMLObject
- - org.dmg.pmml.PredictiveModelQuality

All Implemented Interfaces:: com.sun.xml.bind.Locatable, Serializable, HasExtensions, Visitable

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

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Double`	`adjRSquared`
`protected Double`	`aic`
`protected Double`	`aiCc`
`protected Double`	`bic`
`protected ConfusionMatrix`	`confusionMatrix`
`protected String`	`dataName`
`protected String`	`dataUsage`
`protected Double`	`degreesOfFreedom`
`protected List<Extension>`	`extensions`
`protected Double`	`fStatistic`
`protected LiftData`	`liftData`
`protected Locator`	`locator`
`protected Double`	`meanAbsoluteError`
`protected Double`	`meanError`
`protected Double`	`meanSquaredError`
`protected Double`	`numOfPredictors`
`protected Double`	`numOfRecords`
`protected Double`	`numOfRecordsWeighted`
`protected ROC`	`roc`
`protected Double`	`rootMeanSquaredError`
`protected Double`	`rSquared`
`protected Double`	`sumSquaredError`
`protected Double`	`sumSquaredRegression`
`protected String`	`targetField`

Constructor Summary

Constructors
Constructor and Description

PredictiveModelQuality()

PredictiveModelQuality(String targetField)

Constructors
Constructor and Description
`PredictiveModelQuality()`
`PredictiveModelQuality(String targetField)`

Method Summary

Methods
Modifier and Type	Method and Description
`VisitorAction`	`accept(Visitor visitor)`
`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.
`String`	`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.
`LiftData`	`getLiftData()` Gets the value of the liftData 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.
`String`	`getTargetField()` Gets the value of the targetField property.
`void`	`setAdjRSquared(Double value)` Sets the value of the adjRSquared property.
`void`	`setAIC(Double value)` Sets the value of the aic property.
`void`	`setAICc(Double value)` Sets the value of the aiCc property.
`void`	`setBIC(Double value)` Sets the value of the bic property.
`void`	`setConfusionMatrix(ConfusionMatrix value)` Sets the value of the confusionMatrix property.
`void`	`setDataName(String value)` Sets the value of the dataName property.
`void`	`setDataUsage(String value)` Sets the value of the dataUsage property.
`void`	`setDegreesOfFreedom(Double value)` Sets the value of the degreesOfFreedom property.
`void`	`setFStatistic(Double value)` Sets the value of the fStatistic property.
`void`	`setLiftData(LiftData value)` Sets the value of the liftData property.
`void`	`setMeanAbsoluteError(Double value)` Sets the value of the meanAbsoluteError property.
`void`	`setMeanError(Double value)` Sets the value of the meanError property.
`void`	`setMeanSquaredError(Double value)` Sets the value of the meanSquaredError property.
`void`	`setNumOfPredictors(Double value)` Sets the value of the numOfPredictors property.
`void`	`setNumOfRecords(Double value)` Sets the value of the numOfRecords property.
`void`	`setNumOfRecordsWeighted(Double value)` Sets the value of the numOfRecordsWeighted property.
`void`	`setROC(ROC value)` Sets the value of the roc property.
`void`	`setRootMeanSquaredError(Double value)` Sets the value of the rootMeanSquaredError property.
`void`	`setRSquared(Double value)` Sets the value of the rSquared property.
`void`	`setSourceLocation(Locator newLocator)`
`void`	`setSumSquaredError(Double value)` Sets the value of the sumSquaredError property.
`void`	`setSumSquaredRegression(Double value)` Sets the value of the sumSquaredRegression property.
`void`	`setTargetField(String value)` Sets the value of the targetField property.
`Locator`	`sourceLocation()`
`PredictiveModelQuality`	`withAdjRSquared(Double value)`
`PredictiveModelQuality`	`withAIC(Double value)`
`PredictiveModelQuality`	`withAICc(Double value)`
`PredictiveModelQuality`	`withBIC(Double value)`
`PredictiveModelQuality`	`withConfusionMatrix(ConfusionMatrix value)`
`PredictiveModelQuality`	`withDataName(String value)`
`PredictiveModelQuality`	`withDataUsage(String value)`
`PredictiveModelQuality`	`withDegreesOfFreedom(Double value)`
`PredictiveModelQuality`	`withExtensions(Collection<Extension> values)`
`PredictiveModelQuality`	`withExtensions(Extension... values)`
`PredictiveModelQuality`	`withFStatistic(Double value)`
`PredictiveModelQuality`	`withLiftData(LiftData value)`
`PredictiveModelQuality`	`withMeanAbsoluteError(Double value)`
`PredictiveModelQuality`	`withMeanError(Double value)`
`PredictiveModelQuality`	`withMeanSquaredError(Double value)`
`PredictiveModelQuality`	`withNumOfPredictors(Double value)`
`PredictiveModelQuality`	`withNumOfRecords(Double value)`
`PredictiveModelQuality`	`withNumOfRecordsWeighted(Double value)`
`PredictiveModelQuality`	`withROC(ROC value)`
`PredictiveModelQuality`	`withRootMeanSquaredError(Double value)`
`PredictiveModelQuality`	`withRSquared(Double value)`
`PredictiveModelQuality`	`withSumSquaredError(Double value)`
`PredictiveModelQuality`	`withSumSquaredRegression(Double value)`
`PredictiveModelQuality`	`withTargetField(String 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
```
  - confusionMatrix
```
protected ConfusionMatrix confusionMatrix
```
  - liftData
```
protected LiftData liftData
```
  - roc
```
protected ROC roc
```
  - targetField
```
protected String targetField
```
  - dataName
```
protected String dataName
```
  - dataUsage
```
protected String dataUsage
```
  - meanError
```
protected Double meanError
```
  - meanAbsoluteError
```
protected Double meanAbsoluteError
```
  - meanSquaredError
```
protected Double meanSquaredError
```
  - rootMeanSquaredError
```
protected Double rootMeanSquaredError
```
  - rSquared
```
protected Double rSquared
```
  - adjRSquared
```
protected Double adjRSquared
```
  - sumSquaredError
```
protected Double sumSquaredError
```
  - sumSquaredRegression
```
protected Double sumSquaredRegression
```
  - numOfRecords
```
protected Double numOfRecords
```
  - numOfRecordsWeighted
```
protected Double numOfRecordsWeighted
```
  - numOfPredictors
```
protected Double numOfPredictors
```
  - degreesOfFreedom
```
protected Double degreesOfFreedom
```
  - fStatistic
```
protected Double fStatistic
```
  - aic
```
protected Double aic
```
  - bic
```
protected Double bic
```
  - aiCc
```
protected Double aiCc
```
  - locator
```
protected Locator locator
```
- Constructor Detail
  - PredictiveModelQuality
```
public PredictiveModelQuality()
```
  - PredictiveModelQuality
```
public PredictiveModelQuality(String targetField)
```
- 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
  - getConfusionMatrix
```
public ConfusionMatrix getConfusionMatrix()
```
    Gets the value of the confusionMatrix property.
    
    Returns:
    possible object is ConfusionMatrix
  - setConfusionMatrix
```
public void setConfusionMatrix(ConfusionMatrix value)
```
    Sets the value of the confusionMatrix property.
    
    Parameters:
    value - allowed object is ConfusionMatrix
  - getLiftData
```
public LiftData getLiftData()
```
    Gets the value of the liftData property.
    
    Returns:
    possible object is LiftData
  - setLiftData
```
public void setLiftData(LiftData value)
```
    Sets the value of the liftData property.
    
    Parameters:
    value - allowed object is LiftData
  - getROC
```
public ROC getROC()
```
    Gets the value of the roc property.
    
    Returns:
    possible object is ROC
  - setROC
```
public void setROC(ROC value)
```
    Sets the value of the roc property.
    
    Parameters:
    value - allowed object is ROC
  - getTargetField
```
public String getTargetField()
```
    Gets the value of the targetField property.
    
    Returns:
    possible object is String
  - setTargetField
```
public void setTargetField(String value)
```
    Sets the value of the targetField property.
    
    Parameters:
    value - allowed object is String
  - getDataName
```
public String getDataName()
```
    Gets the value of the dataName property.
    
    Returns:
    possible object is String
  - setDataName
```
public void setDataName(String value)
```
    Sets the value of the dataName property.
    
    Parameters:
    value - allowed object is String
  - getDataUsage
```
public String getDataUsage()
```
    Gets the value of the dataUsage property.
    
    Returns:
    possible object is String
  - setDataUsage
```
public void setDataUsage(String value)
```
    Sets the value of the dataUsage property.
    
    Parameters:
    value - allowed object is String
  - getMeanError
```
public Double getMeanError()
```
    Gets the value of the meanError property.
    
    Returns:
    possible object is Double
  - setMeanError
```
public void setMeanError(Double value)
```
    Sets the value of the meanError property.
    
    Parameters:
    value - allowed object is Double
  - getMeanAbsoluteError
```
public Double getMeanAbsoluteError()
```
    Gets the value of the meanAbsoluteError property.
    
    Returns:
    possible object is Double
  - setMeanAbsoluteError
```
public void setMeanAbsoluteError(Double value)
```
    Sets the value of the meanAbsoluteError property.
    
    Parameters:
    value - allowed object is Double
  - getMeanSquaredError
```
public Double getMeanSquaredError()
```
    Gets the value of the meanSquaredError property.
    
    Returns:
    possible object is Double
  - setMeanSquaredError
```
public void setMeanSquaredError(Double value)
```
    Sets the value of the meanSquaredError property.
    
    Parameters:
    value - allowed object is Double
  - getRootMeanSquaredError
```
public Double getRootMeanSquaredError()
```
    Gets the value of the rootMeanSquaredError property.
    
    Returns:
    possible object is Double
  - setRootMeanSquaredError
```
public void setRootMeanSquaredError(Double value)
```
    Sets the value of the rootMeanSquaredError property.
    
    Parameters:
    value - allowed object is Double
  - getRSquared
```
public Double getRSquared()
```
    Gets the value of the rSquared property.
    
    Returns:
    possible object is Double
  - setRSquared
```
public void setRSquared(Double value)
```
    Sets the value of the rSquared property.
    
    Parameters:
    value - allowed object is Double
  - getAdjRSquared
```
public Double getAdjRSquared()
```
    Gets the value of the adjRSquared property.
    
    Returns:
    possible object is Double
  - setAdjRSquared
```
public void setAdjRSquared(Double value)
```
    Sets the value of the adjRSquared property.
    
    Parameters:
    value - allowed object is Double
  - getSumSquaredError
```
public Double getSumSquaredError()
```
    Gets the value of the sumSquaredError property.
    
    Returns:
    possible object is Double
  - setSumSquaredError
```
public void setSumSquaredError(Double value)
```
    Sets the value of the sumSquaredError property.
    
    Parameters:
    value - allowed object is Double
  - getSumSquaredRegression
```
public Double getSumSquaredRegression()
```
    Gets the value of the sumSquaredRegression property.
    
    Returns:
    possible object is Double
  - setSumSquaredRegression
```
public void setSumSquaredRegression(Double value)
```
    Sets the value of the sumSquaredRegression property.
    
    Parameters:
    value - allowed object is Double
  - getNumOfRecords
```
public Double getNumOfRecords()
```
    Gets the value of the numOfRecords property.
    
    Returns:
    possible object is Double
  - setNumOfRecords
```
public void setNumOfRecords(Double value)
```
    Sets the value of the numOfRecords property.
    
    Parameters:
    value - allowed object is Double
  - getNumOfRecordsWeighted
```
public Double getNumOfRecordsWeighted()
```
    Gets the value of the numOfRecordsWeighted property.
    
    Returns:
    possible object is Double
  - setNumOfRecordsWeighted
```
public void setNumOfRecordsWeighted(Double value)
```
    Sets the value of the numOfRecordsWeighted property.
    
    Parameters:
    value - allowed object is Double
  - getNumOfPredictors
```
public Double getNumOfPredictors()
```
    Gets the value of the numOfPredictors property.
    
    Returns:
    possible object is Double
  - setNumOfPredictors
```
public void setNumOfPredictors(Double value)
```
    Sets the value of the numOfPredictors property.
    
    Parameters:
    value - allowed object is Double
  - getDegreesOfFreedom
```
public Double getDegreesOfFreedom()
```
    Gets the value of the degreesOfFreedom property.
    
    Returns:
    possible object is Double
  - setDegreesOfFreedom
```
public void setDegreesOfFreedom(Double value)
```
    Sets the value of the degreesOfFreedom property.
    
    Parameters:
    value - allowed object is Double
  - getFStatistic
```
public Double getFStatistic()
```
    Gets the value of the fStatistic property.
    
    Returns:
    possible object is Double
  - setFStatistic
```
public void setFStatistic(Double value)
```
    Sets the value of the fStatistic property.
    
    Parameters:
    value - allowed object is Double
  - getAIC
```
public Double getAIC()
```
    Gets the value of the aic property.
    
    Returns:
    possible object is Double
  - setAIC
```
public void setAIC(Double value)
```
    Sets the value of the aic property.
    
    Parameters:
    value - allowed object is Double
  - getBIC
```
public Double getBIC()
```
    Gets the value of the bic property.
    
    Returns:
    possible object is Double
  - setBIC
```
public void setBIC(Double value)
```
    Sets the value of the bic property.
    
    Parameters:
    value - allowed object is Double
  - getAICc
```
public Double getAICc()
```
    Gets the value of the aiCc property.
    
    Returns:
    possible object is Double
  - setAICc
```
public void setAICc(Double value)
```
    Sets the value of the aiCc property.
    
    Parameters:
    value - allowed object is Double
  - withExtensions
```
public PredictiveModelQuality withExtensions(Extension... values)
```
  - withExtensions
```
public PredictiveModelQuality withExtensions(Collection<Extension> values)
```
  - withConfusionMatrix
```
public PredictiveModelQuality withConfusionMatrix(ConfusionMatrix value)
```
  - withLiftData
```
public PredictiveModelQuality withLiftData(LiftData value)
```
  - withROC
```
public PredictiveModelQuality withROC(ROC value)
```
  - withTargetField
```
public PredictiveModelQuality withTargetField(String value)
```
  - withDataName
```
public PredictiveModelQuality withDataName(String value)
```
  - withDataUsage
```
public PredictiveModelQuality withDataUsage(String value)
```
  - withMeanError
```
public PredictiveModelQuality withMeanError(Double value)
```
  - withMeanAbsoluteError
```
public PredictiveModelQuality withMeanAbsoluteError(Double value)
```
  - withMeanSquaredError
```
public PredictiveModelQuality withMeanSquaredError(Double value)
```
  - withRootMeanSquaredError
```
public PredictiveModelQuality withRootMeanSquaredError(Double value)
```
  - withRSquared
```
public PredictiveModelQuality withRSquared(Double value)
```
  - withAdjRSquared
```
public PredictiveModelQuality withAdjRSquared(Double value)
```
  - withSumSquaredError
```
public PredictiveModelQuality withSumSquaredError(Double value)
```
  - withSumSquaredRegression
```
public PredictiveModelQuality withSumSquaredRegression(Double value)
```
  - withNumOfRecords
```
public PredictiveModelQuality withNumOfRecords(Double value)
```
  - withNumOfRecordsWeighted
```
public PredictiveModelQuality withNumOfRecordsWeighted(Double value)
```
  - withNumOfPredictors
```
public PredictiveModelQuality withNumOfPredictors(Double value)
```
  - withDegreesOfFreedom
```
public PredictiveModelQuality withDegreesOfFreedom(Double value)
```
  - withFStatistic
```
public PredictiveModelQuality withFStatistic(Double value)
```
  - withAIC
```
public PredictiveModelQuality withAIC(Double value)
```
  - withBIC
```
public PredictiveModelQuality withBIC(Double value)
```
  - withAICc
```
public PredictiveModelQuality withAICc(Double 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

Class PredictiveModelQuality

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensions

confusionMatrix

liftData

roc

targetField

dataName

dataUsage

meanError

meanAbsoluteError

meanSquaredError

rootMeanSquaredError

rSquared

adjRSquared

sumSquaredError

sumSquaredRegression

numOfRecords

numOfRecordsWeighted

numOfPredictors

degreesOfFreedom

fStatistic

aic

bic

aiCc

locator

Constructor Detail

PredictiveModelQuality

PredictiveModelQuality

Method Detail

getExtensions

getConfusionMatrix

setConfusionMatrix

getLiftData

setLiftData

getROC

setROC

getTargetField

setTargetField

getDataName

setDataName

getDataUsage

setDataUsage

getMeanError

setMeanError

getMeanAbsoluteError

setMeanAbsoluteError

getMeanSquaredError

setMeanSquaredError

getRootMeanSquaredError

setRootMeanSquaredError

getRSquared

setRSquared

getAdjRSquared

setAdjRSquared

getSumSquaredError

setSumSquaredError

getSumSquaredRegression

setSumSquaredRegression

getNumOfRecords

setNumOfRecords

getNumOfRecordsWeighted

setNumOfRecordsWeighted

getNumOfPredictors

setNumOfPredictors

getDegreesOfFreedom

setDegreesOfFreedom

getFStatistic

setFStatistic

getAIC

setAIC

getBIC

setBIC

getAICc

setAICc

withExtensions