org.dmg.pmml

Class TimeSeriesModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	algorithmName
protected ARIMA	arima
protected TimeSeriesAlgorithmType	bestFit
protected ExponentialSmoothing	exponentialSmoothing
protected List<Extension>	extensions
protected MiningFunctionType	functionName
protected LocalTransformations	localTransformations
protected MiningSchema	miningSchema
protected ModelExplanation	modelExplanation
protected String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected Output	output
protected Boolean	scorable
protected SeasonalTrendDecomposition	seasonalTrendDecomposition
protected SpectralAnalysis	spectralAnalysis
protected List<TimeSeries>	timeSeries

Constructor Summary

Constructors

Constructor and Description
TimeSeriesModel()
TimeSeriesModel(MiningFunctionType functionName, TimeSeriesAlgorithmType bestFit, MiningSchema miningSchema)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
String	getAlgorithmName() Gets the value of the algorithmName property.
ARIMA	getARIMA() Gets the value of the arima property.
TimeSeriesAlgorithmType	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.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations 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.
Targets	getTargets() Gets the value of the targets property.
List<TimeSeries>	getTimeSeries() Gets the value of the timeSeries property.
boolean	hasExtensions()
boolean	hasTimeSeries()
boolean	isScorable() Gets the value of the scorable property.
void	setAlgorithmName(String value) Sets the value of the algorithmName property.
void	setARIMA(ARIMA value) Sets the value of the arima property.
void	setBestFit(TimeSeriesAlgorithmType value) Sets the value of the bestFit property.
void	setExponentialSmoothing(ExponentialSmoothing value) Sets the value of the exponentialSmoothing property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setModelExplanation(ModelExplanation value) Sets the value of the modelExplanation property.
void	setModelName(String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setOutput(Output value) Sets the value of the output property.
void	setScorable(Boolean value) Sets the value of the scorable property.
void	setSeasonalTrendDecomposition(SeasonalTrendDecomposition value) Sets the value of the seasonalTrendDecomposition property.
void	setSpectralAnalysis(SpectralAnalysis value) Sets the value of the spectralAnalysis property.
void	setTargets(Targets targets) Sets the value of the targets property.
TimeSeriesModel	withAlgorithmName(String value)
TimeSeriesModel	withARIMA(ARIMA value)
TimeSeriesModel	withBestFit(TimeSeriesAlgorithmType value)
TimeSeriesModel	withExponentialSmoothing(ExponentialSmoothing value)
TimeSeriesModel	withExtensions(Collection<Extension> values)
TimeSeriesModel	withExtensions(Extension... values)
TimeSeriesModel	withFunctionName(MiningFunctionType value)
TimeSeriesModel	withLocalTransformations(LocalTransformations value)
TimeSeriesModel	withMiningSchema(MiningSchema value)
TimeSeriesModel	withModelExplanation(ModelExplanation value)
TimeSeriesModel	withModelName(String value)
TimeSeriesModel	withModelStats(ModelStats value)
TimeSeriesModel	withModelVerification(ModelVerification value)
TimeSeriesModel	withOutput(Output value)
TimeSeriesModel	withScorable(Boolean value)
TimeSeriesModel	withSeasonalTrendDecomposition(SeasonalTrendDecomposition value)
TimeSeriesModel	withSpectralAnalysis(SpectralAnalysis value)
TimeSeriesModel	withTimeSeries(Collection<TimeSeries> values)
TimeSeriesModel	withTimeSeries(TimeSeries... values)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator

Methods inherited from class java.lang.Object

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

Field Detail

modelName

protected String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected String algorithmName

bestFit

protected TimeSeriesAlgorithmType bestFit

scorable

protected Boolean scorable

extensions

protected List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

output

protected Output output

modelStats

protected ModelStats modelStats

modelExplanation

protected ModelExplanation modelExplanation

localTransformations

protected LocalTransformations localTransformations

timeSeries

protected List<TimeSeries> timeSeries

spectralAnalysis

protected SpectralAnalysis spectralAnalysis

arima

protected ARIMA arima

exponentialSmoothing

protected ExponentialSmoothing exponentialSmoothing

seasonalTrendDecomposition

protected SeasonalTrendDecomposition seasonalTrendDecomposition

modelVerification

protected ModelVerification modelVerification

Constructor Detail

TimeSeriesModel

public TimeSeriesModel()

TimeSeriesModel

public TimeSeriesModel(MiningFunctionType functionName,
               TimeSeriesAlgorithmType 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 void setModelName(String value)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

value - allowed object is String

getFunctionName

public MiningFunctionType getFunctionName()

Gets the value of the functionName property.

Specified by:

getFunctionName in class Model

Returns:

possible object is MiningFunctionType

setFunctionName

public void setFunctionName(MiningFunctionType value)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

value - allowed object is MiningFunctionType

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(String value)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

value - allowed object is String

getBestFit

public TimeSeriesAlgorithmType getBestFit()

Gets the value of the bestFit property.

Returns:

possible object is TimeSeriesAlgorithmType

setBestFit

public void setBestFit(TimeSeriesAlgorithmType value)

Sets the value of the bestFit property.

Parameters:

value - allowed object is TimeSeriesAlgorithmType

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public void setScorable(Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - 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 void setMiningSchema(MiningSchema value)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

value - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Returns:

possible object is Output

setOutput

public void setOutput(Output value)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

value - 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 void setModelStats(ModelStats value)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

value - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Parameters:

value - 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 void setLocalTransformations(LocalTransformations value)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

value - 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 void setSpectralAnalysis(SpectralAnalysis value)

Sets the value of the spectralAnalysis property.

Parameters:

value - allowed object is SpectralAnalysis

getARIMA

public ARIMA getARIMA()

Gets the value of the arima property.

Returns:

possible object is ARIMA

setARIMA

public void setARIMA(ARIMA value)

Sets the value of the arima property.

Parameters:

value - allowed object is ARIMA

getExponentialSmoothing

public ExponentialSmoothing getExponentialSmoothing()

Gets the value of the exponentialSmoothing property.

Returns:

possible object is ExponentialSmoothing

setExponentialSmoothing

public void setExponentialSmoothing(ExponentialSmoothing value)

Sets the value of the exponentialSmoothing property.

Parameters:

value - allowed object is ExponentialSmoothing

getSeasonalTrendDecomposition

public SeasonalTrendDecomposition getSeasonalTrendDecomposition()

Gets the value of the seasonalTrendDecomposition property.

Returns:

possible object is SeasonalTrendDecomposition

setSeasonalTrendDecomposition

public void setSeasonalTrendDecomposition(SeasonalTrendDecomposition value)

Sets the value of the seasonalTrendDecomposition property.

Parameters:

value - allowed object is SeasonalTrendDecomposition

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Specified by:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

value - allowed object is ModelVerification

withModelName

public TimeSeriesModel withModelName(String value)

withFunctionName

public TimeSeriesModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public TimeSeriesModel withAlgorithmName(String value)

withBestFit

public TimeSeriesModel withBestFit(TimeSeriesAlgorithmType value)

withScorable

public TimeSeriesModel withScorable(Boolean value)

withExtensions

public TimeSeriesModel withExtensions(Extension... values)

withExtensions

public TimeSeriesModel withExtensions(Collection<Extension> values)

withMiningSchema

public TimeSeriesModel withMiningSchema(MiningSchema value)

withOutput

public TimeSeriesModel withOutput(Output value)

withModelStats

public TimeSeriesModel withModelStats(ModelStats value)

withModelExplanation

public TimeSeriesModel withModelExplanation(ModelExplanation value)

withLocalTransformations

public TimeSeriesModel withLocalTransformations(LocalTransformations value)

withTimeSeries

public TimeSeriesModel withTimeSeries(TimeSeries... values)

withTimeSeries

public TimeSeriesModel withTimeSeries(Collection<TimeSeries> values)

withSpectralAnalysis

public TimeSeriesModel withSpectralAnalysis(SpectralAnalysis value)

withARIMA

public TimeSeriesModel withARIMA(ARIMA value)

withExponentialSmoothing

public TimeSeriesModel withExponentialSmoothing(ExponentialSmoothing value)

withSeasonalTrendDecomposition

public TimeSeriesModel withSeasonalTrendDecomposition(SeasonalTrendDecomposition value)

withModelVerification

public TimeSeriesModel withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

hasTimeSeries

public boolean hasTimeSeries()

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Throws:

UnsupportedOperationException - Always.

setTargets

public void setTargets(Targets targets)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Throws:

UnsupportedOperationException - Always.

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable