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

Go to download

package org.dmg.pmml.time_series;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlEnumValue;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import org.dmg.pmml.Array;
import org.dmg.pmml.Visitor;
import org.dmg.pmml.VisitorAction;
import org.jpmml.schema.Added;
import org.jpmml.schema.Version;


/**
 * Java class for anonymous complex type.
 * 
 * 
The following schema fragment specifies the expected content contained within this class.
 * 
 * 
 * <complexType>
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <group ref="{http://www.dmg.org/PMML-4_3}REAL-ARRAY"/>
 *       </sequence>
 *       <attribute name="type" use="required">
 *         <simpleType>
 *           <restriction base="{http://www.w3.org/2001/XMLSchema}NMTOKEN">
 *             <enumeration value="additive"/>
 *             <enumeration value="multiplicative"/>
 *           </restriction>
 *         </simpleType>
 *       </attribute>
 *       <attribute name="period" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
 *       <attribute name="unit" type="{http://www.w3.org/2001/XMLSchema}string" />
 *       <attribute name="phase" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
 *       <attribute name="delta" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" />
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "array"
})
@XmlRootElement(name = "Seasonality_ExpoSmooth", namespace = "http://www.dmg.org/PMML-4_3")
@Added(Version.PMML_4_0)
public class SeasonalityExpoSmooth
    extends org.dmg.pmml.PMMLObject
{

    @XmlAttribute(name = "type", required = true)
    private SeasonalityExpoSmooth.Type type;
    @XmlAttribute(name = "period", required = true)
    private int period;
    @XmlAttribute(name = "unit")
    private String unit;
    @XmlAttribute(name = "phase")
    private Integer phase;
    @XmlAttribute(name = "delta")
    private Double delta;
    @XmlElement(name = "Array", namespace = "http://www.dmg.org/PMML-4_3")
    private Array array;

    public SeasonalityExpoSmooth() {
        super();
    }

    public SeasonalityExpoSmooth(final SeasonalityExpoSmooth.Type type, final int period) {
        super();
        this.type = type;
        this.period = period;
    }

    /**
     * Gets the value of the type property.
     * 
     * @return
     *     possible object is
     *     {@link SeasonalityExpoSmooth.Type }
     *     
     */
    public SeasonalityExpoSmooth.Type getType() {
        return type;
    }

    /**
     * Sets the value of the type property.
     * 
     * @param type
     *     allowed object is
     *     {@link SeasonalityExpoSmooth.Type }
     *     
     */
    public SeasonalityExpoSmooth setType(SeasonalityExpoSmooth.Type type) {
        this.type = type;
        return this;
    }

    /**
     * Gets the value of the period property.
     * 
     */
    public int getPeriod() {
        return period;
    }

    /**
     * Sets the value of the period property.
     * 
     */
    public SeasonalityExpoSmooth setPeriod(int period) {
        this.period = period;
        return this;
    }

    /**
     * Gets the value of the unit property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getUnit() {
        return unit;
    }

    /**
     * Sets the value of the unit property.
     * 
     * @param unit
     *     allowed object is
     *     {@link String }
     *     
     */
    public SeasonalityExpoSmooth setUnit(String unit) {
        this.unit = unit;
        return this;
    }

    /**
     * Gets the value of the phase property.
     * 
     * @return
     *     possible object is
     *     {@link Integer }
     *     
     */
    public Integer getPhase() {
        return phase;
    }

    /**
     * Sets the value of the phase property.
     * 
     * @param phase
     *     allowed object is
     *     {@link Integer }
     *     
     */
    public SeasonalityExpoSmooth setPhase(Integer phase) {
        this.phase = phase;
        return this;
    }

    /**
     * Gets the value of the delta property.
     * 
     * @return
     *     possible object is
     *     {@link Double }
     *     
     */
    public Double getDelta() {
        return delta;
    }

    /**
     * Sets the value of the delta property.
     * 
     * @param delta
     *     allowed object is
     *     {@link Double }
     *     
     */
    public SeasonalityExpoSmooth setDelta(Double delta) {
        this.delta = delta;
        return this;
    }

    /**
     * Gets the value of the array property.
     * 
     * @return
     *     possible object is
     *     {@link Array }
     *     
     */
    public Array getArray() {
        return array;
    }

    /**
     * Sets the value of the array property.
     * 
     * @param array
     *     allowed object is
     *     {@link Array }
     *     
     */
    public SeasonalityExpoSmooth setArray(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;
    }


    /**
     * Java class for null.
     * 
     * 
The following schema fragment specifies the expected content contained within this class.
     * 

     * 
     * <simpleType>
     *   <restriction base="{http://www.w3.org/2001/XMLSchema}NMTOKEN">
     *     <enumeration value="additive"/>
     *     <enumeration value="multiplicative"/>
     *   </restriction>
     * </simpleType>
     * 
     * 
     */
    @XmlType(name = "")
    @XmlEnum
    public enum Type {

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

        Type(String v) {
            value = v;
        }

        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);
        }

    }

}