com.sas.cas.actions.simple

Class SummaryOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.simple.SummaryOptions

All Implemented Interfaces:

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

public class SummaryOptions
extends CASGeneratedActionOptions

Options for summary: Generates descriptive statistics of numeric variables such as the sample mean, sample variance, sample size, sum of squares, and so on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SummaryOptions.CITYPE
static class	SummaryOptions.ORDERBYAGG
static class	SummaryOptions.SUBSET

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_CASOUT
static java.lang.String	KEY_CIALPHA
static java.lang.String	KEY_CITYPE
static java.lang.String	KEY_FREQ
static java.lang.String	KEY_GROUPBYLIMIT
static java.lang.String	KEY_GROUPBYTABLE
static java.lang.String	KEY_INPUTS
static java.lang.String	KEY_ORDERBY
static java.lang.String	KEY_ORDERBYAGG
static java.lang.String	KEY_ORDERBYDESC
static java.lang.String	KEY_ORDERBYGBYRAW
static java.lang.String	KEY_REPEAT
static java.lang.String	KEY_RESULTLIMIT
static java.lang.String	KEY_SUBSET
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_WEIGHT

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

Method Summary

Modifier and Type	Method and Description
Casinvardesc[]	getAttr()
Casinvardesc[]	getAttribute()
Casinvardesc[]	getAttributes()
Casinvardesc[]	getAttrs()
Casouttable	getCasOut()
java.lang.Double	getCiAlpha()
SummaryOptions.CITYPE	getCiType()
java.lang.String	getFreq()
java.lang.String	getFrequency()
java.lang.Long	getGroupByLimit()
Groupbytable	getGroupbyTable()
Casinvardesc[]	getInput()
Casinvardesc[]	getInputs()
java.lang.Integer	getLimit()
java.lang.String[]	getOrderBy()
SummaryOptions.ORDERBYAGG[]	getOrderByAgg()
java.lang.String[]	getOrderByDesc()
java.lang.Boolean	getOrderByGbyRaw()
java.lang.Boolean	getOrderByRaw()
java.lang.Boolean	getRepeat()
java.lang.Integer	getResultLimit()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
SummaryOptions.SUBSET[]	getStatistics()
SummaryOptions.SUBSET[]	getSubSet()
SummaryOptions.SUBSET[]	getSummarySubset()
Castable	getTable()
Casinvardesc[]	getVarAttrs()
java.lang.String	getWeight()
SummaryOptions	setAttr(Casinvardesc[] value)
SummaryOptions	setAttribute(Casinvardesc[] value)
SummaryOptions	setAttributes(Casinvardesc[] value) Sets the value of parameter 'attributes'.
SummaryOptions	setAttrs(Casinvardesc[] value)
SummaryOptions	setCasOut(Casouttable value) Sets the value of parameter 'casOut': specifies the settings for an output table.
SummaryOptions	setCiAlpha(java.lang.Double value) Sets the value of parameter 'ciAlpha': specifies the level of significance for 100*(1-ciAlpha)% confidence intervals.
SummaryOptions	setCiType(SummaryOptions.CITYPE value) Sets the value of parameter 'ciType': specifies the type of confidence interval.
SummaryOptions	setFreq(java.lang.String value) Sets the value of parameter 'freq': specifies a frequency variable.
SummaryOptions	setFrequency(java.lang.String value)
SummaryOptions	setGroupByLimit(java.lang.Long value) Sets the value of parameter 'groupByLimit': specifies the maximum number of levels in a group-by set.
SummaryOptions	setGroupbyTable(Groupbytable value) Sets the value of parameter 'groupbyTable': specifies an input table that contains the groups to use in a group-by analysis.
SummaryOptions	setInput(Casinvardesc[] value)
SummaryOptions	setInputs(Casinvardesc[] value) Sets the value of parameter 'inputs'.
SummaryOptions	setLimit(java.lang.Integer value)
SummaryOptions	setOrderBy(java.lang.String[] value) Sets the value of parameter 'orderBy': specifies a list of variables by which to order the result set.
SummaryOptions	setOrderByAgg(SummaryOptions.ORDERBYAGG[] value) Sets the value of parameter 'orderByAgg': specifies one or more aggregators by which to order the result set.
SummaryOptions	setOrderByDesc(java.lang.String[] value) Sets the value of parameter 'orderByDesc': arranges the results in descending order.
SummaryOptions	setOrderByGbyRaw(java.lang.Boolean value) Sets the value of parameter 'orderByGbyRaw': when set to True, the ordering of the group-by variables is based on the raw values of the variables, not the formatted values.
SummaryOptions	setOrderByRaw(java.lang.Boolean value)
SummaryOptions	setRepeat(java.lang.Boolean value) Sets the value of parameter 'repeat': when set to True, the action is repeated.
SummaryOptions	setResultLimit(java.lang.Integer value) Sets the value of parameter 'resultLimit': specifies the maximum size of the result set returned to the client.
SummaryOptions	setStatistics(SummaryOptions.SUBSET[] value)
SummaryOptions	setSubSet(SummaryOptions.SUBSET[] value) Sets the value of parameter 'subSet': specifies the summary statistics to generate.
SummaryOptions	setSummarySubset(SummaryOptions.SUBSET[] value)
SummaryOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the table name, caslib, and other common parameters.
SummaryOptions	setVarAttrs(Casinvardesc[] value)
SummaryOptions	setWeight(java.lang.String value) Sets the value of parameter 'weight': specifies a numeric variable whose values weight the values of the analysis 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

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_GROUPBYTABLE

public static final java.lang.String KEY_GROUPBYTABLE

See Also:

Constant Field Values

KEY_ATTRIBUTES

public static final java.lang.String KEY_ATTRIBUTES

See Also:

Constant Field Values

KEY_INPUTS

public static final java.lang.String KEY_INPUTS

See Also:

Constant Field Values

KEY_GROUPBYLIMIT

public static final java.lang.String KEY_GROUPBYLIMIT

See Also:

Constant Field Values

KEY_ORDERBY

public static final java.lang.String KEY_ORDERBY

See Also:

Constant Field Values

KEY_ORDERBYAGG

public static final java.lang.String KEY_ORDERBYAGG

See Also:

Constant Field Values

KEY_ORDERBYDESC

public static final java.lang.String KEY_ORDERBYDESC

See Also:

Constant Field Values

KEY_ORDERBYGBYRAW

public static final java.lang.String KEY_ORDERBYGBYRAW

See Also:

Constant Field Values

KEY_RESULTLIMIT

public static final java.lang.String KEY_RESULTLIMIT

See Also:

Constant Field Values

KEY_CASOUT

public static final java.lang.String KEY_CASOUT

See Also:

Constant Field Values

KEY_REPEAT

public static final java.lang.String KEY_REPEAT

See Also:

Constant Field Values

KEY_FREQ

public static final java.lang.String KEY_FREQ

See Also:

Constant Field Values

KEY_CIALPHA

public static final java.lang.String KEY_CIALPHA

See Also:

Constant Field Values

KEY_CITYPE

public static final java.lang.String KEY_CITYPE

See Also:

Constant Field Values

KEY_SUBSET

public static final java.lang.String KEY_SUBSET

See Also:

Constant Field Values

KEY_WEIGHT

public static final java.lang.String KEY_WEIGHT

See Also:

Constant Field Values

Constructor Detail

SummaryOptions

public SummaryOptions()

SummaryOptions

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

Sets the value of parameter 'table': specifies the table name, caslib, and other common parameters.

Parameters:

value - The value

Returns:

The options object

getGroupbyTable

public Groupbytable getGroupbyTable()

setGroupbyTable

public SummaryOptions setGroupbyTable(Groupbytable value)

Sets the value of parameter 'groupbyTable': specifies an input table that contains the groups to use in a group-by analysis.

Parameters:

value - The value

Returns:

The options object

getAttributes

public Casinvardesc[] getAttributes()

getAttribute

public Casinvardesc[] getAttribute()

getAttrs

public Casinvardesc[] getAttrs()

getAttr

public Casinvardesc[] getAttr()

getVarAttrs

public Casinvardesc[] getVarAttrs()

setAttributes

public SummaryOptions setAttributes(Casinvardesc[] value)

Sets the value of parameter 'attributes'.

Parameters:

value - The value

Returns:

The options object

setAttribute

public SummaryOptions setAttribute(Casinvardesc[] value)

setAttrs

public SummaryOptions setAttrs(Casinvardesc[] value)

setAttr

public SummaryOptions setAttr(Casinvardesc[] value)

setVarAttrs

public SummaryOptions setVarAttrs(Casinvardesc[] value)

getInputs

public Casinvardesc[] getInputs()

getInput

public Casinvardesc[] getInput()

setInputs

public SummaryOptions setInputs(Casinvardesc[] value)

Sets the value of parameter 'inputs'.

Parameters:

value - The value

Returns:

The options object

setInput

public SummaryOptions setInput(Casinvardesc[] value)

getGroupByLimit

public java.lang.Long getGroupByLimit()

setGroupByLimit

public SummaryOptions setGroupByLimit(java.lang.Long value)

Sets the value of parameter 'groupByLimit': specifies the maximum number of levels in a group-by set. When the server determines this number of levels, the server stops and does not return a result. Specify this parameter if you want to avoid creating large result sets in group-by operations. The server default is INT64_MAX.

Parameters:

value - The value

Returns:

The options object

getOrderBy

public java.lang.String[] getOrderBy()

setOrderBy

public SummaryOptions setOrderBy(java.lang.String[] value)

Sets the value of parameter 'orderBy': specifies a list of variables by which to order the result set.

Parameters:

value - The value

Returns:

The options object

getOrderByAgg

public SummaryOptions.ORDERBYAGG[] getOrderByAgg()

setOrderByAgg

public SummaryOptions setOrderByAgg(SummaryOptions.ORDERBYAGG[] value)

Sets the value of parameter 'orderByAgg': specifies one or more aggregators by which to order the result set.

Parameters:

value - The value

Returns:

The options object

getOrderByDesc

public java.lang.String[] getOrderByDesc()

setOrderByDesc

public SummaryOptions setOrderByDesc(java.lang.String[] value)

Sets the value of parameter 'orderByDesc': arranges the results in descending order.

Parameters:

value - The value

Returns:

The options object

getOrderByGbyRaw

public java.lang.Boolean getOrderByGbyRaw()

getOrderByRaw

public java.lang.Boolean getOrderByRaw()

setOrderByGbyRaw

public SummaryOptions setOrderByGbyRaw(java.lang.Boolean value)

Sets the value of parameter 'orderByGbyRaw': when set to True, the ordering of the group-by variables is based on the raw values of the variables, not the formatted values. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

setOrderByRaw

public SummaryOptions setOrderByRaw(java.lang.Boolean value)

getResultLimit

public java.lang.Integer getResultLimit()

getLimit

public java.lang.Integer getLimit()

setResultLimit

public SummaryOptions setResultLimit(java.lang.Integer value)

Sets the value of parameter 'resultLimit': specifies the maximum size of the result set returned to the client.

Parameters:

value - The value

Returns:

The options object

setLimit

public SummaryOptions setLimit(java.lang.Integer value)

getCasOut

public Casouttable getCasOut()

setCasOut

public SummaryOptions setCasOut(Casouttable value)

Sets the value of parameter 'casOut': specifies the settings for an output table.

Parameters:

value - The value

Returns:

The options object

getRepeat

public java.lang.Boolean getRepeat()

setRepeat

public SummaryOptions setRepeat(java.lang.Boolean value)

Sets the value of parameter 'repeat': when set to True, the action is repeated. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getFreq

public java.lang.String getFreq()

getFrequency

public java.lang.String getFrequency()

setFreq

public SummaryOptions setFreq(java.lang.String value)

Sets the value of parameter 'freq': specifies a frequency variable.

Parameters:

value - The value

Returns:

The options object

setFrequency

public SummaryOptions setFrequency(java.lang.String value)

getCiAlpha

public java.lang.Double getCiAlpha()

setCiAlpha

public SummaryOptions setCiAlpha(java.lang.Double value)

Sets the value of parameter 'ciAlpha': specifies the level of significance for 100*(1-ciAlpha)% confidence intervals. The default value of 0.05 results in 95% confidence intervals. The server default is 0.05.

Parameters:

value - The value

Returns:

The options object

getCiType

public SummaryOptions.CITYPE getCiType()

setCiType

public SummaryOptions setCiType(SummaryOptions.CITYPE value)

Sets the value of parameter 'ciType': specifies the type of confidence interval. The server default is CITYPE.TWOSIDED.

Parameters:

value - The value

Returns:

The options object

getSubSet

public SummaryOptions.SUBSET[] getSubSet()

getSummarySubset

public SummaryOptions.SUBSET[] getSummarySubset()

getStatistics

public SummaryOptions.SUBSET[] getStatistics()

setSubSet

public SummaryOptions setSubSet(SummaryOptions.SUBSET[] value)

Sets the value of parameter 'subSet': specifies the summary statistics to generate.

Parameters:

value - The value

Returns:

The options object

setSummarySubset

public SummaryOptions setSummarySubset(SummaryOptions.SUBSET[] value)

setStatistics

public SummaryOptions setStatistics(SummaryOptions.SUBSET[] value)

getWeight

public java.lang.String getWeight()

setWeight

public SummaryOptions setWeight(java.lang.String value)

Sets the value of parameter 'weight': specifies a numeric variable whose values weight the values of the analysis variables.

Parameters:

value - The value

Returns:

The options object