com.sas.cas.actions

Class ClassStatement

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.ClassStatement

All Implemented Interfaces:

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

public class ClassStatement
extends CASGeneratedActionOptions

Options for classStatement.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassStatement.ORDER
static class	ClassStatement.PARAM
static class	ClassStatement.REF

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_COUNTMISSING
static java.lang.String	KEY_DESCENDING
static java.lang.String	KEY_IGNOREMISSING
static java.lang.String	KEY_LEVELIZERAW
static java.lang.String	KEY_MAXLEV
static java.lang.String	KEY_ORDER
static java.lang.String	KEY_PARAM
static java.lang.String	KEY_REF
static java.lang.String	KEY_SPLIT
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
ClassStatement()
ClassStatement(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getCountMissing()
java.lang.Boolean	getDescending()
java.lang.Boolean	getIgnoreMissing()
java.lang.Boolean	getLevelizeRaw()
java.lang.Integer	getMaxLev()
java.lang.String[]	getName()
ClassStatement.ORDER	getOrder()
ClassStatement.PARAM	getParam()
java.lang.Object	getRef()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getSplit()
java.lang.String[]	getVars()
ClassStatement	setCountMissing(java.lang.Boolean value) Sets the value of parameter 'countMissing': specifies that missing is a valid level for this variable.
ClassStatement	setDescending(java.lang.Boolean value) Sets the value of parameter 'descending': when set to True, reverses the sort order of the classification variable.
ClassStatement	setIgnoreMissing(java.lang.Boolean value) Sets the value of parameter 'ignoreMissing': ignores the fact that some variables in the observation have missing values, and honors the nonmissing values for other variables in that observation.
ClassStatement	setLevelizeRaw(java.lang.Boolean value) Sets the value of parameter 'levelizeRaw': bases levelization for this variable on raw values.
ClassStatement	setMaxLev(java.lang.Integer value) Sets the value of parameter 'maxLev': specifies the maximum number of levels.
ClassStatement	setName(java.lang.String[] value)
ClassStatement	setOrder(ClassStatement.ORDER value) Sets the value of parameter 'order': specifies the sort order for the levels of the classification variable.
ClassStatement	setParam(ClassStatement.PARAM value) Sets the value of parameter 'param': specifies the parameterization method for the classification variable or variables.
ClassStatement	setRef(ClassStatement.REF value) Sets the value of parameter 'ref' for alternative 1.
ClassStatement	setRef(java.lang.String value) Sets the value of parameter 'ref' for alternative 2.
ClassStatement	setSplit(java.lang.Boolean value) Sets the value of parameter 'split': enables selection of columns of the design matrix that correspond to any effect that contains a split classification variable to enter or leave a model independently of the other design columns of that effect.
ClassStatement	setVars(java.lang.String[] value) Sets the value of parameter 'vars': specifies the classification variables.

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_VARS

public static final java.lang.String KEY_VARS

See Also:

Constant Field Values

KEY_PARAM

public static final java.lang.String KEY_PARAM

See Also:

Constant Field Values

KEY_ORDER

public static final java.lang.String KEY_ORDER

See Also:

Constant Field Values

KEY_MAXLEV

public static final java.lang.String KEY_MAXLEV

See Also:

Constant Field Values

KEY_LEVELIZERAW

public static final java.lang.String KEY_LEVELIZERAW

See Also:

Constant Field Values

KEY_COUNTMISSING

public static final java.lang.String KEY_COUNTMISSING

See Also:

Constant Field Values

KEY_IGNOREMISSING

public static final java.lang.String KEY_IGNOREMISSING

See Also:

Constant Field Values

KEY_DESCENDING

public static final java.lang.String KEY_DESCENDING

See Also:

Constant Field Values

KEY_SPLIT

public static final java.lang.String KEY_SPLIT

See Also:

Constant Field Values

KEY_REF

public static final java.lang.String KEY_REF

See Also:

Constant Field Values

Constructor Detail

ClassStatement

public ClassStatement()

ClassStatement

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

getVars

public java.lang.String[] getVars()

getName

public java.lang.String[] getName()

setVars

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

Sets the value of parameter 'vars': specifies the classification variables.

Parameters:

value - The value

Returns:

The options object

setName

public ClassStatement setName(java.lang.String[] value)

getParam

public ClassStatement.PARAM getParam()

setParam

public ClassStatement setParam(ClassStatement.PARAM value)

Sets the value of parameter 'param': specifies the parameterization method for the classification variable or variables. When none of the classification variables have specified a parameterization, GLM is the default; otherwise, the default is REFERENCE. The server default is PARAM.BTH.

Parameters:

value - The value

Returns:

The options object

getOrder

public ClassStatement.ORDER getOrder()

setOrder

public ClassStatement setOrder(ClassStatement.ORDER value)

Sets the value of parameter 'order': specifies the sort order for the levels of the classification variable. This ordering determines which parameters in the model correspond to each level in the data. The server default is ORDER.FORMATTED.

Parameters:

value - The value

Returns:

The options object

getMaxLev

public java.lang.Integer getMaxLev()

setMaxLev

public ClassStatement setMaxLev(java.lang.Integer value)

Sets the value of parameter 'maxLev': specifies the maximum number of levels. A value of 0 means unlimited. The server default is 0.

Parameters:

value - The value

Returns:

The options object

getLevelizeRaw

public java.lang.Boolean getLevelizeRaw()

setLevelizeRaw

public ClassStatement setLevelizeRaw(java.lang.Boolean value)

Sets the value of parameter 'levelizeRaw': bases levelization for this variable on raw values. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getCountMissing

public java.lang.Boolean getCountMissing()

setCountMissing

public ClassStatement setCountMissing(java.lang.Boolean value)

Sets the value of parameter 'countMissing': specifies that missing is a valid level for this variable. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getIgnoreMissing

public java.lang.Boolean getIgnoreMissing()

setIgnoreMissing

public ClassStatement setIgnoreMissing(java.lang.Boolean value)

Sets the value of parameter 'ignoreMissing': ignores the fact that some variables in the observation have missing values, and honors the nonmissing values for other variables in that observation. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getDescending

public java.lang.Boolean getDescending()

setDescending

public ClassStatement setDescending(java.lang.Boolean value)

Sets the value of parameter 'descending': when set to True, reverses the sort order of the classification variable. When the descending parameter is set to True and a value is specified for the order parameter, the action orders the categories according to the requested order and then reverses that order. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getSplit

public java.lang.Boolean getSplit()

setSplit

public ClassStatement setSplit(java.lang.Boolean value)

Sets the value of parameter 'split': enables selection of columns of the design matrix that correspond to any effect that contains a split classification variable to enter or leave a model independently of the other design columns of that effect. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getRef

public java.lang.Object getRef()

setRef

public ClassStatement setRef(ClassStatement.REF value)

Sets the value of parameter 'ref' for alternative 1. The server default is REF.LAST.

Parameters:

value - The value

Returns:

The options object

setRef

public ClassStatement setRef(java.lang.String value)

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

Parameters:

value - The value

Returns:

The options object