com.sas.cas.actions

Class Collection

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.Collection

All Implemented Interfaces:

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

public class Collection
extends CASGeneratedActionOptions

Options for collection.

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	KEY_DETAILS
static java.lang.String	KEY_NAME
static java.lang.String	KEY_VARS

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
Collection()
Collection(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDetails()
java.lang.String	getName()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.String[]	getVars()
Collection	setDetails(java.lang.Boolean value) Sets the value of parameter 'details': requests a table that shows additional details that are related to this effect.
Collection	setName(java.lang.String value) Sets the value of parameter 'name': specifies the name of the effect.
Collection	setVars(java.lang.String[] value) Sets the value of parameter 'vars': specifies a set of variables that are treated as a single effect that has multiple degrees of freedom.

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

KEY_NAME

public static final java.lang.String KEY_NAME

See Also:

Constant Field Values

KEY_DETAILS

public static final java.lang.String KEY_DETAILS

See Also:

Constant Field Values

KEY_VARS

public static final java.lang.String KEY_VARS

See Also:

Constant Field Values

Constructor Detail

Collection

public Collection()

Collection

public Collection(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

getName

public java.lang.String getName()

setName

public Collection setName(java.lang.String value)

Sets the value of parameter 'name': specifies the name of the effect.

Parameters:

value - The value

Returns:

The options object

getDetails

public java.lang.Boolean getDetails()

setDetails

public Collection setDetails(java.lang.Boolean value)

Sets the value of parameter 'details': requests a table that shows additional details that are related to this effect. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getVars

public java.lang.String[] getVars()

setVars

public Collection setVars(java.lang.String[] value)

Sets the value of parameter 'vars': specifies a set of variables that are treated as a single effect that has multiple degrees of freedom. The columns in the design matrix that are contributed by a collection effect are the design columns of its constituent variables in the order in which they appear in the definition of the collection effect.

Parameters:

value - The value

Returns:

The options object