org.dmg.pmml.ModelExplanation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmml-model Show documentation
JPMML class model
There is a newer version: 1.6.6

package org.dmg.pmml;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonRootName;
import org.jpmml.model.annotations.Added;
import org.jpmml.model.annotations.Property;

@XmlRootElement(name = "ModelExplanation", namespace = "http://www.dmg.org/PMML-4_4")
@XmlType(name = "", propOrder = {
    "extensions",
    "predictiveModelQualities",
    "clusteringModelQualities",
    "correlations"
})
@Added((org.dmg.pmml.Version.PMML_4_0))
@JsonRootName("ModelExplanation")
@JsonPropertyOrder({
    "extensions",
    "predictiveModelQualities",
    "clusteringModelQualities",
    "correlations"
})
public class ModelExplanation
    extends org.dmg.pmml.PMMLObject
    implements HasExtensions
{

    @XmlElement(name = "Extension", namespace = "http://www.dmg.org/PMML-4_4")
    @JsonProperty("Extension")
    private List extensions;
    @XmlElement(name = "PredictiveModelQuality", namespace = "http://www.dmg.org/PMML-4_4")
    @JsonProperty("PredictiveModelQuality")
    private List predictiveModelQualities;
    @XmlElement(name = "ClusteringModelQuality", namespace = "http://www.dmg.org/PMML-4_4")
    @JsonProperty("ClusteringModelQuality")
    private List clusteringModelQualities;
    @XmlElement(name = "Correlations", namespace = "http://www.dmg.org/PMML-4_4")
    @JsonProperty("Correlations")
    private Correlations correlations;
    private final static long serialVersionUID = 67371267L;

    @Override
    public boolean hasExtensions() {
        return ((this.extensions!= null)&&(this.extensions.size()> 0));
    }

    @Override
    public List getExtensions() {
        if (extensions == null) {
            extensions = new ArrayList();
        }
        return this.extensions;
    }

    @Override
    public ModelExplanation addExtensions(Extension... extensions) {
        getExtensions().addAll(Arrays.asList(extensions));
        return this;
    }

    public boolean hasPredictiveModelQualities() {
        return ((this.predictiveModelQualities!= null)&&(this.predictiveModelQualities.size()> 0));
    }

    public List getPredictiveModelQualities() {
        if (predictiveModelQualities == null) {
            predictiveModelQualities = new ArrayList();
        }
        return this.predictiveModelQualities;
    }

    public ModelExplanation addPredictiveModelQualities(PredictiveModelQuality... predictiveModelQualities) {
        getPredictiveModelQualities().addAll(Arrays.asList(predictiveModelQualities));
        return this;
    }

    public boolean hasClusteringModelQualities() {
        return ((this.clusteringModelQualities!= null)&&(this.clusteringModelQualities.size()> 0));
    }

    public List getClusteringModelQualities() {
        if (clusteringModelQualities == null) {
            clusteringModelQualities = new ArrayList();
        }
        return this.clusteringModelQualities;
    }

    public ModelExplanation addClusteringModelQualities(ClusteringModelQuality... clusteringModelQualities) {
        getClusteringModelQualities().addAll(Arrays.asList(clusteringModelQualities));
        return this;
    }

    public Correlations getCorrelations() {
        return correlations;
    }

    public ModelExplanation setCorrelations(
        @Property("correlations")
        Correlations correlations) {
        this.correlations = correlations;
        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 = org.dmg.pmml.PMMLObject.traverse(visitor, getExtensions());
            }
            if ((status == VisitorAction.CONTINUE)&&hasPredictiveModelQualities()) {
                status = org.dmg.pmml.PMMLObject.traverse(visitor, getPredictiveModelQualities());
            }
            if ((status == VisitorAction.CONTINUE)&&hasClusteringModelQualities()) {
                status = org.dmg.pmml.PMMLObject.traverse(visitor, getClusteringModelQualities());
            }
            if (status == VisitorAction.CONTINUE) {
                status = org.dmg.pmml.PMMLObject.traverse(visitor, getCorrelations());
            }
            visitor.popParent();
        }
        if (status == VisitorAction.TERMINATE) {
            return VisitorAction.TERMINATE;
        }
        return VisitorAction.CONTINUE;
    }

}