com.sas.cas.actions.sampling

Class StratifiedOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.sampling.StratifiedOptions

All Implemented Interfaces:

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

public class StratifiedOptions
extends CASGeneratedActionOptions

Options for stratified: Samples a proportion of data or partitions the data into no more than three portions within each stratum.

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_ATTRIBUTES
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_OUTPUT
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_PARTIND
static java.lang.String	KEY_SAMPPCT
static java.lang.String	KEY_SAMPPCT2
static java.lang.String	KEY_SEED
static java.lang.String	KEY_TABLE

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

Method Summary

Modifier and Type	Method and Description
Casinvardesc[]	getAttribute()
Casinvardesc[]	getAttributes()
DisplayTables	getDisplay()
STRATIFIEDOutputStatement	getOutput()
OutputTables	getOutputTables()
java.lang.Boolean	getPartind()
java.lang.Boolean	getPartition()
java.lang.Double	getSamppct()
java.lang.Double	getSamppct2()
java.lang.Long	getSeed()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Castable	getTable()
StratifiedOptions	setAttribute(Casinvardesc[] value)
StratifiedOptions	setAttributes(Casinvardesc[] value) Sets the value of parameter 'attributes': alters attributes on variables used in this action.
StratifiedOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
StratifiedOptions	setOutput(STRATIFIEDOutputStatement value) Sets the value of parameter 'output': creates a table on the server that contains the sample output or partition output.
StratifiedOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
StratifiedOptions	setPartind(java.lang.Boolean value) Sets the value of parameter 'partind': when set to True, generates a partition indicator column in the output data table.
StratifiedOptions	setPartition(java.lang.Boolean value)
StratifiedOptions	setSamppct(java.lang.Double value) Sets the value of parameter 'samppct': specifies the sample percentage to be used in sampling or partitioning within each stratum.
StratifiedOptions	setSamppct2(java.lang.Double value) Sets the value of parameter 'samppct2': specifies a second sample percentage to be used to partition data within each stratum.
StratifiedOptions	setSeed(java.lang.Long value) Sets the value of parameter 'seed': specifies an integer to use to start the pseudorandom number generator.
StratifiedOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the input data table.

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

public static final java.lang.String KEY_SEED

See Also:

Constant Field Values

KEY_SAMPPCT

public static final java.lang.String KEY_SAMPPCT

See Also:

Constant Field Values

KEY_SAMPPCT2

public static final java.lang.String KEY_SAMPPCT2

See Also:

Constant Field Values

KEY_PARTIND

public static final java.lang.String KEY_PARTIND

See Also:

Constant Field Values

KEY_ATTRIBUTES

public static final java.lang.String KEY_ATTRIBUTES

See Also:

Constant Field Values

KEY_OUTPUT

public static final java.lang.String KEY_OUTPUT

See Also:

Constant Field Values

Constructor Detail

StratifiedOptions

public StratifiedOptions()

StratifiedOptions

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

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

Parameters:

value - The value

Returns:

The options object

getDisplay

public DisplayTables getDisplay()

setDisplay

public StratifiedOptions 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 StratifiedOptions 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

getSeed

public java.lang.Long getSeed()

setSeed

public StratifiedOptions setSeed(java.lang.Long value)

Sets the value of parameter 'seed': specifies an integer to use to start the pseudorandom number generator. The server default is 0.

Parameters:

value - The value

Returns:

The options object

getSamppct

public java.lang.Double getSamppct()

setSamppct

public StratifiedOptions setSamppct(java.lang.Double value)

Sets the value of parameter 'samppct': specifies the sample percentage to be used in sampling or partitioning within each stratum.

Parameters:

value - The value

Returns:

The options object

getSamppct2

public java.lang.Double getSamppct2()

setSamppct2

public StratifiedOptions setSamppct2(java.lang.Double value)

Sets the value of parameter 'samppct2': specifies a second sample percentage to be used to partition data within each stratum.

Parameters:

value - The value

Returns:

The options object

getPartind

public java.lang.Boolean getPartind()

getPartition

public java.lang.Boolean getPartition()

setPartind

public StratifiedOptions setPartind(java.lang.Boolean value)

Sets the value of parameter 'partind': when set to True, generates a partition indicator column in the output data table. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setPartition

public StratifiedOptions setPartition(java.lang.Boolean value)

getAttributes

public Casinvardesc[] getAttributes()

getAttribute

public Casinvardesc[] getAttribute()

setAttributes

public StratifiedOptions setAttributes(Casinvardesc[] value)

Sets the value of parameter 'attributes': alters attributes on variables used in this action.

Parameters:

value - The value

Returns:

The options object

setAttribute

public StratifiedOptions setAttribute(Casinvardesc[] value)

getOutput

public STRATIFIEDOutputStatement getOutput()

setOutput

public StratifiedOptions setOutput(STRATIFIEDOutputStatement value)

Sets the value of parameter 'output': creates a table on the server that contains the sample output or partition output.

Parameters:

value - The value

Returns:

The options object