com.sas.cas.actions.dmclust

Class ClusterOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.dmclust.ClusterOptions

All Implemented Interfaces:

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

public class ClusterOptions
extends CASGeneratedActionOptions

Options for cluster: Data Management Clustering.

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_CLUSTID
static java.lang.String	KEY_CLUSTNULLS
static java.lang.String	KEY_COLUMNS
static java.lang.String	KEY_CONDITIONSEP
static java.lang.String	KEY_DONOTCLUST
static java.lang.String	KEY_EMPTYSTRISNULL
static java.lang.String	KEY_INTABLE
static java.lang.String	KEY_MATCHCONDITIONS
static java.lang.String	KEY_MEMGROW
static java.lang.String	KEY_MEMSIZE
static java.lang.String	KEY_OUTTABLE

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClustId()
java.lang.Boolean	getClustNulls()
java.lang.String[]	getColumns()
java.lang.String	getConditionSep()
java.lang.String	getDoNotClust()
java.lang.Boolean	getEmptyStrIsNull()
Castable	getInTable()
java.lang.String[]	getMatchConditions()
java.lang.Boolean	getMemGrow()
java.lang.Integer	getMemSize()
Casouttable	getOutTable()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
ClusterOptions	setClustId(java.lang.String value) Sets the value of parameter 'clustId': specifies the name of the column in the output data table containing the cluster IDs.
ClusterOptions	setClustNulls(java.lang.Boolean value) Sets the value of parameter 'clustNulls': specifies whether NULL values should be grouped together.
ClusterOptions	setColumns(java.lang.String[] value) Sets the value of parameter 'columns': specifies names of columns in the input data table to be passed through to the output data table.
ClusterOptions	setConditionSep(java.lang.String value) Sets the value of parameter 'conditionSep': specifies the string used as a separator between columns' names within a clustering condition.
ClusterOptions	setDoNotClust(java.lang.String value) Sets the value of parameter 'doNotClust': specifies the name of the column in the input data table containing the Do Not Cluster Boolean flag.
ClusterOptions	setEmptyStrIsNull(java.lang.Boolean value) Sets the value of parameter 'emptyStrIsNull': specifies whether Empty String values should be treated as NULL values.
ClusterOptions	setInTable(Castable value) Sets the value of parameter 'inTable': specifies the input data table.
ClusterOptions	setMatchConditions(java.lang.String[] value) Sets the value of parameter 'matchConditions': specifies names of columns to be used for matching rows and grouping them into clusters (clustering conditions).
ClusterOptions	setMemGrow(java.lang.Boolean value) Sets the value of parameter 'memGrow': specifies whether to allow memory usage to grow during clustering.
ClusterOptions	setMemSize(java.lang.Integer value) Sets the value of parameter 'memSize': specifies the number of Megabytes of memory to use for clustering.
ClusterOptions	setOutTable(Casouttable value) Sets the value of parameter 'outTable': specifies the output data table where the pass-through columns and the cluster IDs are to be written.

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_CLUSTID

public static final java.lang.String KEY_CLUSTID

See Also:

Constant Field Values

KEY_DONOTCLUST

public static final java.lang.String KEY_DONOTCLUST

See Also:

Constant Field Values

KEY_MEMSIZE

public static final java.lang.String KEY_MEMSIZE

See Also:

Constant Field Values

KEY_MEMGROW

public static final java.lang.String KEY_MEMGROW

See Also:

Constant Field Values

KEY_EMPTYSTRISNULL

public static final java.lang.String KEY_EMPTYSTRISNULL

See Also:

Constant Field Values

KEY_CLUSTNULLS

public static final java.lang.String KEY_CLUSTNULLS

See Also:

Constant Field Values

KEY_MATCHCONDITIONS

public static final java.lang.String KEY_MATCHCONDITIONS

See Also:

Constant Field Values

KEY_CONDITIONSEP

public static final java.lang.String KEY_CONDITIONSEP

See Also:

Constant Field Values

KEY_INTABLE

public static final java.lang.String KEY_INTABLE

See Also:

Constant Field Values

KEY_COLUMNS

public static final java.lang.String KEY_COLUMNS

See Also:

Constant Field Values

KEY_OUTTABLE

public static final java.lang.String KEY_OUTTABLE

See Also:

Constant Field Values

Constructor Detail

ClusterOptions

public ClusterOptions()

ClusterOptions

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

getClustId

public java.lang.String getClustId()

setClustId

public ClusterOptions setClustId(java.lang.String value)

Sets the value of parameter 'clustId': specifies the name of the column in the output data table containing the cluster IDs.

Parameters:

value - The value

Returns:

The options object

getDoNotClust

public java.lang.String getDoNotClust()

setDoNotClust

public ClusterOptions setDoNotClust(java.lang.String value)

Sets the value of parameter 'doNotClust': specifies the name of the column in the input data table containing the Do Not Cluster Boolean flag.

Parameters:

value - The value

Returns:

The options object

getMemSize

public java.lang.Integer getMemSize()

setMemSize

public ClusterOptions setMemSize(java.lang.Integer value)

Sets the value of parameter 'memSize': specifies the number of Megabytes of memory to use for clustering. The server default is 256.

Parameters:

value - The value

Returns:

The options object

getMemGrow

public java.lang.Boolean getMemGrow()

setMemGrow

public ClusterOptions setMemGrow(java.lang.Boolean value)

Sets the value of parameter 'memGrow': specifies whether to allow memory usage to grow during clustering. If set to FALSE and the input data being clustered cannot be stored in the configured memory chunk the clustering action will error out at run time. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getEmptyStrIsNull

public java.lang.Boolean getEmptyStrIsNull()

setEmptyStrIsNull

public ClusterOptions setEmptyStrIsNull(java.lang.Boolean value)

Sets the value of parameter 'emptyStrIsNull': specifies whether Empty String values should be treated as NULL values. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getClustNulls

public java.lang.Boolean getClustNulls()

setClustNulls

public ClusterOptions setClustNulls(java.lang.Boolean value)

Sets the value of parameter 'clustNulls': specifies whether NULL values should be grouped together. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getMatchConditions

public java.lang.String[] getMatchConditions()

setMatchConditions

public ClusterOptions setMatchConditions(java.lang.String[] value)

Sets the value of parameter 'matchConditions': specifies names of columns to be used for matching rows and grouping them into clusters (clustering conditions).

Parameters:

value - The value

Returns:

The options object

getConditionSep

public java.lang.String getConditionSep()

setConditionSep

public ClusterOptions setConditionSep(java.lang.String value)

Sets the value of parameter 'conditionSep': specifies the string used as a separator between columns' names within a clustering condition. The server default is "+".

Parameters:

value - The value

Returns:

The options object

getInTable

public Castable getInTable()

setInTable

public ClusterOptions setInTable(Castable value)

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

Parameters:

value - The value

Returns:

The options object

getColumns

public java.lang.String[] getColumns()

setColumns

public ClusterOptions setColumns(java.lang.String[] value)

Sets the value of parameter 'columns': specifies names of columns in the input data table to be passed through to the output data table.

Parameters:

value - The value

Returns:

The options object

getOutTable

public Casouttable getOutTable()

setOutTable

public ClusterOptions setOutTable(Casouttable value)

Sets the value of parameter 'outTable': specifies the output data table where the pass-through columns and the cluster IDs are to be written.

Parameters:

value - The value

Returns:

The options object