org.dmg.pmml.clustering.ClusteringModel 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.clustering;
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 jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.dmg.pmml.ComparisonMeasure;
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.Visitor;
import org.dmg.pmml.VisitorAction;
import org.dmg.pmml.adapters.NonNegativeIntegerAdapter;
import org.jpmml.model.MissingAttributeException;
import org.jpmml.model.MissingElementException;
import org.jpmml.model.annotations.CollectionSize;
import org.jpmml.model.annotations.Removed;
import org.jpmml.model.annotations.Required;
import org.jpmml.model.annotations.Since;
import org.jpmml.model.annotations.ValueConstructor;
@XmlRootElement(name = "ClusteringModel", namespace = "http://www.dmg.org/PMML-4_4")
@XmlType(name = "", propOrder = {
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"localTransformations",
"comparisonMeasure",
"clusteringFields",
"centerFields",
"missingValueWeights",
"clusters",
"modelVerification"
})
@JsonRootName("ClusteringModel")
@JsonPropertyOrder({
"modelName",
"miningFunction",
"algorithmName",
"modelClass",
"numberOfClusters",
"scorable",
"mathContext",
"extensions",
"miningSchema",
"output",
"modelStats",
"modelExplanation",
"localTransformations",
"comparisonMeasure",
"clusteringFields",
"centerFields",
"missingValueWeights",
"clusters",
"modelVerification"
})
public class ClusteringModel
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 = "modelClass", required = true)
@JsonProperty("modelClass")
private ClusteringModel.ModelClass modelClass;
@XmlAttribute(name = "numberOfClusters", required = true)
@XmlJavaTypeAdapter(NonNegativeIntegerAdapter.class)
@XmlSchemaType(name = "nonNegativeInteger")
@JsonProperty("numberOfClusters")
@CollectionSize(("clusters"))
private Integer numberOfClusters;
@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 = "LocalTransformations", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("LocalTransformations")
private LocalTransformations localTransformations;
@XmlElement(name = "ComparisonMeasure", namespace = "http://www.dmg.org/PMML-4_4", required = true)
@JsonProperty("ComparisonMeasure")
private ComparisonMeasure comparisonMeasure;
@XmlElement(name = "ClusteringField", namespace = "http://www.dmg.org/PMML-4_4", required = true)
@JsonProperty("ClusteringField")
@Required((org.dmg.pmml.Version.PMML_4_2))
private List clusteringFields;
@XmlElement(name = "CenterFields", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("CenterFields")
@Removed((org.dmg.pmml.Version.PMML_3_2))
private CenterFields centerFields;
@XmlElement(name = "MissingValueWeights", namespace = "http://www.dmg.org/PMML-4_4")
@JsonProperty("MissingValueWeights")
private MissingValueWeights missingValueWeights;
@XmlElement(name = "Cluster", namespace = "http://www.dmg.org/PMML-4_4", required = true)
@JsonProperty("Cluster")
private List clusters;
@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 ClusteringModel() {
}
@ValueConstructor
public ClusteringModel(
@org.jpmml.model.annotations.Property("miningFunction")
MiningFunction miningFunction,
@org.jpmml.model.annotations.Property("modelClass")
ClusteringModel.ModelClass modelClass,
@org.jpmml.model.annotations.Property("numberOfClusters")
Integer numberOfClusters,
@org.jpmml.model.annotations.Property("miningSchema")
MiningSchema miningSchema,
@org.jpmml.model.annotations.Property("comparisonMeasure")
ComparisonMeasure comparisonMeasure,
@org.jpmml.model.annotations.Property("clusteringFields")
List clusteringFields,
@org.jpmml.model.annotations.Property("clusters")
List clusters) {
this.miningFunction = miningFunction;
this.modelClass = modelClass;
this.numberOfClusters = numberOfClusters;
this.miningSchema = miningSchema;
this.comparisonMeasure = comparisonMeasure;
this.clusteringFields = clusteringFields;
this.clusters = clusters;
}
@Override
public String getModelName() {
return modelName;
}
@Override
public ClusteringModel 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.CLUSTERINGMODEL_MININGFUNCTION);
}
return this.miningFunction;
}
@Override
public MiningFunction getMiningFunction() {
return miningFunction;
}
@Override
public ClusteringModel setMiningFunction(
@org.jpmml.model.annotations.Property("miningFunction")
MiningFunction miningFunction) {
this.miningFunction = miningFunction;
return this;
}
@Override
public String getAlgorithmName() {
return algorithmName;
}
@Override
public ClusteringModel setAlgorithmName(
@org.jpmml.model.annotations.Property("algorithmName")
String algorithmName) {
this.algorithmName = algorithmName;
return this;
}
public ClusteringModel.ModelClass requireModelClass() {
if (this.modelClass == null) {
throw new MissingAttributeException(this, PMMLAttributes.CLUSTERINGMODEL_MODELCLASS);
}
return this.modelClass;
}
public ClusteringModel.ModelClass getModelClass() {
return modelClass;
}
public ClusteringModel setModelClass(
@org.jpmml.model.annotations.Property("modelClass")
ClusteringModel.ModelClass modelClass) {
this.modelClass = modelClass;
return this;
}
public Integer requireNumberOfClusters() {
if (this.numberOfClusters == null) {
throw new MissingAttributeException(this, PMMLAttributes.CLUSTERINGMODEL_NUMBEROFCLUSTERS);
}
return this.numberOfClusters;
}
public Integer getNumberOfClusters() {
return numberOfClusters;
}
public ClusteringModel setNumberOfClusters(
@org.jpmml.model.annotations.Property("numberOfClusters")
Integer numberOfClusters) {
this.numberOfClusters = numberOfClusters;
return this;
}
@Override
public boolean isScorable() {
if (scorable == null) {
return DEFAULT_SCORABLE;
} else {
return scorable;
}
}
@Override
public ClusteringModel 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 ClusteringModel 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 ClusteringModel addExtensions(Extension... extensions) {
getExtensions().addAll(Arrays.asList(extensions));
return this;
}
@Override
public MiningSchema requireMiningSchema() {
if (this.miningSchema == null) {
throw new MissingElementException(this, PMMLElements.CLUSTERINGMODEL_MININGSCHEMA);
}
return this.miningSchema;
}
@Override
public MiningSchema getMiningSchema() {
return miningSchema;
}
@Override
public ClusteringModel setMiningSchema(
@org.jpmml.model.annotations.Property("miningSchema")
MiningSchema miningSchema) {
this.miningSchema = miningSchema;
return this;
}
@Override
public Output getOutput() {
return output;
}
@Override
public ClusteringModel setOutput(
@org.jpmml.model.annotations.Property("output")
Output output) {
this.output = output;
return this;
}
@Override
public ModelStats getModelStats() {
return modelStats;
}
@Override
public ClusteringModel setModelStats(
@org.jpmml.model.annotations.Property("modelStats")
ModelStats modelStats) {
this.modelStats = modelStats;
return this;
}
@Override
public ModelExplanation getModelExplanation() {
return modelExplanation;
}
@Override
public ClusteringModel setModelExplanation(
@org.jpmml.model.annotations.Property("modelExplanation")
ModelExplanation modelExplanation) {
this.modelExplanation = modelExplanation;
return this;
}
@Override
public LocalTransformations getLocalTransformations() {
return localTransformations;
}
@Override
public ClusteringModel setLocalTransformations(
@org.jpmml.model.annotations.Property("localTransformations")
LocalTransformations localTransformations) {
this.localTransformations = localTransformations;
return this;
}
public ComparisonMeasure requireComparisonMeasure() {
if (this.comparisonMeasure == null) {
throw new MissingElementException(this, PMMLElements.CLUSTERINGMODEL_COMPARISONMEASURE);
}
return this.comparisonMeasure;
}
public ComparisonMeasure getComparisonMeasure() {
return comparisonMeasure;
}
public ClusteringModel setComparisonMeasure(
@org.jpmml.model.annotations.Property("comparisonMeasure")
ComparisonMeasure comparisonMeasure) {
this.comparisonMeasure = comparisonMeasure;
return this;
}
public boolean hasClusteringFields() {
return ((this.clusteringFields!= null)&&(!this.clusteringFields.isEmpty()));
}
public List requireClusteringFields() {
if ((this.clusteringFields == null)||this.clusteringFields.isEmpty()) {
throw new MissingElementException(this, PMMLElements.CLUSTERINGMODEL_CLUSTERINGFIELDS);
}
return this.clusteringFields;
}
public List getClusteringFields() {
if (clusteringFields == null) {
clusteringFields = new ArrayList();
}
return this.clusteringFields;
}
public ClusteringModel addClusteringFields(ClusteringField... clusteringFields) {
getClusteringFields().addAll(Arrays.asList(clusteringFields));
return this;
}
public CenterFields getCenterFields() {
return centerFields;
}
public ClusteringModel setCenterFields(
@org.jpmml.model.annotations.Property("centerFields")
CenterFields centerFields) {
this.centerFields = centerFields;
return this;
}
public MissingValueWeights getMissingValueWeights() {
return missingValueWeights;
}
public ClusteringModel setMissingValueWeights(
@org.jpmml.model.annotations.Property("missingValueWeights")
MissingValueWeights missingValueWeights) {
this.missingValueWeights = missingValueWeights;
return this;
}
public boolean hasClusters() {
return ((this.clusters!= null)&&(!this.clusters.isEmpty()));
}
public List requireClusters() {
if ((this.clusters == null)||this.clusters.isEmpty()) {
throw new MissingElementException(this, PMMLElements.CLUSTERINGMODEL_CLUSTERS);
}
return this.clusters;
}
public List getClusters() {
if (clusters == null) {
clusters = new ArrayList();
}
return this.clusters;
}
public ClusteringModel addClusters(Cluster... clusters) {
getClusters().addAll(Arrays.asList(clusters));
return this;
}
@Override
public ModelVerification getModelVerification() {
return modelVerification;
}
@Override
public ClusteringModel 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(), getLocalTransformations(), getComparisonMeasure());
}
if ((status == VisitorAction.CONTINUE)&&hasClusteringFields()) {
status = PMMLObject.traverse(visitor, getClusteringFields());
}
if (status == VisitorAction.CONTINUE) {
status = PMMLObject.traverse(visitor, getCenterFields(), getMissingValueWeights());
}
if ((status == VisitorAction.CONTINUE)&&hasClusters()) {
status = PMMLObject.traverse(visitor, getClusters());
}
if (status == VisitorAction.CONTINUE) {
status = PMMLObject.traverse(visitor, getModelVerification());
}
visitor.popParent();
}
if (status == VisitorAction.TERMINATE) {
return VisitorAction.TERMINATE;
}
return VisitorAction.CONTINUE;
}
@XmlType(name = "")
@XmlEnum
public enum ModelClass
implements StringValue
{
@XmlEnumValue("centerBased")
@JsonProperty("centerBased")
CENTER_BASED("centerBased"),
@XmlEnumValue("distributionBased")
@JsonProperty("distributionBased")
DISTRIBUTION_BASED("distributionBased");
private final String value;
ModelClass(String v) {
value = v;
}
@Override
public String value() {
return value;
}
public static ClusteringModel.ModelClass fromValue(String v) {
for (ClusteringModel.ModelClass c: ClusteringModel.ModelClass.values()) {
if (c.value.equals(v)) {
return c;
}
}
throw new IllegalArgumentException(v);
}
@Override
public String toString() {
return value();
}
}
}