com.sas.cas.actions.sandcas

Class SandOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.sandcas.SandOptions

All Implemented Interfaces:

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

public class SandOptions
extends CASGeneratedActionOptions

Options for sand: SAND Action.

See Also:

Serialized Form

Nested Class Summary

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_BYLIMIT
static java.lang.String	KEY_CLASS
static java.lang.String	KEY_CLUSTER
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_FREQ
static java.lang.String	KEY_MODEL
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_SPARSE
static java.lang.String	KEY_SS3
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_TEST
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
SandOptions()
SandOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getByLimit()
ClassStatement[]	getClassParameter()
java.lang.String[]	getCluster()
DisplayTables	getDisplay()
java.lang.String	getFreq()
ModelStatement	getModel()
OutputTables	getOutputTables()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getSparse()
java.lang.Boolean	getSs3()
Castable	getTable()
java.lang.Integer[]	getTest()
java.lang.String	getWeight()
SandOptions	setByLimit(java.lang.Long value) Sets the value of parameter 'byLimit': specifies that the analysis will not be performed if the number of BY groups exceeds the specified value.
SandOptions	setClassParameter(ClassStatement[] value) Sets the value of parameter 'class'.
SandOptions	setCluster(java.lang.String[] value) Sets the value of parameter 'cluster'.
SandOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
SandOptions	setFreq(java.lang.String value) Sets the value of parameter 'freq'.
SandOptions	setModel(ModelStatement value) Sets the value of parameter 'model'.
SandOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
SandOptions	setSparse(java.lang.Boolean value) Sets the value of parameter 'sparse'.
SandOptions	setSs3(java.lang.Boolean value) Sets the value of parameter 'ss3': when set to True, performs a model analysis of variance based on type III sums of squares.
SandOptions	setTable(Castable value) Sets the value of parameter 'table': input data table.
SandOptions	setTest(java.lang.Integer[] value) Sets the value of parameter 'test'.
SandOptions	setWeight(java.lang.String value) Sets the value of parameter 'weight'.

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_SPARSE

public static final java.lang.String KEY_SPARSE

See Also:

Constant Field Values

KEY_CLASS

public static final java.lang.String KEY_CLASS

See Also:

Constant Field Values

KEY_CLUSTER

public static final java.lang.String KEY_CLUSTER

See Also:

Constant Field Values

KEY_MODEL

public static final java.lang.String KEY_MODEL

See Also:

Constant Field Values

KEY_WEIGHT

public static final java.lang.String KEY_WEIGHT

See Also:

Constant Field Values

KEY_FREQ

public static final java.lang.String KEY_FREQ

See Also:

Constant Field Values

KEY_DISPLAY

public static final java.lang.String KEY_DISPLAY

See Also:

Constant Field Values

KEY_OUTPUTTABLES

public static final java.lang.String KEY_OUTPUTTABLES

See Also:

Constant Field Values

KEY_SS3

public static final java.lang.String KEY_SS3

See Also:

Constant Field Values

KEY_TEST

public static final java.lang.String KEY_TEST

See Also:

Constant Field Values

KEY_BYLIMIT

public static final java.lang.String KEY_BYLIMIT

See Also:

Constant Field Values

Constructor Detail

SandOptions

public SandOptions()

SandOptions

public SandOptions(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 SandOptions setTable(Castable value)

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

Parameters:

value - The value

Returns:

The options object

getSparse

public java.lang.Boolean getSparse()

setSparse

public SandOptions setSparse(java.lang.Boolean value)

Sets the value of parameter 'sparse'. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getClassParameter

public ClassStatement[] getClassParameter()

setClassParameter

public SandOptions setClassParameter(ClassStatement[] value)

Sets the value of parameter 'class'.

Parameters:

value - The value

Returns:

The options object

getCluster

public java.lang.String[] getCluster()

setCluster

public SandOptions setCluster(java.lang.String[] value)

Sets the value of parameter 'cluster'.

Parameters:

value - The value

Returns:

The options object

getModel

public ModelStatement getModel()

setModel

public SandOptions setModel(ModelStatement value)

Sets the value of parameter 'model'.

Parameters:

value - The value

Returns:

The options object

getWeight

public java.lang.String getWeight()

setWeight

public SandOptions setWeight(java.lang.String value)

Sets the value of parameter 'weight'.

Parameters:

value - The value

Returns:

The options object

getFreq

public java.lang.String getFreq()

setFreq

public SandOptions setFreq(java.lang.String value)

Sets the value of parameter 'freq'.

Parameters:

value - The value

Returns:

The options object

getDisplay

public DisplayTables getDisplay()

setDisplay

public SandOptions setDisplay(DisplayTables value)

Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.

Parameters:

value - The value

Returns:

The options object

getOutputTables

public OutputTables getOutputTables()

setOutputTables

public SandOptions setOutputTables(OutputTables value)

Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.

Parameters:

value - The value

Returns:

The options object

getSs3

public java.lang.Boolean getSs3()

setSs3

public SandOptions setSs3(java.lang.Boolean value)

Sets the value of parameter 'ss3': when set to True, performs a model analysis of variance based on type III sums of squares. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getTest

public java.lang.Integer[] getTest()

setTest

public SandOptions setTest(java.lang.Integer[] value)

Sets the value of parameter 'test'.

Parameters:

value - The value

Returns:

The options object

getByLimit

public java.lang.Long getByLimit()

setByLimit

public SandOptions setByLimit(java.lang.Long value)

Sets the value of parameter 'byLimit': specifies that the analysis will not be performed if the number of BY groups exceeds the specified value.

Parameters:

value - The value

Returns:

The options object