org.dmg.pmml.time_series

Class TimeSeriesModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.time_series.TimeSeriesModel

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class TimeSeriesModel
extends Model
implements HasExtensions

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>
         <element ref="{http://www.dmg.org/PMML-4_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}TimeSeries" maxOccurs="3" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}SpectralAnalysis" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ARIMA" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ExponentialSmoothing" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}SeasonalTrendDecomposition" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelVerification" minOccurs="0"/>
       </sequence>
       <attribute name="modelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="functionName" use="required" type="{http://www.dmg.org/PMML-4_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="bestFit" use="required">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="ARIMA"/>
             <enumeration value="ExponentialSmoothing"/>
             <enumeration value="SeasonalTrendDecomposition"/>
             <enumeration value="SpectralAnalysis"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeSeriesModel.Algorithm Java class for null.

Constructor Summary

Constructors

Constructor and Description
TimeSeriesModel()
TimeSeriesModel(MiningFunction miningFunction, TimeSeriesModel.Algorithm bestFit, MiningSchema miningSchema)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
TimeSeriesModel	addExtensions(Extension... extensions)
TimeSeriesModel	addTimeSeries(TimeSeries... timeSeries)
String	getAlgorithmName() Gets the value of the algorithmName property.
ARIMA	getARIMA() Gets the value of the arima property.
TimeSeriesModel.Algorithm	getBestFit() Gets the value of the bestFit property.
ExponentialSmoothing	getExponentialSmoothing() Gets the value of the exponentialSmoothing property.
List<Extension>	getExtensions() Gets the value of the extensions property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningFunction	getMiningFunction() Gets the value of the miningFunction property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
String	getModelName() Gets the value of the modelName property.
ModelStats	getModelStats() Gets the value of the modelStats property.
ModelVerification	getModelVerification() Gets the value of the modelVerification property.
Output	getOutput() Gets the value of the output property.
SeasonalTrendDecomposition	getSeasonalTrendDecomposition() Gets the value of the seasonalTrendDecomposition property.
SpectralAnalysis	getSpectralAnalysis() Gets the value of the spectralAnalysis property.
List<TimeSeries>	getTimeSeries() Gets the value of the timeSeries property.
boolean	hasExtensions()
boolean	hasTimeSeries()
boolean	isScorable() Gets the value of the scorable property.
TimeSeriesModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
TimeSeriesModel	setARIMA(ARIMA arima) Sets the value of the arima property.
TimeSeriesModel	setBestFit(TimeSeriesModel.Algorithm bestFit) Sets the value of the bestFit property.
TimeSeriesModel	setExponentialSmoothing(ExponentialSmoothing exponentialSmoothing) Sets the value of the exponentialSmoothing property.
TimeSeriesModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
TimeSeriesModel	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
TimeSeriesModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
TimeSeriesModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
TimeSeriesModel	setModelName(String modelName) Sets the value of the modelName property.
TimeSeriesModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
TimeSeriesModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
TimeSeriesModel	setOutput(Output output) Sets the value of the output property.
TimeSeriesModel	setScorable(Boolean scorable) Sets the value of the scorable property.
TimeSeriesModel	setSeasonalTrendDecomposition(SeasonalTrendDecomposition seasonalTrendDecomposition) Sets the value of the seasonalTrendDecomposition property.
TimeSeriesModel	setSpectralAnalysis(SpectralAnalysis spectralAnalysis) Sets the value of the spectralAnalysis property.

Methods inherited from class org.dmg.pmml.Model

getTargets, setTargets

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeSeriesModel

public TimeSeriesModel()

TimeSeriesModel

public TimeSeriesModel(MiningFunction miningFunction,
               TimeSeriesModel.Algorithm bestFit,
               MiningSchema miningSchema)

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public TimeSeriesModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public TimeSeriesModel setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public TimeSeriesModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getBestFit

public TimeSeriesModel.Algorithm getBestFit()

Gets the value of the bestFit property.

Returns:

possible object is TimeSeriesModel.Algorithm

setBestFit

public TimeSeriesModel setBestFit(TimeSeriesModel.Algorithm bestFit)

Sets the value of the bestFit property.

Parameters:

bestFit - allowed object is TimeSeriesModel.Algorithm

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public TimeSeriesModel setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

getExtensions

public List<Extension> getExtensions()

Gets the value of the extensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.

For example, to add a new item, do as follows:

    getExtensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Extension

Specified by:

getExtensions in interface HasExtensions

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public TimeSeriesModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public TimeSeriesModel setOutput(Output output)

Sets the value of the output property.

Overrides:

setOutput in class Model

Parameters:

output - allowed object is Output

getModelStats

public ModelStats getModelStats()

Gets the value of the modelStats property.

Specified by:

getModelStats in class Model

Returns:

possible object is ModelStats

setModelStats

public TimeSeriesModel setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Overrides:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public TimeSeriesModel setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Overrides:

setModelExplanation in class Model

Parameters:

modelExplanation - allowed object is ModelExplanation

getLocalTransformations

public LocalTransformations getLocalTransformations()

Gets the value of the localTransformations property.

Specified by:

getLocalTransformations in class Model

Returns:

possible object is LocalTransformations

setLocalTransformations

public TimeSeriesModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getTimeSeries

public List<TimeSeries> getTimeSeries()

Gets the value of the timeSeries property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the timeSeries property.

For example, to add a new item, do as follows:

    getTimeSeries().add(newItem);
 

Objects of the following type(s) are allowed in the list TimeSeries

getSpectralAnalysis

public SpectralAnalysis getSpectralAnalysis()

Gets the value of the spectralAnalysis property.

Returns:

possible object is SpectralAnalysis

setSpectralAnalysis

public TimeSeriesModel setSpectralAnalysis(SpectralAnalysis spectralAnalysis)

Sets the value of the spectralAnalysis property.

Parameters:

spectralAnalysis - allowed object is SpectralAnalysis

getARIMA

public ARIMA getARIMA()

Gets the value of the arima property.

Returns:

possible object is ARIMA

setARIMA

public TimeSeriesModel setARIMA(ARIMA arima)

Sets the value of the arima property.

Parameters:

arima - allowed object is ARIMA

getExponentialSmoothing

public ExponentialSmoothing getExponentialSmoothing()

Gets the value of the exponentialSmoothing property.

Returns:

possible object is ExponentialSmoothing

setExponentialSmoothing

public TimeSeriesModel setExponentialSmoothing(ExponentialSmoothing exponentialSmoothing)

Sets the value of the exponentialSmoothing property.

Parameters:

exponentialSmoothing - allowed object is ExponentialSmoothing

getSeasonalTrendDecomposition

public SeasonalTrendDecomposition getSeasonalTrendDecomposition()

Gets the value of the seasonalTrendDecomposition property.

Returns:

possible object is SeasonalTrendDecomposition

setSeasonalTrendDecomposition

public TimeSeriesModel setSeasonalTrendDecomposition(SeasonalTrendDecomposition seasonalTrendDecomposition)

Sets the value of the seasonalTrendDecomposition property.

Parameters:

seasonalTrendDecomposition - allowed object is SeasonalTrendDecomposition

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public TimeSeriesModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public TimeSeriesModel addExtensions(Extension... extensions)

hasTimeSeries

public boolean hasTimeSeries()

addTimeSeries

public TimeSeriesModel addTimeSeries(TimeSeries... timeSeries)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable