com.sas.cas.actions

Class Effect

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.Effect

All Implemented Interfaces:

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

public class Effect
extends CASGeneratedActionOptions

Options for modelStatement.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Effect.INTERACTION

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_INTERACTION
static java.lang.String	KEY_MAXINTERACT
static java.lang.String	KEY_NEST
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
Effect()
Effect(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
Effect.INTERACTION	getInteract()
Effect.INTERACTION	getInteraction()
java.lang.Integer	getMaxInteract()
java.lang.String[]	getNest()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.String[]	getVars()
Effect	setInteract(Effect.INTERACTION value)
Effect	setInteraction(Effect.INTERACTION value) Sets the value of parameter 'interaction': specifies the type of interaction for the variables.
Effect	setMaxInteract(java.lang.Integer value) Sets the value of parameter 'maxInteract': eliminates higher-order interaction effects when used in conjunction with the BAR interaction.
Effect	setNest(java.lang.String[] value) Sets the value of parameter 'nest': specifies the variables that are nested within the term defined by the vars parameter.
Effect	setVars(java.lang.String[] value) Sets the value of parameter 'vars': specifies the variables to be used in defining a term of the effect.

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_NEST

public static final java.lang.String KEY_NEST

See Also:

Constant Field Values

KEY_INTERACTION

public static final java.lang.String KEY_INTERACTION

See Also:

Constant Field Values

KEY_MAXINTERACT

public static final java.lang.String KEY_MAXINTERACT

See Also:

Constant Field Values

Constructor Detail

Effect

public Effect()

Effect

public Effect(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()

setVars

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

Sets the value of parameter 'vars': specifies the variables to be used in defining a term of the effect. You must specify at least one such variable.

Parameters:

value - The value

Returns:

The options object

getNest

public java.lang.String[] getNest()

setNest

public Effect setNest(java.lang.String[] value)

Sets the value of parameter 'nest': specifies the variables that are nested within the term defined by the vars parameter. For terms with a BAR or CROSS interaction, the nest corresponds to the last variable in the vars parameter. For terms with no interaction, the nest is distributed across all variables listed in the vars parameter.

Parameters:

value - The value

Returns:

The options object

getInteraction

public Effect.INTERACTION getInteraction()

getInteract

public Effect.INTERACTION getInteract()

setInteraction

public Effect setInteraction(Effect.INTERACTION value)

Sets the value of parameter 'interaction': specifies the type of interaction for the variables. The server default is INTERACTION.NONE.

Parameters:

value - The value

Returns:

The options object

setInteract

public Effect setInteract(Effect.INTERACTION value)

getMaxInteract

public java.lang.Integer getMaxInteract()

setMaxInteract

public Effect setMaxInteract(java.lang.Integer value)

Sets the value of parameter 'maxInteract': eliminates higher-order interaction effects when used in conjunction with the BAR interaction.

Parameters:

value - The value

Returns:

The options object