org.dmg.pmml.time_series.SeasonalityExpoSmooth Maven / Gradle / Ivy

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

package org.dmg.pmml.time_series;

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.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.dmg.pmml.Array;
import org.dmg.pmml.StringValue;
import org.dmg.pmml.Visitor;
import org.dmg.pmml.VisitorAction;
import org.dmg.pmml.adapters.IntegerAdapter;
import org.dmg.pmml.adapters.RealNumberAdapter;
import org.jpmml.model.MissingAttributeException;
import org.jpmml.model.MissingElementException;
import org.jpmml.model.annotations.Added;
import org.jpmml.model.annotations.ValueConstructor;

@XmlRootElement(name = "Seasonality_ExpoSmooth", namespace = "http://www.dmg.org/PMML-4_4")
@XmlType(name = "", propOrder = {
    "array"
})
@Added((org.dmg.pmml.Version.PMML_4_0))
@JsonRootName("Seasonality_ExpoSmooth")
@JsonPropertyOrder({
    "type",
    "period",
    "unit",
    "phase",
    "delta",
    "array"
})
public class SeasonalityExpoSmooth
    extends org.dmg.pmml.PMMLObject
{

    @XmlAttribute(name = "type", required = true)
    @JsonProperty("type")
    private SeasonalityExpoSmooth.Type type;
    @XmlAttribute(name = "period", required = true)
    @XmlJavaTypeAdapter(IntegerAdapter.class)
    @JsonProperty("period")
    private Integer period;
    @XmlAttribute(name = "unit")
    @JsonProperty("unit")
    private String unit;
    @XmlAttribute(name = "phase")
    @XmlJavaTypeAdapter(IntegerAdapter.class)
    @JsonProperty("phase")
    private Integer phase;
    @XmlAttribute(name = "delta")
    @XmlJavaTypeAdapter(RealNumberAdapter.class)
    @JsonProperty("delta")
    private Number delta;
    @XmlElement(name = "Array", namespace = "http://www.dmg.org/PMML-4_4")
    @JsonProperty("Array")
    private Array array;
    private final static long serialVersionUID = 67371270L;

    public SeasonalityExpoSmooth() {
    }

    @ValueConstructor
    public SeasonalityExpoSmooth(
        @org.jpmml.model.annotations.Property("type")
        SeasonalityExpoSmooth.Type type,
        @org.jpmml.model.annotations.Property("period")
        Integer period,
        @org.jpmml.model.annotations.Property("array")
        Array array) {
        this.type = type;
        this.period = period;
        this.array = array;
    }

    public SeasonalityExpoSmooth.Type requireType() {
        if (this.type == null) {
            throw new MissingAttributeException(this, PMMLAttributes.SEASONALITYEXPOSMOOTH_TYPE);
        }
        return this.type;
    }

    public SeasonalityExpoSmooth.Type getType() {
        return type;
    }

    public SeasonalityExpoSmooth setType(
        @org.jpmml.model.annotations.Property("type")
        SeasonalityExpoSmooth.Type type) {
        this.type = type;
        return this;
    }

    public Integer requirePeriod() {
        if (this.period == null) {
            throw new MissingAttributeException(this, PMMLAttributes.SEASONALITYEXPOSMOOTH_PERIOD);
        }
        return this.period;
    }

    public Integer getPeriod() {
        return period;
    }

    public SeasonalityExpoSmooth setPeriod(
        @org.jpmml.model.annotations.Property("period")
        Integer period) {
        this.period = period;
        return this;
    }

    public String getUnit() {
        return unit;
    }

    public SeasonalityExpoSmooth setUnit(
        @org.jpmml.model.annotations.Property("unit")
        String unit) {
        this.unit = unit;
        return this;
    }

    public Integer getPhase() {
        return phase;
    }

    public SeasonalityExpoSmooth setPhase(
        @org.jpmml.model.annotations.Property("phase")
        Integer phase) {
        this.phase = phase;
        return this;
    }

    public Number getDelta() {
        return delta;
    }

    public SeasonalityExpoSmooth setDelta(
        @org.jpmml.model.annotations.Property("delta")
        Number delta) {
        this.delta = delta;
        return this;
    }

    public Array requireArray() {
        if (this.array == null) {
            throw new MissingElementException(this, PMMLElements.SEASONALITYEXPOSMOOTH_ARRAY);
        }
        return this.array;
    }

    public Array getArray() {
        return array;
    }

    public SeasonalityExpoSmooth setArray(
        @org.jpmml.model.annotations.Property("array")
        Array array) {
        this.array = array;
        return this;
    }

    @Override
    public VisitorAction accept(Visitor visitor) {
        VisitorAction status = visitor.visit(this);
        if (status == VisitorAction.CONTINUE) {
            visitor.pushParent(this);
            if (status == VisitorAction.CONTINUE) {
                status = org.dmg.pmml.PMMLObject.traverse(visitor, getArray());
            }
            visitor.popParent();
        }
        if (status == VisitorAction.TERMINATE) {
            return VisitorAction.TERMINATE;
        }
        return VisitorAction.CONTINUE;
    }

    @XmlType(name = "")
    @XmlEnum
    public enum Type
        implements StringValue
    {

        @XmlEnumValue("additive")
        @JsonProperty("additive")
        ADDITIVE("additive"),
        @XmlEnumValue("multiplicative")
        @JsonProperty("multiplicative")
        MULTIPLICATIVE("multiplicative");
        private final String value;

        Type(String v) {
            value = v;
        }

        @Override
        public String value() {
            return value;
        }

        public static SeasonalityExpoSmooth.Type fromValue(String v) {
            for (SeasonalityExpoSmooth.Type c: SeasonalityExpoSmooth.Type.values()) {
                if (c.value.equals(v)) {
                    return c;
                }
            }
            throw new IllegalArgumentException(v);
        }

        @Override
        public String toString() {
            return value();
        }

    }

}