org.dmg.pmml.scorecard

Class Scorecard

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.scorecard.Scorecard

All Implemented Interfaces:

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_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}Characteristics"/>
         <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="initialScore" type="{http://www.dmg.org/PMML-4_3}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_3}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.

Constructor Summary

Constructors

Constructor and Description
Scorecard()
Scorecard(MiningFunction miningFunction, MiningSchema miningSchema, Characteristics characteristics)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
Scorecard	addExtensions(Extension... extensions)
String	getAlgorithmName() Gets the value of the algorithmName property.
Scorecard.BaselineMethod	getBaselineMethod() Gets the value of the baselineMethod property.
Double	getBaselineScore() Gets the value of the baselineScore property.
Characteristics	getCharacteristics() Gets the value of the characteristics property.
List<Extension>	getExtensions() Gets the value of the extensions property.
Double	getInitialScore() Gets the value of the initialScore 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.
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.
Scorecard	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
Scorecard	setBaselineMethod(Scorecard.BaselineMethod baselineMethod) Sets the value of the baselineMethod property.
Scorecard	setBaselineScore(Double baselineScore) Sets the value of the baselineScore property.
Scorecard	setCharacteristics(Characteristics characteristics) Sets the value of the characteristics property.
Scorecard	setInitialScore(Double initialScore) Sets the value of the initialScore property.
Scorecard	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
Scorecard	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
Scorecard	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
Scorecard	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
Scorecard	setModelName(String modelName) Sets the value of the modelName property.
Scorecard	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
Scorecard	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
Scorecard	setOutput(Output output) Sets the value of the output property.
Scorecard	setReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm reasonCodeAlgorithm) Sets the value of the reasonCodeAlgorithm property.
Scorecard	setScorable(Boolean scorable) Sets the value of the scorable property.
Scorecard	setTargets(Targets targets) Sets the value of the targets property.
Scorecard	setUseReasonCodes(Boolean useReasonCodes) Sets the value of the useReasonCodes 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

Scorecard

public Scorecard()

Scorecard

public Scorecard(MiningFunction miningFunction,
         MiningSchema miningSchema,
         Characteristics characteristics)

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

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getInitialScore

public Double getInitialScore()

Gets the value of the initialScore property.

Returns:

possible object is Double

setInitialScore

public Scorecard setInitialScore(Double initialScore)

Sets the value of the initialScore property.

Parameters:

initialScore - allowed object is Double

isUseReasonCodes

public boolean isUseReasonCodes()

Gets the value of the useReasonCodes property.

Returns:

possible object is Boolean

setUseReasonCodes

public Scorecard setUseReasonCodes(Boolean useReasonCodes)

Sets the value of the useReasonCodes property.

Parameters:

useReasonCodes - allowed object is Boolean

getReasonCodeAlgorithm

public Scorecard.ReasonCodeAlgorithm getReasonCodeAlgorithm()

Gets the value of the reasonCodeAlgorithm property.

Returns:

possible object is Scorecard.ReasonCodeAlgorithm

setReasonCodeAlgorithm

public Scorecard setReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm reasonCodeAlgorithm)

Sets the value of the reasonCodeAlgorithm property.

Parameters:

reasonCodeAlgorithm - allowed object is Scorecard.ReasonCodeAlgorithm

getBaselineScore

public Double getBaselineScore()

Gets the value of the baselineScore property.

Returns:

possible object is Double

setBaselineScore

public Scorecard setBaselineScore(Double baselineScore)

Sets the value of the baselineScore property.

Parameters:

baselineScore - allowed object is Double

getBaselineMethod

public Scorecard.BaselineMethod getBaselineMethod()

Gets the value of the baselineMethod property.

Returns:

possible object is Scorecard.BaselineMethod

setBaselineMethod

public Scorecard setBaselineMethod(Scorecard.BaselineMethod baselineMethod)

Sets the value of the baselineMethod property.

Parameters:

baselineMethod - 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 Scorecard 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 Scorecard 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 Scorecard 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 Scorecard 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 Scorecard 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 Scorecard 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 Scorecard setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getCharacteristics

public Characteristics getCharacteristics()

Gets the value of the characteristics property.

Returns:

possible object is Characteristics

setCharacteristics

public Scorecard setCharacteristics(Characteristics characteristics)

Sets the value of the characteristics property.

Parameters:

characteristics - allowed object is Characteristics

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

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

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable