Package org.jpmml.evaluator.time_series

Class TimeSeriesModelEvaluator

java.lang.Object

org.jpmml.evaluator.PMMLManager

org.jpmml.evaluator.ModelManager<M>

org.jpmml.evaluator.ModelEvaluator<org.dmg.pmml.time_series.TimeSeriesModel>

org.jpmml.evaluator.time_series.TimeSeriesModelEvaluator

All Implemented Interfaces:

java.io.Serializable, Evaluator, HasActiveFields, HasInputFields, HasModel<org.dmg.pmml.time_series.TimeSeriesModel>, HasOrderFields, HasPMML, HasResultFields, HasSupplementaryFields

public class TimeSeriesModelEvaluator
extends ModelEvaluator<org.dmg.pmml.time_series.TimeSeriesModel>
implements HasSupplementaryFields, HasOrderFields

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jpmml.evaluator.Evaluator

DEFAULT_TARGET_NAME

Constructor Summary

Constructors

Constructor	Description
TimeSeriesModelEvaluator(org.dmg.pmml.PMML pmml)
TimeSeriesModelEvaluator(org.dmg.pmml.PMML pmml, org.dmg.pmml.time_series.TimeSeriesModel timeSeriesModel)

Method Summary

Modifier and Type	Method	Description
protected <V extends java.lang.Number> java.util.Map<java.lang.String,?>	evaluateTimeSeries(ValueFactory<V> valueFactory, EvaluationContext context)
int	getForecastHorizon(EvaluationContext context)
java.util.List<InputField>	getOrderFields()	Gets the order fields of a Model from its MiningSchema.
java.lang.String	getSummary()	Gets a short description of the Model.
java.util.List<InputField>	getSupplementaryFields()

Methods inherited from class org.jpmml.evaluator.ModelEvaluator

assessParentCompatibility, assessPurity, configure, createClassification, createEvaluationContext, ensureConfiguration, ensureModelEvaluatorFactory, ensureOutputFilter, ensureValueFactory, ensureValueFactoryFactory, evaluate, evaluateAssociationRules, evaluateClassification, evaluateClustering, evaluateInternal, evaluateMixed, evaluateOutput, evaluateRegression, evaluateSequences, filterInputFields, filterOutputFields, filterTargetFields, getConfiguration, getInputMapper, getNumberOfVisibleFields, getResultMapper, isParentCompatible, isPure, processArguments, processResults, verify

Methods inherited from class org.jpmml.evaluator.ModelManager

addResultFeatures, collectResultFeatures, collectSegmentResultFeatures, createInputFields, createInputFields, createMiningSchemaException, createOutputFields, createTargetFields, getActiveFields, getDataField, getDefaultDataField, getInputFields, getLocalDerivedField, getMathContext, getMiningField, getMiningFunction, getModel, getOutputField, getOutputFields, getResultFeatures, getTarget, getTargetField, getTargetFields, getTargetName, getVisibleFields, hasLocalDerivedFields, hasOutputFields, hasResultFeature, resetInputFields, resetResultFields, resolveField, setDefaultDataField

Methods inherited from class org.jpmml.evaluator.PMMLManager

getDefineFunction, getDerivedField, getPMML, toImmutableListMap, toImmutableMapMap, toImmutableSetMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.evaluator.Evaluator

getMiningFunction

Methods inherited from interface org.jpmml.evaluator.HasActiveFields

getActiveFields

Methods inherited from interface org.jpmml.evaluator.HasInputFields

getInputFields

Methods inherited from interface org.jpmml.evaluator.HasPMML

getPMML

Methods inherited from interface org.jpmml.evaluator.HasResultFields

getOutputFields, getTargetFields

Constructor Detail

TimeSeriesModelEvaluator

public TimeSeriesModelEvaluator(org.dmg.pmml.PMML pmml)

TimeSeriesModelEvaluator

public TimeSeriesModelEvaluator(org.dmg.pmml.PMML pmml,
                                org.dmg.pmml.time_series.TimeSeriesModel timeSeriesModel)

Method Detail

getSummary

public java.lang.String getSummary()

Description copied from interface: Evaluator

Gets a short description of the Model.

Specified by:

getSummary in interface Evaluator

getSupplementaryFields

public java.util.List<InputField> getSupplementaryFields()

Specified by:

getSupplementaryFields in interface HasSupplementaryFields

getOrderFields

public java.util.List<InputField> getOrderFields()

Description copied from interface: HasOrderFields

Gets the order fields of a Model from its MiningSchema.

This field set is relevant for sequences and time series model types.

Specified by:

getOrderFields in interface HasOrderFields

getForecastHorizon

public int getForecastHorizon(EvaluationContext context)

evaluateTimeSeries

protected <V extends java.lang.Number> java.util.Map<java.lang.String,?> evaluateTimeSeries(ValueFactory<V> valueFactory,
                                                                                                  EvaluationContext context)

Overrides:

evaluateTimeSeries in class ModelEvaluator<org.dmg.pmml.time_series.TimeSeriesModel>