org.dmg.pmml.tree.TreeModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmml-model-gwt Show documentation
Show all versions of pmml-model-gwt Show documentation
JPMML GWT compatible class model
package org.dmg.pmml.tree;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonRootName;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlElements;
import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.dmg.pmml.Extension;
import org.dmg.pmml.HasExtensions;
import org.dmg.pmml.LocalTransformations;
import org.dmg.pmml.MathContext;
import org.dmg.pmml.MiningFunction;
import org.dmg.pmml.MiningSchema;
import org.dmg.pmml.Model;
import org.dmg.pmml.ModelExplanation;
import org.dmg.pmml.ModelStats;
import org.dmg.pmml.ModelVerification;
import org.dmg.pmml.Output;
import org.dmg.pmml.PMMLObject;
import org.dmg.pmml.StringValue;
import org.dmg.pmml.Targets;
import org.dmg.pmml.Visitor;
import org.dmg.pmml.VisitorAction;
import org.dmg.pmml.adapters.ProbabilityNumberAdapter;
import org.jpmml.model.MissingAttributeException;
import org.jpmml.model.MissingElementException;
import org.jpmml.model.annotations.Since;
import org.jpmml.model.annotations.ValueConstructor;
@XmlRootElement(name = "TreeModel", namespace = "http://www.dmg.org/PMML-4_4")
@XmlType(name = "", propOrder = {
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"targets",
"localTransformations",
"node",
"modelVerification"
})
@JsonRootName("TreeModel")
@JsonPropertyOrder({
"modelName",
"miningFunction",
"algorithmName",
"missingValueStrategy",
"missingValuePenalty",
"noTrueChildStrategy",
"splitCharacteristic",
"scorable",
"mathContext",
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"targets",
"localTransformations",
"node",
"modelVerification"
})
public class TreeModel
extends Model
implements HasExtensions , HasNode
{
@XmlAttribute(name = "modelName")
@JsonProperty("modelName")
private String modelName;
@XmlAttribute(name = "functionName", required = true)
@JsonProperty("functionName")
private MiningFunction miningFunction;
@XmlAttribute(name = "algorithmName")
@JsonProperty("algorithmName")
private String algorithmName;
@XmlAttribute(name = "missingValueStrategy")
@JsonProperty("missingValueStrategy")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_3_1))
private TreeModel.MissingValueStrategy missingValueStrategy;
@XmlAttribute(name = "missingValuePenalty")
@XmlJavaTypeAdapter(ProbabilityNumberAdapter.class)
@JsonProperty("missingValuePenalty")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_3_1))
private Number missingValuePenalty;
@XmlAttribute(name = "noTrueChildStrategy")
@JsonProperty("noTrueChildStrategy")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_3_1))
private TreeModel.NoTrueChildStrategy noTrueChildStrategy;
@XmlAttribute(name = "splitCharacteristic")
@JsonProperty("splitCharacteristic")
private TreeModel.SplitCharacteristic splitCharacteristic;
@XmlAttribute(name = "isScorable")
@JsonProperty("isScorable")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_4_1))
private Boolean scorable;
@XmlAttribute(name = "x-mathContext")
@JsonProperty("x-mathContext")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.XPMML))
@Since(("1.3.7"))
private MathContext mathContext;
@XmlElement(name = "Extension", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("Extension")
private List extensions;
@XmlElement(name = "MiningSchema", namespace = "http://www.dmg.org/PMML-4_4", required = true)
@JsonProperty("MiningSchema")
private MiningSchema miningSchema;
@XmlElement(name = "Output", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("Output")
private Output output;
@XmlElement(name = "ModelStats", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("ModelStats")
private ModelStats modelStats;
@XmlElement(name = "ModelExplanation", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("ModelExplanation")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_4_0))
private ModelExplanation modelExplanation;
@XmlElement(name = "Targets", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("Targets")
private Targets targets;
@XmlElement(name = "LocalTransformations", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("LocalTransformations")
private LocalTransformations localTransformations;
@XmlElements({
@XmlElement(name = "Node", namespace = "http://www.dmg.org/PMML-4_4", required = true, type = org.dmg.pmml.tree.ComplexNode.class)
})
@JsonProperty("Node")
@JsonTypeInfo(use = JsonTypeInfo.Id.NONE, defaultImpl = org.dmg.pmml.tree.ComplexNode.class)
@JsonDeserialize(as = org.dmg.pmml.tree.ComplexNode.class)
private Node node;
@XmlElement(name = "ModelVerification", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("ModelVerification")
private ModelVerification modelVerification;
private final static Number DEFAULT_MISSING_VALUE_PENALTY = new ProbabilityNumberAdapter().unmarshal("1.0");
private final static Boolean DEFAULT_SCORABLE = true;
private final static long serialVersionUID = 67371270L;
public TreeModel() {
}
@ValueConstructor
public TreeModel(
@org.jpmml.model.annotations.Property("miningFunction")
MiningFunction miningFunction,
@org.jpmml.model.annotations.Property("miningSchema")
MiningSchema miningSchema,
@org.jpmml.model.annotations.Property("node")
Node node) {
this.miningFunction = miningFunction;
this.miningSchema = miningSchema;
this.node = node;
}
@Override
public String getModelName() {
return modelName;
}
@Override
public TreeModel setModelName(
@org.jpmml.model.annotations.Property("modelName")
String modelName) {
this.modelName = modelName;
return this;
}
@Override
public MiningFunction requireMiningFunction() {
if (this.miningFunction == null) {
throw new MissingAttributeException(this, PMMLAttributes.TREEMODEL_MININGFUNCTION);
}
return this.miningFunction;
}
@Override
public MiningFunction getMiningFunction() {
return miningFunction;
}
@Override
public TreeModel setMiningFunction(
@org.jpmml.model.annotations.Property("miningFunction")
MiningFunction miningFunction) {
this.miningFunction = miningFunction;
return this;
}
@Override
public String getAlgorithmName() {
return algorithmName;
}
@Override
public TreeModel setAlgorithmName(
@org.jpmml.model.annotations.Property("algorithmName")
String algorithmName) {
this.algorithmName = algorithmName;
return this;
}
@Override
public TreeModel.MissingValueStrategy getMissingValueStrategy() {
if (missingValueStrategy == null) {
return TreeModel.MissingValueStrategy.NONE;
} else {
return missingValueStrategy;
}
}
@Override
public TreeModel setMissingValueStrategy(
@org.jpmml.model.annotations.Property("missingValueStrategy")
TreeModel.MissingValueStrategy missingValueStrategy) {
this.missingValueStrategy = missingValueStrategy;
return this;
}
@Override
public Number getMissingValuePenalty() {
if (missingValuePenalty == null) {
return DEFAULT_MISSING_VALUE_PENALTY;
} else {
return missingValuePenalty;
}
}
@Override
public TreeModel setMissingValuePenalty(
@org.jpmml.model.annotations.Property("missingValuePenalty")
Number missingValuePenalty) {
this.missingValuePenalty = missingValuePenalty;
return this;
}
@Override
public TreeModel.NoTrueChildStrategy getNoTrueChildStrategy() {
if (noTrueChildStrategy == null) {
return TreeModel.NoTrueChildStrategy.RETURN_NULL_PREDICTION;
} else {
return noTrueChildStrategy;
}
}
@Override
public TreeModel setNoTrueChildStrategy(
@org.jpmml.model.annotations.Property("noTrueChildStrategy")
TreeModel.NoTrueChildStrategy noTrueChildStrategy) {
this.noTrueChildStrategy = noTrueChildStrategy;
return this;
}
@Override
public TreeModel.SplitCharacteristic getSplitCharacteristic() {
if (splitCharacteristic == null) {
return TreeModel.SplitCharacteristic.MULTI_SPLIT;
} else {
return splitCharacteristic;
}
}
@Override
public TreeModel setSplitCharacteristic(
@org.jpmml.model.annotations.Property("splitCharacteristic")
TreeModel.SplitCharacteristic splitCharacteristic) {
this.splitCharacteristic = splitCharacteristic;
return this;
}
@Override
public boolean isScorable() {
if (scorable == null) {
return DEFAULT_SCORABLE;
} else {
return scorable;
}
}
@Override
public TreeModel setScorable(
@org.jpmml.model.annotations.Property("scorable")
Boolean scorable) {
this.scorable = scorable;
return this;
}
@Override
public MathContext getMathContext() {
if (mathContext == null) {
return MathContext.DOUBLE;
} else {
return mathContext;
}
}
@Override
public TreeModel setMathContext(
@org.jpmml.model.annotations.Property("mathContext")
MathContext mathContext) {
this.mathContext = mathContext;
return this;
}
@Override
public boolean hasExtensions() {
return ((this.extensions!= null)&&(!this.extensions.isEmpty()));
}
@Override
public List getExtensions() {
if (extensions == null) {
extensions = new ArrayList();
}
return this.extensions;
}
@Override
public TreeModel addExtensions(Extension... extensions) {
getExtensions().addAll(Arrays.asList(extensions));
return this;
}
@Override
public MiningSchema requireMiningSchema() {
if (this.miningSchema == null) {
throw new MissingElementException(this, PMMLElements.TREEMODEL_MININGSCHEMA);
}
return this.miningSchema;
}
@Override
public MiningSchema getMiningSchema() {
return miningSchema;
}
@Override
public TreeModel setMiningSchema(
@org.jpmml.model.annotations.Property("miningSchema")
MiningSchema miningSchema) {
this.miningSchema = miningSchema;
return this;
}
@Override
public Output getOutput() {
return output;
}
@Override
public TreeModel setOutput(
@org.jpmml.model.annotations.Property("output")
Output output) {
this.output = output;
return this;
}
@Override
public ModelStats getModelStats() {
return modelStats;
}
@Override
public TreeModel setModelStats(
@org.jpmml.model.annotations.Property("modelStats")
ModelStats modelStats) {
this.modelStats = modelStats;
return this;
}
@Override
public ModelExplanation getModelExplanation() {
return modelExplanation;
}
@Override
public TreeModel setModelExplanation(
@org.jpmml.model.annotations.Property("modelExplanation")
ModelExplanation modelExplanation) {
this.modelExplanation = modelExplanation;
return this;
}
@Override
public Targets getTargets() {
return targets;
}
@Override
public TreeModel setTargets(
@org.jpmml.model.annotations.Property("targets")
Targets targets) {
this.targets = targets;
return this;
}
@Override
public LocalTransformations getLocalTransformations() {
return localTransformations;
}
@Override
public TreeModel setLocalTransformations(
@org.jpmml.model.annotations.Property("localTransformations")
LocalTransformations localTransformations) {
this.localTransformations = localTransformations;
return this;
}
public Node requireNode() {
if (this.node == null) {
throw new MissingElementException(this, PMMLElements.TREEMODEL_NODE);
}
return this.node;
}
@Override
public Node getNode() {
return node;
}
@Override
public TreeModel setNode(
@org.jpmml.model.annotations.Property("node")
Node node) {
this.node = node;
return this;
}
@Override
public ModelVerification getModelVerification() {
return modelVerification;
}
@Override
public TreeModel setModelVerification(
@org.jpmml.model.annotations.Property("modelVerification")
ModelVerification modelVerification) {
this.modelVerification = modelVerification;
return this;
}
@Override
public VisitorAction accept(Visitor visitor) {
VisitorAction status = visitor.visit(this);
if (status == VisitorAction.CONTINUE) {
visitor.pushParent(this);
if ((status == VisitorAction.CONTINUE)&&hasExtensions()) {
status = PMMLObject.traverse(visitor, getExtensions());
}
if (status == VisitorAction.CONTINUE) {
status = PMMLObject.traverse(visitor, getMiningSchema(), getOutput(), getModelStats(), getModelExplanation(), getTargets(), getLocalTransformations(), getNode(), getModelVerification());
}
visitor.popParent();
}
if (status == VisitorAction.TERMINATE) {
return VisitorAction.TERMINATE;
}
return VisitorAction.CONTINUE;
}
@XmlType(name = "")
@XmlEnum
public enum MissingValueStrategy
implements StringValue
{
@XmlEnumValue("lastPrediction")
@JsonProperty("lastPrediction")
LAST_PREDICTION("lastPrediction"),
@XmlEnumValue("nullPrediction")
@JsonProperty("nullPrediction")
NULL_PREDICTION("nullPrediction"),
@XmlEnumValue("defaultChild")
@JsonProperty("defaultChild")
DEFAULT_CHILD("defaultChild"),
@XmlEnumValue("weightedConfidence")
@JsonProperty("weightedConfidence")
WEIGHTED_CONFIDENCE("weightedConfidence"),
@XmlEnumValue("aggregateNodes")
@JsonProperty("aggregateNodes")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_3_2))
AGGREGATE_NODES("aggregateNodes"),
@XmlEnumValue("none")
@JsonProperty("none")
NONE("none");
private final String value;
MissingValueStrategy(String v) {
value = v;
}
@Override
public String value() {
return value;
}
public static TreeModel.MissingValueStrategy fromValue(String v) {
for (TreeModel.MissingValueStrategy c: TreeModel.MissingValueStrategy.values()) {
if (c.value.equals(v)) {
return c;
}
}
throw new IllegalArgumentException(v);
}
@Override
public String toString() {
return value();
}
}
@XmlType(name = "")
@XmlEnum
public enum NoTrueChildStrategy
implements StringValue
{
@XmlEnumValue("returnNullPrediction")
@JsonProperty("returnNullPrediction")
RETURN_NULL_PREDICTION("returnNullPrediction"),
@XmlEnumValue("returnLastPrediction")
@JsonProperty("returnLastPrediction")
RETURN_LAST_PREDICTION("returnLastPrediction");
private final String value;
NoTrueChildStrategy(String v) {
value = v;
}
@Override
public String value() {
return value;
}
public static TreeModel.NoTrueChildStrategy fromValue(String v) {
for (TreeModel.NoTrueChildStrategy c: TreeModel.NoTrueChildStrategy.values()) {
if (c.value.equals(v)) {
return c;
}
}
throw new IllegalArgumentException(v);
}
@Override
public String toString() {
return value();
}
}
@XmlType(name = "")
@XmlEnum
public enum SplitCharacteristic
implements StringValue
{
@XmlEnumValue("binarySplit")
@JsonProperty("binarySplit")
BINARY_SPLIT("binarySplit"),
@XmlEnumValue("multiSplit")
@JsonProperty("multiSplit")
MULTI_SPLIT("multiSplit");
private final String value;
SplitCharacteristic(String v) {
value = v;
}
@Override
public String value() {
return value;
}
public static TreeModel.SplitCharacteristic fromValue(String v) {
for (TreeModel.SplitCharacteristic c: TreeModel.SplitCharacteristic.values()) {
if (c.value.equals(v)) {
return c;
}
}
throw new IllegalArgumentException(v);
}
@Override
public String toString() {
return value();
}
}
}