com.sas.cas.actions.timeData

Class ForecastOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.timeData.ForecastOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class ForecastOptions
extends CASGeneratedActionOptions

Options for forecast: Auto-forecast time series.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForecastOptions.ALIGNID
static class	ForecastOptions.BOUNDARYALIGN
static class	ForecastOptions.MODE
static class	ForecastOptions.RESULT
static class	ForecastOptions.TRIMID

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_ALIGNID
static java.lang.String	KEY_ALPHA
static java.lang.String	KEY_AUXDATA
static java.lang.String	KEY_BOUNDARYALIGN
static java.lang.String	KEY_CONTROLLABLES
static java.lang.String	KEY_DEPENDENTS
static java.lang.String	KEY_FOROUT
static java.lang.String	KEY_GOAL
static java.lang.String	KEY_INDEPOUT
static java.lang.String	KEY_INFOOUT
static java.lang.String	KEY_INTERVAL
static java.lang.String	KEY_LEAD
static java.lang.String	KEY_LOGCONTROL
static java.lang.String	KEY_LOGOUT
static java.lang.String	KEY_MODE
static java.lang.String	KEY_PREDICTORS
static java.lang.String	KEY_RESULT
static java.lang.String	KEY_SEASONALITY
static java.lang.String	KEY_SELECTOUT
static java.lang.String	KEY_SPECOUT
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_TEND
static java.lang.String	KEY_TIMEID
static java.lang.String	KEY_TRIMID
static java.lang.String	KEY_TSTART
static java.lang.String	KEY_WEIGHT

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
ForecastOptions()
ForecastOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
ForecastOptions.ALIGNID	getAlignId()
java.lang.Double	getAlpha()
Castable[]	getAuxData()
ForecastOptions.BOUNDARYALIGN	getBoundaryAlign()
CVar[]	getControllables()
CVar[]	getConVars()
Tsinvar[]	getDependents()
Casouttable	getForOut()
Tsinvar	getGoal()
Tsinvar	getGoalVar()
Casouttable	getIndepOut()
Casouttable	getInfoOut()
java.lang.String	getInterval()
java.lang.Integer	getLead()
LogcSev[]	getLogControl()
Casouttable	getLogOut()
ForecastOptions.MODE	getMode()
Casouttable	getOutFor()
Casouttable	getOutIndep()
Casouttable	getOutInfo()
Casouttable	getOutLog()
Casouttable	getOutSelect()
Casouttable	getOutSpec()
Tsinvar[]	getPredictors()
ForecastOptions.RESULT	getResult()
java.lang.Integer	getSeasonality()
Casouttable	getSelectOut()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Casouttable	getSpecOut()
Castable	getTable()
java.lang.Object	getTEnd()
Casinvardesc	getTimeId()
ForecastOptions.TRIMID	getTrimId()
java.lang.Object	getTStart()
Tsinvar	getWeight()
Tsinvar	getWeightVar()
Tsinvar[]	getXVars()
Tsinvar[]	getYVars()
ForecastOptions	setAlignId(ForecastOptions.ALIGNID value) Sets the value of parameter 'alignId': time ID alignment (Begin,Middle,End).
ForecastOptions	setAlpha(java.lang.Double value) Sets the value of parameter 'alpha': significance for forecast confidence intervals.
ForecastOptions	setAuxData(Castable[] value) Sets the value of parameter 'auxData': auxiliary time series data tables.
ForecastOptions	setBoundaryAlign(ForecastOptions.BOUNDARYALIGN value) Sets the value of parameter 'boundaryAlign': start and end time stamp alignment (Both,Start,End,None).
ForecastOptions	setControllables(CVar[] value) Sets the value of parameter 'controllables': controllable variables for goal seeking.
ForecastOptions	setConVars(CVar[] value)
ForecastOptions	setDependents(Tsinvar[] value) Sets the value of parameter 'dependents': dependent variable(s) for forecasting service.
ForecastOptions	setForOut(Casouttable value) Sets the value of parameter 'forOut': specifies CAS output table for forecasts.
ForecastOptions	setGoal(Tsinvar value) Sets the value of parameter 'goal': goal variable for goal seeking.
ForecastOptions	setGoalVar(Tsinvar value)
ForecastOptions	setIndepOut(Casouttable value) Sets the value of parameter 'indepOut': specifies CAS output table for independent variables.
ForecastOptions	setInfoOut(Casouttable value) Sets the value of parameter 'infoOut': specifies CAS output table for forecast information.
ForecastOptions	setInterval(java.lang.String value) Sets the value of parameter 'interval': time interval (frequency).
ForecastOptions	setLead(java.lang.Integer value) Sets the value of parameter 'lead': forecast lead.
ForecastOptions	setLogControl(LogcSev[] value) Sets the value of parameter 'logControl': specifies message log control for forecasting.
ForecastOptions	setLogOut(Casouttable value) Sets the value of parameter 'logOut': specifies CAS output table for forecast message logging.
ForecastOptions	setMode(ForecastOptions.MODE value) Sets the value of parameter 'mode': mode for forecasting service.
ForecastOptions	setOutFor(Casouttable value)
ForecastOptions	setOutIndep(Casouttable value)
ForecastOptions	setOutInfo(Casouttable value)
ForecastOptions	setOutLog(Casouttable value)
ForecastOptions	setOutSelect(Casouttable value)
ForecastOptions	setOutSpec(Casouttable value)
ForecastOptions	setPredictors(Tsinvar[] value) Sets the value of parameter 'predictors': independent variables for forecasting service.
ForecastOptions	setResult(ForecastOptions.RESULT value) Sets the value of parameter 'result': time region of interest for result series.
ForecastOptions	setSeasonality(java.lang.Integer value) Sets the value of parameter 'seasonality': time periods per seasonal cycle (default from time interval).
ForecastOptions	setSelectOut(Casouttable value) Sets the value of parameter 'selectOut': specifies CAS output table for model selection information.
ForecastOptions	setSpecOut(Casouttable value) Sets the value of parameter 'specOut': specifies CAS output table for model specifications generated.
ForecastOptions	setTable(Castable value) Sets the value of parameter 'table': input data table.
ForecastOptions	setTEnd(java.lang.Double value) Sets the value of parameter 'tEnd' for alternative 1.
ForecastOptions	setTEnd(java.lang.String value) Sets the value of parameter 'tEnd' for alternative 2.
ForecastOptions	setTimeId(Casinvardesc value) Sets the value of parameter 'timeId': time stamp variable.
ForecastOptions	setTrimId(ForecastOptions.TRIMID value) Sets the value of parameter 'trimId': trim BY group time series data frames as directed.
ForecastOptions	setTStart(java.lang.Double value) Sets the value of parameter 'tStart' for alternative 1.
ForecastOptions	setTStart(java.lang.String value) Sets the value of parameter 'tStart' for alternative 2.
ForecastOptions	setWeight(Tsinvar value) Sets the value of parameter 'weight': weight variable for goal seeking.
ForecastOptions	setWeightVar(Tsinvar value)
ForecastOptions	setXVars(Tsinvar[] value)
ForecastOptions	setYVars(Tsinvar[] value)

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_TABLE

public static final java.lang.String KEY_TABLE

See Also:

Constant Field Values

KEY_TIMEID

public static final java.lang.String KEY_TIMEID

See Also:

Constant Field Values

KEY_TSTART

public static final java.lang.String KEY_TSTART

See Also:

Constant Field Values

KEY_TEND

public static final java.lang.String KEY_TEND

See Also:

Constant Field Values

KEY_INTERVAL

public static final java.lang.String KEY_INTERVAL

See Also:

Constant Field Values

KEY_SEASONALITY

public static final java.lang.String KEY_SEASONALITY

See Also:

Constant Field Values

KEY_AUXDATA

public static final java.lang.String KEY_AUXDATA

See Also:

Constant Field Values

KEY_TRIMID

public static final java.lang.String KEY_TRIMID

See Also:

Constant Field Values

KEY_ALIGNID

public static final java.lang.String KEY_ALIGNID

See Also:

Constant Field Values

KEY_BOUNDARYALIGN

public static final java.lang.String KEY_BOUNDARYALIGN

See Also:

Constant Field Values

KEY_DEPENDENTS

public static final java.lang.String KEY_DEPENDENTS

See Also:

Constant Field Values

KEY_PREDICTORS

public static final java.lang.String KEY_PREDICTORS

See Also:

Constant Field Values

KEY_LEAD

public static final java.lang.String KEY_LEAD

See Also:

Constant Field Values

KEY_MODE

public static final java.lang.String KEY_MODE

See Also:

Constant Field Values

KEY_FOROUT

public static final java.lang.String KEY_FOROUT

See Also:

Constant Field Values

KEY_INFOOUT

public static final java.lang.String KEY_INFOOUT

See Also:

Constant Field Values

KEY_INDEPOUT

public static final java.lang.String KEY_INDEPOUT

See Also:

Constant Field Values

KEY_SELECTOUT

public static final java.lang.String KEY_SELECTOUT

See Also:

Constant Field Values

KEY_SPECOUT

public static final java.lang.String KEY_SPECOUT

See Also:

Constant Field Values

KEY_GOAL

public static final java.lang.String KEY_GOAL

See Also:

Constant Field Values

KEY_WEIGHT

public static final java.lang.String KEY_WEIGHT

See Also:

Constant Field Values

KEY_CONTROLLABLES

public static final java.lang.String KEY_CONTROLLABLES

See Also:

Constant Field Values

KEY_RESULT

public static final java.lang.String KEY_RESULT

See Also:

Constant Field Values

KEY_ALPHA

public static final java.lang.String KEY_ALPHA

See Also:

Constant Field Values

KEY_LOGOUT

public static final java.lang.String KEY_LOGOUT

See Also:

Constant Field Values

KEY_LOGCONTROL

public static final java.lang.String KEY_LOGCONTROL

See Also:

Constant Field Values

Constructor Detail

ForecastOptions

public ForecastOptions()

ForecastOptions

public ForecastOptions(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getTable

public Castable getTable()

setTable

public ForecastOptions setTable(Castable value)

Sets the value of parameter 'table': input data table.

Parameters:

value - The value

Returns:

The options object

getTimeId

public Casinvardesc getTimeId()

setTimeId

public ForecastOptions setTimeId(Casinvardesc value)

Sets the value of parameter 'timeId': time stamp variable.

Parameters:

value - The value

Returns:

The options object

getTStart

public java.lang.Object getTStart()

setTStart

public ForecastOptions setTStart(java.lang.Double value)

Sets the value of parameter 'tStart' for alternative 1.

Parameters:

value - The value

Returns:

The options object

setTStart

public ForecastOptions setTStart(java.lang.String value)

Sets the value of parameter 'tStart' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getTEnd

public java.lang.Object getTEnd()

setTEnd

public ForecastOptions setTEnd(java.lang.Double value)

Sets the value of parameter 'tEnd' for alternative 1.

Parameters:

value - The value

Returns:

The options object

setTEnd

public ForecastOptions setTEnd(java.lang.String value)

Sets the value of parameter 'tEnd' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getInterval

public java.lang.String getInterval()

setInterval

public ForecastOptions setInterval(java.lang.String value)

Sets the value of parameter 'interval': time interval (frequency).

Parameters:

value - The value

Returns:

The options object

getSeasonality

public java.lang.Integer getSeasonality()

setSeasonality

public ForecastOptions setSeasonality(java.lang.Integer value)

Sets the value of parameter 'seasonality': time periods per seasonal cycle (default from time interval).

Parameters:

value - The value

Returns:

The options object

getAuxData

public Castable[] getAuxData()

setAuxData

public ForecastOptions setAuxData(Castable[] value)

Sets the value of parameter 'auxData': auxiliary time series data tables.

Parameters:

value - The value

Returns:

The options object

getTrimId

public ForecastOptions.TRIMID getTrimId()

setTrimId

public ForecastOptions setTrimId(ForecastOptions.TRIMID value)

Sets the value of parameter 'trimId': trim BY group time series data frames as directed. The server default is TRIMID.NONE.

Parameters:

value - The value

Returns:

The options object

getAlignId

public ForecastOptions.ALIGNID getAlignId()

setAlignId

public ForecastOptions setAlignId(ForecastOptions.ALIGNID value)

Sets the value of parameter 'alignId': time ID alignment (Begin,Middle,End). The server default is ALIGNID.BEGIN.

Parameters:

value - The value

Returns:

The options object

getBoundaryAlign

public ForecastOptions.BOUNDARYALIGN getBoundaryAlign()

setBoundaryAlign

public ForecastOptions setBoundaryAlign(ForecastOptions.BOUNDARYALIGN value)

Sets the value of parameter 'boundaryAlign': start and end time stamp alignment (Both,Start,End,None). The server default is BOUNDARYALIGN.BOTH.

Parameters:

value - The value

Returns:

The options object

getDependents

public Tsinvar[] getDependents()

getYVars

public Tsinvar[] getYVars()

setDependents

public ForecastOptions setDependents(Tsinvar[] value)

Sets the value of parameter 'dependents': dependent variable(s) for forecasting service.

Parameters:

value - The value

Returns:

The options object

setYVars

public ForecastOptions setYVars(Tsinvar[] value)

getPredictors

public Tsinvar[] getPredictors()

getXVars

public Tsinvar[] getXVars()

setPredictors

public ForecastOptions setPredictors(Tsinvar[] value)

Sets the value of parameter 'predictors': independent variables for forecasting service.

Parameters:

value - The value

Returns:

The options object

setXVars

public ForecastOptions setXVars(Tsinvar[] value)

getLead

public java.lang.Integer getLead()

setLead

public ForecastOptions setLead(java.lang.Integer value)

Sets the value of parameter 'lead': forecast lead.

Parameters:

value - The value

Returns:

The options object

getMode

public ForecastOptions.MODE getMode()

setMode

public ForecastOptions setMode(ForecastOptions.MODE value)

Sets the value of parameter 'mode': mode for forecasting service. The server default is MODE.DYNAMIC.

Parameters:

value - The value

Returns:

The options object

getForOut

public Casouttable getForOut()

getOutFor

public Casouttable getOutFor()

setForOut

public ForecastOptions setForOut(Casouttable value)

Sets the value of parameter 'forOut': specifies CAS output table for forecasts.

Parameters:

value - The value

Returns:

The options object

setOutFor

public ForecastOptions setOutFor(Casouttable value)

getInfoOut

public Casouttable getInfoOut()

getOutInfo

public Casouttable getOutInfo()

setInfoOut

public ForecastOptions setInfoOut(Casouttable value)

Sets the value of parameter 'infoOut': specifies CAS output table for forecast information.

Parameters:

value - The value

Returns:

The options object

setOutInfo

public ForecastOptions setOutInfo(Casouttable value)

getIndepOut

public Casouttable getIndepOut()

getOutIndep

public Casouttable getOutIndep()

setIndepOut

public ForecastOptions setIndepOut(Casouttable value)

Sets the value of parameter 'indepOut': specifies CAS output table for independent variables.

Parameters:

value - The value

Returns:

The options object

setOutIndep

public ForecastOptions setOutIndep(Casouttable value)

getSelectOut

public Casouttable getSelectOut()

getOutSelect

public Casouttable getOutSelect()

setSelectOut

public ForecastOptions setSelectOut(Casouttable value)

Sets the value of parameter 'selectOut': specifies CAS output table for model selection information.

Parameters:

value - The value

Returns:

The options object

setOutSelect

public ForecastOptions setOutSelect(Casouttable value)

getSpecOut

public Casouttable getSpecOut()

getOutSpec

public Casouttable getOutSpec()

setSpecOut

public ForecastOptions setSpecOut(Casouttable value)

Sets the value of parameter 'specOut': specifies CAS output table for model specifications generated.

Parameters:

value - The value

Returns:

The options object

setOutSpec

public ForecastOptions setOutSpec(Casouttable value)

getGoal

public Tsinvar getGoal()

getGoalVar

public Tsinvar getGoalVar()

setGoal

public ForecastOptions setGoal(Tsinvar value)

Sets the value of parameter 'goal': goal variable for goal seeking.

Parameters:

value - The value

Returns:

The options object

setGoalVar

public ForecastOptions setGoalVar(Tsinvar value)

getWeight

public Tsinvar getWeight()

getWeightVar

public Tsinvar getWeightVar()

setWeight

public ForecastOptions setWeight(Tsinvar value)

Sets the value of parameter 'weight': weight variable for goal seeking.

Parameters:

value - The value

Returns:

The options object

setWeightVar

public ForecastOptions setWeightVar(Tsinvar value)

getControllables

public CVar[] getControllables()

getConVars

public CVar[] getConVars()

setControllables

public ForecastOptions setControllables(CVar[] value)

Sets the value of parameter 'controllables': controllable variables for goal seeking.

Parameters:

value - The value

Returns:

The options object

setConVars

public ForecastOptions setConVars(CVar[] value)

getResult

public ForecastOptions.RESULT getResult()

setResult

public ForecastOptions setResult(ForecastOptions.RESULT value)

Sets the value of parameter 'result': time region of interest for result series. The server default is RESULT.ALL.

Parameters:

value - The value

Returns:

The options object

getAlpha

public java.lang.Double getAlpha()

setAlpha

public ForecastOptions setAlpha(java.lang.Double value)

Sets the value of parameter 'alpha': significance for forecast confidence intervals.

Parameters:

value - The value

Returns:

The options object

getLogOut

public Casouttable getLogOut()

getOutLog

public Casouttable getOutLog()

setLogOut

public ForecastOptions setLogOut(Casouttable value)

Sets the value of parameter 'logOut': specifies CAS output table for forecast message logging.

Parameters:

value - The value

Returns:

The options object

setOutLog

public ForecastOptions setOutLog(Casouttable value)

getLogControl

public LogcSev[] getLogControl()

setLogControl

public ForecastOptions setLogControl(LogcSev[] value)

Sets the value of parameter 'logControl': specifies message log control for forecasting.

Parameters:

value - The value

Returns:

The options object