org.dmg.pmml

Class Scorecard

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.Scorecard

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasLocator, Visitable

public class Scorecard
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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Characteristics"/>
         <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="initialScore" type="{http://www.dmg.org/PMML-4_2}NUMBER" default="0" />
       <attribute name="useReasonCodes" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="reasonCodeAlgorithm" default="pointsBelow">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="pointsAbove"/>
             <enumeration value="pointsBelow"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="baselineScore" type="{http://www.dmg.org/PMML-4_2}NUMBER" />
       <attribute name="baselineMethod" default="other">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="max"/>
             <enumeration value="min"/>
             <enumeration value="mean"/>
             <enumeration value="neutral"/>
             <enumeration value="other"/>
           </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	Scorecard.BaselineMethod Java class for null.
static class	Scorecard.ReasonCodeAlgorithm Java class for null.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algorithmName
protected Scorecard.BaselineMethod	baselineMethod
protected java.lang.Double	baselineScore
protected Characteristics	characteristics
protected java.util.List<Extension>	extensions
protected MiningFunctionType	functionName
protected java.lang.Double	initialScore
protected LocalTransformations	localTransformations
protected MiningSchema	miningSchema
protected ModelExplanation	modelExplanation
protected java.lang.String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected Output	output
protected Scorecard.ReasonCodeAlgorithm	reasonCodeAlgorithm
protected java.lang.Boolean	scorable
protected Targets	targets
protected java.lang.Boolean	useReasonCodes

Constructor Summary

Constructors

Constructor and Description
Scorecard()
Scorecard(MiningFunctionType functionName, MiningSchema miningSchema, Characteristics characteristics)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
java.lang.String	getAlgorithmName() Gets the value of the algorithmName property.
Scorecard.BaselineMethod	getBaselineMethod() Gets the value of the baselineMethod property.
java.lang.Double	getBaselineScore() Gets the value of the baselineScore property.
Characteristics	getCharacteristics() Gets the value of the characteristics property.
java.util.List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
double	getInitialScore() Gets the value of the initialScore 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.
java.lang.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.
Scorecard.ReasonCodeAlgorithm	getReasonCodeAlgorithm() Gets the value of the reasonCodeAlgorithm property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasExtensions()
boolean	isScorable() Gets the value of the scorable property.
boolean	isUseReasonCodes() Gets the value of the useReasonCodes property.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setBaselineMethod(Scorecard.BaselineMethod value) Sets the value of the baselineMethod property.
void	setBaselineScore(java.lang.Double value) Sets the value of the baselineScore property.
void	setCharacteristics(Characteristics value) Sets the value of the characteristics property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setInitialScore(java.lang.Double value) Sets the value of the initialScore 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(java.lang.String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setOutput(Output value) Sets the value of the output property.
void	setReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm value) Sets the value of the reasonCodeAlgorithm property.
void	setScorable(java.lang.Boolean value) Sets the value of the scorable property.
void	setTargets(Targets value) Sets the value of the targets property.
void	setUseReasonCodes(java.lang.Boolean value) Sets the value of the useReasonCodes property.
Scorecard	withAlgorithmName(java.lang.String value)
Scorecard	withBaselineMethod(Scorecard.BaselineMethod value)
Scorecard	withBaselineScore(java.lang.Double value)
Scorecard	withCharacteristics(Characteristics value)
Scorecard	withExtensions(java.util.Collection<Extension> values)
Scorecard	withExtensions(Extension... values)
Scorecard	withFunctionName(MiningFunctionType value)
Scorecard	withInitialScore(java.lang.Double value)
Scorecard	withLocalTransformations(LocalTransformations value)
Scorecard	withMiningSchema(MiningSchema value)
Scorecard	withModelExplanation(ModelExplanation value)
Scorecard	withModelName(java.lang.String value)
Scorecard	withModelStats(ModelStats value)
Scorecard	withModelVerification(ModelVerification value)
Scorecard	withOutput(Output value)
Scorecard	withReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm value)
Scorecard	withScorable(java.lang.Boolean value)
Scorecard	withTargets(Targets value)
Scorecard	withUseReasonCodes(java.lang.Boolean value)

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

Field Detail

modelName

protected java.lang.String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected java.lang.String algorithmName

initialScore

protected java.lang.Double initialScore

useReasonCodes

protected java.lang.Boolean useReasonCodes

reasonCodeAlgorithm

protected Scorecard.ReasonCodeAlgorithm reasonCodeAlgorithm

baselineScore

protected java.lang.Double baselineScore

baselineMethod

protected Scorecard.BaselineMethod baselineMethod

scorable

protected java.lang.Boolean scorable

extensions

protected java.util.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

characteristics

protected Characteristics characteristics

modelVerification

protected ModelVerification modelVerification

Constructor Detail

Scorecard

public Scorecard()

Scorecard

public Scorecard(MiningFunctionType functionName,
         MiningSchema miningSchema,
         Characteristics characteristics)

Method Detail

getModelName

public java.lang.String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public void setModelName(java.lang.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 java.lang.String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(java.lang.String value)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

value - allowed object is String

getInitialScore

public double getInitialScore()

Gets the value of the initialScore property.

Returns:

possible object is Double

setInitialScore

public void setInitialScore(java.lang.Double value)

Sets the value of the initialScore property.

Parameters:

value - allowed object is Double

isUseReasonCodes

public boolean isUseReasonCodes()

Gets the value of the useReasonCodes property.

Returns:

possible object is Boolean

setUseReasonCodes

public void setUseReasonCodes(java.lang.Boolean value)

Sets the value of the useReasonCodes property.

Parameters:

value - allowed object is Boolean

getReasonCodeAlgorithm

public Scorecard.ReasonCodeAlgorithm getReasonCodeAlgorithm()

Gets the value of the reasonCodeAlgorithm property.

Returns:

possible object is Scorecard.ReasonCodeAlgorithm

setReasonCodeAlgorithm

public void setReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm value)

Sets the value of the reasonCodeAlgorithm property.

Parameters:

value - allowed object is Scorecard.ReasonCodeAlgorithm

getBaselineScore

public java.lang.Double getBaselineScore()

Gets the value of the baselineScore property.

Returns:

possible object is Double

setBaselineScore

public void setBaselineScore(java.lang.Double value)

Sets the value of the baselineScore property.

Parameters:

value - allowed object is Double

getBaselineMethod

public Scorecard.BaselineMethod getBaselineMethod()

Gets the value of the baselineMethod property.

Returns:

possible object is Scorecard.BaselineMethod

setBaselineMethod

public void setBaselineMethod(Scorecard.BaselineMethod value)

Sets the value of the baselineMethod property.

Parameters:

value - allowed object is Scorecard.BaselineMethod

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(java.lang.Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - allowed object is Boolean

getExtensions

public java.util.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.

Specified by:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

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

getCharacteristics

public Characteristics getCharacteristics()

Gets the value of the characteristics property.

Returns:

possible object is Characteristics

setCharacteristics

public void setCharacteristics(Characteristics value)

Sets the value of the characteristics property.

Parameters:

value - allowed object is Characteristics

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Specified by:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

value - allowed object is ModelVerification

withModelName

public Scorecard withModelName(java.lang.String value)

withFunctionName

public Scorecard withFunctionName(MiningFunctionType value)

withAlgorithmName

public Scorecard withAlgorithmName(java.lang.String value)

withInitialScore

public Scorecard withInitialScore(java.lang.Double value)

withUseReasonCodes

public Scorecard withUseReasonCodes(java.lang.Boolean value)

withReasonCodeAlgorithm

public Scorecard withReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm value)

withBaselineScore

public Scorecard withBaselineScore(java.lang.Double value)

withBaselineMethod

public Scorecard withBaselineMethod(Scorecard.BaselineMethod value)

withScorable

public Scorecard withScorable(java.lang.Boolean value)

withExtensions

public Scorecard withExtensions(Extension... values)

withExtensions

public Scorecard withExtensions(java.util.Collection<Extension> values)

withMiningSchema

public Scorecard withMiningSchema(MiningSchema value)

withOutput

public Scorecard withOutput(Output value)

withModelStats

public Scorecard withModelStats(ModelStats value)

withModelExplanation

public Scorecard withModelExplanation(ModelExplanation value)

withTargets

public Scorecard withTargets(Targets value)

withLocalTransformations

public Scorecard withLocalTransformations(LocalTransformations value)

withCharacteristics

public Scorecard withCharacteristics(Characteristics value)

withModelVerification

public Scorecard withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable