com.sas.cas.actions.simpleForecast

Class ForecastOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.simpleForecast.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.MODE
static class	ForecastOptions.RESULT

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_ALPHA
static java.lang.String	KEY_COLDATA
static java.lang.String	KEY_CONTROLLABLES
static java.lang.String	KEY_CTBDATA
static java.lang.String	KEY_DEPENDENT
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_INMODEL
static java.lang.String	KEY_INTERVAL
static java.lang.String	KEY_LEAD
static java.lang.String	KEY_MODE
static java.lang.String	KEY_PREDICTORS
static java.lang.String	KEY_RESULT
static java.lang.String	KEY_ROWDATA
static java.lang.String	KEY_SEASONALITY
static java.lang.String	KEY_SELECTOUT
static java.lang.String	KEY_SPECOUT
static java.lang.String	KEY_TIMEID
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
java.lang.Double	getAlpha()
TsColData[]	getColData()
CVar[]	getControllables()
CVar[]	getConVars()
java.lang.Object	getCtbData()
java.lang.String	getDependent()
java.lang.Boolean	getForOut()
java.lang.String	getGoal()
java.lang.String	getGoalVar()
java.lang.Boolean	getIndepOut()
java.lang.Boolean	getInfoOut()
MSpec	getInModel()
java.lang.String	getInterval()
java.lang.Integer	getLead()
ForecastOptions.MODE	getMode()
java.lang.Boolean	getOutFor()
java.lang.Boolean	getOutIndep()
java.lang.Boolean	getOutInfo()
java.lang.Boolean	getOutSelect()
java.lang.Boolean	getOutSpec()
java.lang.String[]	getPredictors()
ForecastOptions.RESULT	getResult()
TsRowData	getRowData()
java.lang.Integer	getSeasonality()
java.lang.Boolean	getSelectOut()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getSpecOut()
java.lang.String	getTimeId()
java.lang.String	getWeight()
java.lang.String	getWeightVar()
java.lang.String[]	getXVars()
java.lang.String	getYVar()
ForecastOptions	setAlpha(java.lang.Double value) Sets the value of parameter 'alpha': significance for forecast confidence intervals.
ForecastOptions	setColData(TsColData[] value) Sets the value of parameter 'colData': input data as column set parameter list.
ForecastOptions	setControllables(CVar[] value) Sets the value of parameter 'controllables': controllable variables for goal seeking.
ForecastOptions	setConVars(CVar[] value)
ForecastOptions	setCtbData(java.lang.Object value) Sets the value of parameter 'ctbData': input data as TKCTB blob.
ForecastOptions	setDependent(java.lang.String value) Sets the value of parameter 'dependent': dependent variable for forecasting service.
ForecastOptions	setForOut(java.lang.Boolean value) Sets the value of parameter 'forOut': requests result table with OUTFOR= schema.
ForecastOptions	setGoal(java.lang.String value) Sets the value of parameter 'goal': goal variable for goal seeking.
ForecastOptions	setGoalVar(java.lang.String value)
ForecastOptions	setIndepOut(java.lang.Boolean value) Sets the value of parameter 'indepOut': requests result table with OUTINDEP= schema.
ForecastOptions	setInfoOut(java.lang.Boolean value) Sets the value of parameter 'infoOut': requests result table with OUTINFO= schema.
ForecastOptions	setInModel(MSpec value) Sets the value of parameter 'inModel': model XML to replay in forecast action.
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	setMode(ForecastOptions.MODE value) Sets the value of parameter 'mode': mode for forecasting service.
ForecastOptions	setOutFor(java.lang.Boolean value)
ForecastOptions	setOutIndep(java.lang.Boolean value)
ForecastOptions	setOutInfo(java.lang.Boolean value)
ForecastOptions	setOutSelect(java.lang.Boolean value)
ForecastOptions	setOutSpec(java.lang.Boolean value)
ForecastOptions	setPredictors(java.lang.String[] 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	setRowData(TsRowData value) Sets the value of parameter 'rowData': input data as row set parameter list.
ForecastOptions	setSeasonality(java.lang.Integer value) Sets the value of parameter 'seasonality': time periods per seasonal cycle.
ForecastOptions	setSelectOut(java.lang.Boolean value) Sets the value of parameter 'selectOut': requests result table with OUTSELECT= schema.
ForecastOptions	setSpecOut(java.lang.Boolean value) Sets the value of parameter 'specOut': requests result table with OUTSPEC= schema.
ForecastOptions	setTimeId(java.lang.String value) Sets the value of parameter 'timeId': time stamp variable.
ForecastOptions	setWeight(java.lang.String value) Sets the value of parameter 'weight': weight variable for goal seeking.
ForecastOptions	setWeightVar(java.lang.String value)
ForecastOptions	setXVars(java.lang.String[] value)
ForecastOptions	setYVar(java.lang.String 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_CTBDATA

public static final java.lang.String KEY_CTBDATA

See Also:

Constant Field Values

KEY_COLDATA

public static final java.lang.String KEY_COLDATA

See Also:

Constant Field Values

KEY_ROWDATA

public static final java.lang.String KEY_ROWDATA

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_TIMEID

public static final java.lang.String KEY_TIMEID

See Also:

Constant Field Values

KEY_DEPENDENT

public static final java.lang.String KEY_DEPENDENT

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_RESULT

public static final java.lang.String KEY_RESULT

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_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_INMODEL

public static final java.lang.String KEY_INMODEL

See Also:

Constant Field Values

KEY_ALPHA

public static final java.lang.String KEY_ALPHA

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

getCtbData

public java.lang.Object getCtbData()

setCtbData

public ForecastOptions setCtbData(java.lang.Object value)

Sets the value of parameter 'ctbData': input data as TKCTB blob.

Parameters:

value - The value

Returns:

The options object

getColData

public TsColData[] getColData()

setColData

public ForecastOptions setColData(TsColData[] value)

Sets the value of parameter 'colData': input data as column set parameter list.

Parameters:

value - The value

Returns:

The options object

getRowData

public TsRowData getRowData()

setRowData

public ForecastOptions setRowData(TsRowData value)

Sets the value of parameter 'rowData': input data as row set parameter list.

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.

Parameters:

value - The value

Returns:

The options object

getTimeId

public java.lang.String getTimeId()

setTimeId

public ForecastOptions setTimeId(java.lang.String value)

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

Parameters:

value - The value

Returns:

The options object

getDependent

public java.lang.String getDependent()

getYVar

public java.lang.String getYVar()

setDependent

public ForecastOptions setDependent(java.lang.String value)

Sets the value of parameter 'dependent': dependent variable for forecasting service.

Parameters:

value - The value

Returns:

The options object

setYVar

public ForecastOptions setYVar(java.lang.String value)

getPredictors

public java.lang.String[] getPredictors()

getXVars

public java.lang.String[] getXVars()

setPredictors

public ForecastOptions setPredictors(java.lang.String[] value)

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

Parameters:

value - The value

Returns:

The options object

setXVars

public ForecastOptions setXVars(java.lang.String[] 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

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

getGoal

public java.lang.String getGoal()

getGoalVar

public java.lang.String getGoalVar()

setGoal

public ForecastOptions setGoal(java.lang.String value)

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

Parameters:

value - The value

Returns:

The options object

setGoalVar

public ForecastOptions setGoalVar(java.lang.String value)

getWeight

public java.lang.String getWeight()

getWeightVar

public java.lang.String getWeightVar()

setWeight

public ForecastOptions setWeight(java.lang.String value)

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

Parameters:

value - The value

Returns:

The options object

setWeightVar

public ForecastOptions setWeightVar(java.lang.String 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)

getForOut

public java.lang.Boolean getForOut()

getOutFor

public java.lang.Boolean getOutFor()

setForOut

public ForecastOptions setForOut(java.lang.Boolean value)

Sets the value of parameter 'forOut': requests result table with OUTFOR= schema. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setOutFor

public ForecastOptions setOutFor(java.lang.Boolean value)

getInfoOut

public java.lang.Boolean getInfoOut()

getOutInfo

public java.lang.Boolean getOutInfo()

setInfoOut

public ForecastOptions setInfoOut(java.lang.Boolean value)

Sets the value of parameter 'infoOut': requests result table with OUTINFO= schema. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setOutInfo

public ForecastOptions setOutInfo(java.lang.Boolean value)

getIndepOut

public java.lang.Boolean getIndepOut()

getOutIndep

public java.lang.Boolean getOutIndep()

setIndepOut

public ForecastOptions setIndepOut(java.lang.Boolean value)

Sets the value of parameter 'indepOut': requests result table with OUTINDEP= schema. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setOutIndep

public ForecastOptions setOutIndep(java.lang.Boolean value)

getSelectOut

public java.lang.Boolean getSelectOut()

getOutSelect

public java.lang.Boolean getOutSelect()

setSelectOut

public ForecastOptions setSelectOut(java.lang.Boolean value)

Sets the value of parameter 'selectOut': requests result table with OUTSELECT= schema. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setOutSelect

public ForecastOptions setOutSelect(java.lang.Boolean value)

getSpecOut

public java.lang.Boolean getSpecOut()

getOutSpec

public java.lang.Boolean getOutSpec()

setSpecOut

public ForecastOptions setSpecOut(java.lang.Boolean value)

Sets the value of parameter 'specOut': requests result table with OUTSPEC= schema. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setOutSpec

public ForecastOptions setOutSpec(java.lang.Boolean value)

getInModel

public MSpec getInModel()

setInModel

public ForecastOptions setInModel(MSpec value)

Sets the value of parameter 'inModel': model XML to replay in forecast action.

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