Scorecard (Drools :: PMML - Compiler 6.3.0.CR1 API)

java.lang.Object
- org.dmg.pmml.pmml_4_2.descr.Scorecard

All Implemented Interfaces:: Serializable

public class Scorecard
extends Object
implements Serializable

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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" 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

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`algorithmName`
`protected String`	`baselineMethod`
`protected Double`	`baselineScore`
`protected List<Serializable>`	`extensionsAndCharacteristicsAndMiningSchemas`
`protected MININGFUNCTION`	`functionName`
`protected Double`	`initialScore`
`protected Boolean`	`isScorable`
`protected String`	`modelName`
`protected String`	`reasonCodeAlgorithm`
`protected Boolean`	`useReasonCodes`

Constructor Summary

Constructors
Constructor and Description

Scorecard()

Constructors
Constructor and Description
`Scorecard()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAlgorithmName()` Gets the value of the algorithmName property.
`String`	`getBaselineMethod()` Gets the value of the baselineMethod property.
`Double`	`getBaselineScore()` Gets the value of the baselineScore property.
`List<Serializable>`	`getExtensionsAndCharacteristicsAndMiningSchemas()` Gets the value of the extensionsAndCharacteristicsAndMiningSchemas property.
`MININGFUNCTION`	`getFunctionName()` Gets the value of the functionName property.
`double`	`getInitialScore()` Gets the value of the initialScore property.
`String`	`getModelName()` Gets the value of the modelName property.
`String`	`getReasonCodeAlgorithm()` Gets the value of the reasonCodeAlgorithm property.
`boolean`	`isIsScorable()` Gets the value of the isScorable property.
`boolean`	`isUseReasonCodes()` Gets the value of the useReasonCodes property.
`void`	`setAlgorithmName(String value)` Sets the value of the algorithmName property.
`void`	`setBaselineMethod(String value)` Sets the value of the baselineMethod property.
`void`	`setBaselineScore(Double value)` Sets the value of the baselineScore property.
`void`	`setFunctionName(MININGFUNCTION value)` Sets the value of the functionName property.
`void`	`setInitialScore(Double value)` Sets the value of the initialScore property.
`void`	`setIsScorable(Boolean value)` Sets the value of the isScorable property.
`void`	`setModelName(String value)` Sets the value of the modelName property.
`void`	`setReasonCodeAlgorithm(String value)` Sets the value of the reasonCodeAlgorithm property.
`void`	`setUseReasonCodes(Boolean value)` Sets the value of the useReasonCodes property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - extensionsAndCharacteristicsAndMiningSchemas
```
protected List<Serializable> extensionsAndCharacteristicsAndMiningSchemas
```
  - modelName
```
protected String modelName
```
  - functionName
```
protected MININGFUNCTION functionName
```
  - algorithmName
```
protected String algorithmName
```
  - initialScore
```
protected Double initialScore
```
  - useReasonCodes
```
protected Boolean useReasonCodes
```
  - reasonCodeAlgorithm
```
protected String reasonCodeAlgorithm
```
  - baselineScore
```
protected Double baselineScore
```
  - baselineMethod
```
protected String baselineMethod
```
  - isScorable
```
protected Boolean isScorable
```
- Constructor Detail
  - Scorecard
```
public Scorecard()
```
- Method Detail
  - getExtensionsAndCharacteristicsAndMiningSchemas
```
public List<Serializable> getExtensionsAndCharacteristicsAndMiningSchemas()
```
    Gets the value of the extensionsAndCharacteristicsAndMiningSchemas 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 extensionsAndCharacteristicsAndMiningSchemas property.
    For example, to add a new item, do as follows:
```
    getExtensionsAndCharacteristicsAndMiningSchemas().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Extension Characteristics ModelVerification Targets LocalTransformations ModelStats ModelExplanation Output MiningSchema
  - getModelName
```
public String getModelName()
```
    Gets the value of the modelName property.
    
    Returns:
    possible object is String
  - setModelName
```
public void setModelName(String value)
```
    Sets the value of the modelName property.
    
    Parameters:
    value - allowed object is String
  - getFunctionName
```
public MININGFUNCTION getFunctionName()
```
    Gets the value of the functionName property.
    
    Returns:
    possible object is MININGFUNCTION
  - setFunctionName
```
public void setFunctionName(MININGFUNCTION value)
```
    Sets the value of the functionName property.
    
    Parameters:
    value - allowed object is MININGFUNCTION
  - 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
  - getInitialScore
```
public double getInitialScore()
```
    Gets the value of the initialScore property.
    
    Returns:
    possible object is Double
  - setInitialScore
```
public void setInitialScore(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(Boolean value)
```
    Sets the value of the useReasonCodes property.
    
    Parameters:
    value - allowed object is Boolean
  - getReasonCodeAlgorithm
```
public String getReasonCodeAlgorithm()
```
    Gets the value of the reasonCodeAlgorithm property.
    
    Returns:
    possible object is String
  - setReasonCodeAlgorithm
```
public void setReasonCodeAlgorithm(String value)
```
    Sets the value of the reasonCodeAlgorithm property.
    
    Parameters:
    value - allowed object is String
  - getBaselineScore
```
public Double getBaselineScore()
```
    Gets the value of the baselineScore property.
    
    Returns:
    possible object is Double
  - setBaselineScore
```
public void setBaselineScore(Double value)
```
    Sets the value of the baselineScore property.
    
    Parameters:
    value - allowed object is Double
  - getBaselineMethod
```
public String getBaselineMethod()
```
    Gets the value of the baselineMethod property.
    
    Returns:
    possible object is String
  - setBaselineMethod
```
public void setBaselineMethod(String value)
```
    Sets the value of the baselineMethod property.
    
    Parameters:
    value - allowed object is String
  - isIsScorable
```
public boolean isIsScorable()
```
    Gets the value of the isScorable property.
    
    Returns:
    possible object is Boolean
  - setIsScorable
```
public void setIsScorable(Boolean value)
```
    Sets the value of the isScorable property.
    
    Parameters:
    value - allowed object is Boolean

Class Scorecard

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensionsAndCharacteristicsAndMiningSchemas

modelName

functionName

algorithmName

initialScore

useReasonCodes

reasonCodeAlgorithm

baselineScore

baselineMethod

isScorable

Constructor Detail

Scorecard

Method Detail

getExtensionsAndCharacteristicsAndMiningSchemas

getModelName

setModelName

getFunctionName

setFunctionName

getAlgorithmName

setAlgorithmName

getInitialScore

setInitialScore

isUseReasonCodes

setUseReasonCodes

getReasonCodeAlgorithm

setReasonCodeAlgorithm

getBaselineScore

setBaselineScore

getBaselineMethod

setBaselineMethod

isIsScorable

setIsScorable