org.dmg.pmml.mining.MiningModel 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.mining;
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.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlElements;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlType;
import org.dmg.pmml.EmbeddedModel;
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.Targets;
import org.dmg.pmml.Visitor;
import org.dmg.pmml.VisitorAction;
import org.jpmml.model.MissingAttributeException;
import org.jpmml.model.MissingElementException;
import org.jpmml.model.annotations.Deprecated;
import org.jpmml.model.annotations.Optional;
import org.jpmml.model.annotations.Since;
import org.jpmml.model.annotations.ValueConstructor;
@XmlRootElement(name = "MiningModel", namespace = "http://www.dmg.org/PMML-4_4")
@XmlType(name = "", propOrder = {
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"targets",
"localTransformations",
"embeddedModels",
"segmentation",
"modelVerification"
})
@JsonRootName("MiningModel")
@JsonPropertyOrder({
"modelName",
"miningFunction",
"algorithmName",
"scorable",
"mathContext",
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"targets",
"localTransformations",
"embeddedModels",
"segmentation",
"modelVerification"
})
public class MiningModel
extends Model
implements HasExtensions
{
@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 = "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 = "Regression", namespace = "http://www.dmg.org/PMML-4_4", type = org.dmg.pmml.regression.Regression.class),
@XmlElement(name = "DecisionTree", namespace = "http://www.dmg.org/PMML-4_4", type = org.dmg.pmml.tree.DecisionTree.class)
})
@JsonProperty("EmbeddedModel")
@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
@JsonSubTypes({
@JsonSubTypes.Type(name = "Regression", value = org.dmg.pmml.regression.Regression.class),
@JsonSubTypes.Type(name = "DecisionTree", value = org.dmg.pmml.tree.DecisionTree.class)
})
@Deprecated((org.dmg.pmml.Version.PMML_4_1))
@Optional((org.dmg.pmml.Version.PMML_4_0))
private List embeddedModels;
@XmlElement(name = "Segmentation", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("Segmentation")
@org.jpmml.model.annotations.Added((org.dmg.pmml.Version.PMML_4_0))
private Segmentation segmentation;
@XmlElement(name = "ModelVerification", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("ModelVerification")
private ModelVerification modelVerification;
private final static Boolean DEFAULT_SCORABLE = true;
private final static long serialVersionUID = 67371270L;
public MiningModel() {
}
@ValueConstructor
public MiningModel(
@org.jpmml.model.annotations.Property("miningFunction")
MiningFunction miningFunction,
@org.jpmml.model.annotations.Property("miningSchema")
MiningSchema miningSchema) {
this.miningFunction = miningFunction;
this.miningSchema = miningSchema;
}
@Override
public String getModelName() {
return modelName;
}
@Override
public MiningModel 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.MININGMODEL_MININGFUNCTION);
}
return this.miningFunction;
}
@Override
public MiningFunction getMiningFunction() {
return miningFunction;
}
@Override
public MiningModel setMiningFunction(
@org.jpmml.model.annotations.Property("miningFunction")
MiningFunction miningFunction) {
this.miningFunction = miningFunction;
return this;
}
@Override
public String getAlgorithmName() {
return algorithmName;
}
@Override
public MiningModel setAlgorithmName(
@org.jpmml.model.annotations.Property("algorithmName")
String algorithmName) {
this.algorithmName = algorithmName;
return this;
}
@Override
public boolean isScorable() {
if (scorable == null) {
return DEFAULT_SCORABLE;
} else {
return scorable;
}
}
@Override
public MiningModel 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 MiningModel 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 MiningModel addExtensions(Extension... extensions) {
getExtensions().addAll(Arrays.asList(extensions));
return this;
}
@Override
public MiningSchema requireMiningSchema() {
if (this.miningSchema == null) {
throw new MissingElementException(this, PMMLElements.MININGMODEL_MININGSCHEMA);
}
return this.miningSchema;
}
@Override
public MiningSchema getMiningSchema() {
return miningSchema;
}
@Override
public MiningModel setMiningSchema(
@org.jpmml.model.annotations.Property("miningSchema")
MiningSchema miningSchema) {
this.miningSchema = miningSchema;
return this;
}
@Override
public Output getOutput() {
return output;
}
@Override
public MiningModel setOutput(
@org.jpmml.model.annotations.Property("output")
Output output) {
this.output = output;
return this;
}
@Override
public ModelStats getModelStats() {
return modelStats;
}
@Override
public MiningModel setModelStats(
@org.jpmml.model.annotations.Property("modelStats")
ModelStats modelStats) {
this.modelStats = modelStats;
return this;
}
@Override
public ModelExplanation getModelExplanation() {
return modelExplanation;
}
@Override
public MiningModel setModelExplanation(
@org.jpmml.model.annotations.Property("modelExplanation")
ModelExplanation modelExplanation) {
this.modelExplanation = modelExplanation;
return this;
}
@Override
public Targets getTargets() {
return targets;
}
@Override
public MiningModel setTargets(
@org.jpmml.model.annotations.Property("targets")
Targets targets) {
this.targets = targets;
return this;
}
@Override
public LocalTransformations getLocalTransformations() {
return localTransformations;
}
@Override
public MiningModel setLocalTransformations(
@org.jpmml.model.annotations.Property("localTransformations")
LocalTransformations localTransformations) {
this.localTransformations = localTransformations;
return this;
}
public boolean hasEmbeddedModels() {
return ((this.embeddedModels!= null)&&(!this.embeddedModels.isEmpty()));
}
public List getEmbeddedModels() {
if (embeddedModels == null) {
embeddedModels = new ArrayList();
}
return this.embeddedModels;
}
public MiningModel addEmbeddedModels(EmbeddedModel... embeddedModels) {
getEmbeddedModels().addAll(Arrays.asList(embeddedModels));
return this;
}
public Segmentation requireSegmentation() {
if (this.segmentation == null) {
throw new MissingElementException(this, PMMLElements.MININGMODEL_SEGMENTATION);
}
return this.segmentation;
}
public Segmentation getSegmentation() {
return segmentation;
}
public MiningModel setSegmentation(
@org.jpmml.model.annotations.Property("segmentation")
Segmentation segmentation) {
this.segmentation = segmentation;
return this;
}
@Override
public ModelVerification getModelVerification() {
return modelVerification;
}
@Override
public MiningModel 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());
}
if ((status == VisitorAction.CONTINUE)&&hasEmbeddedModels()) {
status = PMMLObject.traverse(visitor, getEmbeddedModels());
}
if (status == VisitorAction.CONTINUE) {
status = PMMLObject.traverse(visitor, getSegmentation(), getModelVerification());
}
visitor.popParent();
}
if (status == VisitorAction.TERMINATE) {
return VisitorAction.TERMINATE;
}
return VisitorAction.CONTINUE;
}
}