org.dmg.pmml.Scorecard Maven / Gradle / Ivy
package org.dmg.pmml;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlEnumValue;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;
import com.sun.xml.bind.Locatable;
import com.sun.xml.bind.annotation.XmlLocation;
import org.jpmml.schema.Added;
import org.jpmml.schema.Version;
import org.xml.sax.Locator;
/**
* 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>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"targets",
"localTransformations",
"characteristics",
"modelVerification"
})
@XmlRootElement(name = "Scorecard")
@Added(Version.PMML_4_1)
public class Scorecard
extends Model
implements Locatable, HasExtensions
{
@XmlElement(name = "Extension")
protected List extensions;
@XmlElement(name = "MiningSchema", required = true)
protected MiningSchema miningSchema;
@XmlElement(name = "Output")
protected Output output;
@XmlElement(name = "ModelStats")
protected ModelStats modelStats;
@XmlElement(name = "ModelExplanation")
protected ModelExplanation modelExplanation;
@XmlElement(name = "Targets")
protected Targets targets;
@XmlElement(name = "LocalTransformations")
protected LocalTransformations localTransformations;
@XmlElement(name = "Characteristics", required = true)
protected Characteristics characteristics;
@XmlElement(name = "ModelVerification")
protected ModelVerification modelVerification;
@XmlAttribute(name = "modelName")
protected String modelName;
@XmlAttribute(name = "functionName", required = true)
protected MiningFunctionType functionName;
@XmlAttribute(name = "algorithmName")
protected String algorithmName;
@XmlAttribute(name = "initialScore")
protected Double initialScore;
@XmlAttribute(name = "useReasonCodes")
protected Boolean useReasonCodes;
@XmlAttribute(name = "reasonCodeAlgorithm")
protected Scorecard.ReasonCodeAlgorithm reasonCodeAlgorithm;
@XmlAttribute(name = "baselineScore")
protected Double baselineScore;
@XmlAttribute(name = "baselineMethod")
protected Scorecard.BaselineMethod baselineMethod;
@XmlAttribute(name = "isScorable")
@Added(Version.PMML_4_1)
protected Boolean scorable;
@XmlLocation
@XmlTransient
protected Locator locator;
public Scorecard() {
super();
}
public Scorecard(final MiningSchema miningSchema, final Characteristics characteristics, final MiningFunctionType functionName) {
super();
this.miningSchema = miningSchema;
this.characteristics = characteristics;
this.functionName = functionName;
}
/**
* 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
* {@link Extension }
*
*
*/
public List getExtensions() {
if (extensions == null) {
extensions = new ArrayList();
}
return this.extensions;
}
/**
* Gets the value of the miningSchema property.
*
* @return
* possible object is
* {@link MiningSchema }
*
*/
public MiningSchema getMiningSchema() {
return miningSchema;
}
/**
* Sets the value of the miningSchema property.
*
* @param value
* allowed object is
* {@link MiningSchema }
*
*/
public void setMiningSchema(MiningSchema value) {
this.miningSchema = value;
}
/**
* Gets the value of the output property.
*
* @return
* possible object is
* {@link Output }
*
*/
public Output getOutput() {
return output;
}
/**
* Sets the value of the output property.
*
* @param value
* allowed object is
* {@link Output }
*
*/
public void setOutput(Output value) {
this.output = value;
}
/**
* Gets the value of the modelStats property.
*
* @return
* possible object is
* {@link ModelStats }
*
*/
public ModelStats getModelStats() {
return modelStats;
}
/**
* Sets the value of the modelStats property.
*
* @param value
* allowed object is
* {@link ModelStats }
*
*/
public void setModelStats(ModelStats value) {
this.modelStats = value;
}
/**
* Gets the value of the modelExplanation property.
*
* @return
* possible object is
* {@link ModelExplanation }
*
*/
public ModelExplanation getModelExplanation() {
return modelExplanation;
}
/**
* Sets the value of the modelExplanation property.
*
* @param value
* allowed object is
* {@link ModelExplanation }
*
*/
public void setModelExplanation(ModelExplanation value) {
this.modelExplanation = value;
}
/**
* Gets the value of the targets property.
*
* @return
* possible object is
* {@link Targets }
*
*/
public Targets getTargets() {
return targets;
}
/**
* Sets the value of the targets property.
*
* @param value
* allowed object is
* {@link Targets }
*
*/
public void setTargets(Targets value) {
this.targets = value;
}
/**
* Gets the value of the localTransformations property.
*
* @return
* possible object is
* {@link LocalTransformations }
*
*/
public LocalTransformations getLocalTransformations() {
return localTransformations;
}
/**
* Sets the value of the localTransformations property.
*
* @param value
* allowed object is
* {@link LocalTransformations }
*
*/
public void setLocalTransformations(LocalTransformations value) {
this.localTransformations = value;
}
/**
* Gets the value of the characteristics property.
*
* @return
* possible object is
* {@link Characteristics }
*
*/
public Characteristics getCharacteristics() {
return characteristics;
}
/**
* Sets the value of the characteristics property.
*
* @param value
* allowed object is
* {@link Characteristics }
*
*/
public void setCharacteristics(Characteristics value) {
this.characteristics = value;
}
/**
* Gets the value of the modelVerification property.
*
* @return
* possible object is
* {@link ModelVerification }
*
*/
public ModelVerification getModelVerification() {
return modelVerification;
}
/**
* Sets the value of the modelVerification property.
*
* @param value
* allowed object is
* {@link ModelVerification }
*
*/
public void setModelVerification(ModelVerification value) {
this.modelVerification = value;
}
/**
* Gets the value of the modelName property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getModelName() {
return modelName;
}
/**
* Sets the value of the modelName property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setModelName(String value) {
this.modelName = value;
}
/**
* Gets the value of the functionName property.
*
* @return
* possible object is
* {@link MiningFunctionType }
*
*/
public MiningFunctionType getFunctionName() {
return functionName;
}
/**
* Sets the value of the functionName property.
*
* @param value
* allowed object is
* {@link MiningFunctionType }
*
*/
public void setFunctionName(MiningFunctionType value) {
this.functionName = value;
}
/**
* Gets the value of the algorithmName property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getAlgorithmName() {
return algorithmName;
}
/**
* Sets the value of the algorithmName property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setAlgorithmName(String value) {
this.algorithmName = value;
}
/**
* Gets the value of the initialScore property.
*
* @return
* possible object is
* {@link Double }
*
*/
public double getInitialScore() {
if (initialScore == null) {
return 0.0D;
} else {
return initialScore;
}
}
/**
* Sets the value of the initialScore property.
*
* @param value
* allowed object is
* {@link Double }
*
*/
public void setInitialScore(Double value) {
this.initialScore = value;
}
/**
* Gets the value of the useReasonCodes property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public boolean isUseReasonCodes() {
if (useReasonCodes == null) {
return true;
} else {
return useReasonCodes;
}
}
/**
* Sets the value of the useReasonCodes property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setUseReasonCodes(Boolean value) {
this.useReasonCodes = value;
}
/**
* Gets the value of the reasonCodeAlgorithm property.
*
* @return
* possible object is
* {@link Scorecard.ReasonCodeAlgorithm }
*
*/
public Scorecard.ReasonCodeAlgorithm getReasonCodeAlgorithm() {
if (reasonCodeAlgorithm == null) {
return Scorecard.ReasonCodeAlgorithm.POINTS_BELOW;
} else {
return reasonCodeAlgorithm;
}
}
/**
* Sets the value of the reasonCodeAlgorithm property.
*
* @param value
* allowed object is
* {@link Scorecard.ReasonCodeAlgorithm }
*
*/
public void setReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm value) {
this.reasonCodeAlgorithm = value;
}
/**
* Gets the value of the baselineScore property.
*
* @return
* possible object is
* {@link Double }
*
*/
public Double getBaselineScore() {
return baselineScore;
}
/**
* Sets the value of the baselineScore property.
*
* @param value
* allowed object is
* {@link Double }
*
*/
public void setBaselineScore(Double value) {
this.baselineScore = value;
}
/**
* Gets the value of the baselineMethod property.
*
* @return
* possible object is
* {@link Scorecard.BaselineMethod }
*
*/
public Scorecard.BaselineMethod getBaselineMethod() {
if (baselineMethod == null) {
return Scorecard.BaselineMethod.OTHER;
} else {
return baselineMethod;
}
}
/**
* Sets the value of the baselineMethod property.
*
* @param value
* allowed object is
* {@link Scorecard.BaselineMethod }
*
*/
public void setBaselineMethod(Scorecard.BaselineMethod value) {
this.baselineMethod = value;
}
/**
* Gets the value of the scorable property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public boolean isScorable() {
if (scorable == null) {
return true;
} else {
return scorable;
}
}
/**
* Sets the value of the scorable property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setScorable(Boolean value) {
this.scorable = value;
}
public Scorecard withExtensions(Extension... values) {
if (values!= null) {
for (Extension value: values) {
getExtensions().add(value);
}
}
return this;
}
public Scorecard withExtensions(Collection values) {
if (values!= null) {
getExtensions().addAll(values);
}
return this;
}
public Scorecard withMiningSchema(MiningSchema value) {
setMiningSchema(value);
return this;
}
public Scorecard withOutput(Output value) {
setOutput(value);
return this;
}
public Scorecard withModelStats(ModelStats value) {
setModelStats(value);
return this;
}
public Scorecard withModelExplanation(ModelExplanation value) {
setModelExplanation(value);
return this;
}
public Scorecard withTargets(Targets value) {
setTargets(value);
return this;
}
public Scorecard withLocalTransformations(LocalTransformations value) {
setLocalTransformations(value);
return this;
}
public Scorecard withCharacteristics(Characteristics value) {
setCharacteristics(value);
return this;
}
public Scorecard withModelVerification(ModelVerification value) {
setModelVerification(value);
return this;
}
public Scorecard withModelName(String value) {
setModelName(value);
return this;
}
public Scorecard withFunctionName(MiningFunctionType value) {
setFunctionName(value);
return this;
}
public Scorecard withAlgorithmName(String value) {
setAlgorithmName(value);
return this;
}
public Scorecard withInitialScore(Double value) {
setInitialScore(value);
return this;
}
public Scorecard withUseReasonCodes(Boolean value) {
setUseReasonCodes(value);
return this;
}
public Scorecard withReasonCodeAlgorithm(Scorecard.ReasonCodeAlgorithm value) {
setReasonCodeAlgorithm(value);
return this;
}
public Scorecard withBaselineScore(Double value) {
setBaselineScore(value);
return this;
}
public Scorecard withBaselineMethod(Scorecard.BaselineMethod value) {
setBaselineMethod(value);
return this;
}
public Scorecard withScorable(Boolean value) {
setScorable(value);
return this;
}
public Locator sourceLocation() {
return locator;
}
public void setSourceLocation(Locator newLocator) {
locator = newLocator;
}
@Override
public VisitorAction accept(Visitor visitor) {
VisitorAction status = visitor.visit(this);
for (int i = 0; (((status == VisitorAction.CONTINUE)&&(this.extensions!= null))&&(iJava class for null.
*
* The following schema fragment specifies the expected content contained within this class.
*
*
* <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>
*
*
*/
@XmlType(name = "")
@XmlEnum
public enum BaselineMethod {
@XmlEnumValue("max")
MAX("max"),
@XmlEnumValue("min")
MIN("min"),
@XmlEnumValue("mean")
MEAN("mean"),
@XmlEnumValue("neutral")
NEUTRAL("neutral"),
@XmlEnumValue("other")
OTHER("other");
private final String value;
BaselineMethod(String v) {
value = v;
}
public String value() {
return value;
}
public static Scorecard.BaselineMethod fromValue(String v) {
for (Scorecard.BaselineMethod c: Scorecard.BaselineMethod.values()) {
if (c.value.equals(v)) {
return c;
}
}
throw new IllegalArgumentException(v);
}
}
/**
* Java class for null.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <simpleType>
* <restriction base="{http://www.w3.org/2001/XMLSchema}string">
* <enumeration value="pointsAbove"/>
* <enumeration value="pointsBelow"/>
* </restriction>
* </simpleType>
*
*
*/
@XmlType(name = "")
@XmlEnum
public enum ReasonCodeAlgorithm {
@XmlEnumValue("pointsAbove")
POINTS_ABOVE("pointsAbove"),
@XmlEnumValue("pointsBelow")
POINTS_BELOW("pointsBelow");
private final String value;
ReasonCodeAlgorithm(String v) {
value = v;
}
public String value() {
return value;
}
public static Scorecard.ReasonCodeAlgorithm fromValue(String v) {
for (Scorecard.ReasonCodeAlgorithm c: Scorecard.ReasonCodeAlgorithm.values()) {
if (c.value.equals(v)) {
return c;
}
}
throw new IllegalArgumentException(v);
}
}
}