com.sas.cas.actions.percentile

Class PercentileOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.percentile.PercentileOptions

All Implemented Interfaces:

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

public class PercentileOptions
extends CASGeneratedActionOptions

Options for percentile: Calculate quantiles and percentiles.

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_CASOUT
static java.lang.String	KEY_EPSILON
static java.lang.String	KEY_FREQ
static java.lang.String	KEY_GROUPBYLIMIT
static java.lang.String	KEY_INPUTS
static java.lang.String	KEY_MAXITERS
static java.lang.String	KEY_PARTITION
static java.lang.String	KEY_PARTKEY
static java.lang.String	KEY_PCTLDEF
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_VALUES

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

Method Summary

Modifier and Type	Method and Description
Casinvardesc[]	getAttr()
Casinvardesc[]	getAttribute()
Casinvardesc[]	getAttributes()
Casinvardesc[]	getAttrs()
Casouttable	getCasOut()
java.lang.Double	getEpsilon()
java.lang.String	getFreq()
java.lang.String	getFrequency()
java.lang.Long	getGroupByLimit()
Casinvardesc[]	getInput()
Casinvardesc[]	getInputs()
java.lang.Integer	getMaxIter()
java.lang.Integer	getMaxIters()
java.lang.Boolean	getPartition()
java.lang.String[]	getPartKey()
java.lang.Long	getPctlDef()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Castable	getTable()
java.lang.Double[]	getValues()
Casinvardesc[]	getVarAttrs()
PercentileOptions	setAttr(Casinvardesc[] value)
PercentileOptions	setAttribute(Casinvardesc[] value)
PercentileOptions	setAttributes(Casinvardesc[] value) Sets the value of parameter 'attributes': specifies temporary attributes, such as a format, to apply to input variables.
PercentileOptions	setAttrs(Casinvardesc[] value)
PercentileOptions	setCasOut(Casouttable value) Sets the value of parameter 'casOut'.
PercentileOptions	setEpsilon(java.lang.Double value) Sets the value of parameter 'epsilon': specifies the tolerance that is used in determining the convergence of the iterative algorithm for the percentile calculation.
PercentileOptions	setFreq(java.lang.String value) Sets the value of parameter 'freq'.
PercentileOptions	setFrequency(java.lang.String value)
PercentileOptions	setGroupByLimit(java.lang.Long value) Sets the value of parameter 'groupByLimit': specifies the maximum number of levels in a group-by set.
PercentileOptions	setInput(Casinvardesc[] value)
PercentileOptions	setInputs(Casinvardesc[] value) Sets the value of parameter 'inputs': specifies the input variables to use in the analysis.
PercentileOptions	setMaxIter(java.lang.Integer value)
PercentileOptions	setMaxIters(java.lang.Integer value) Sets the value of parameter 'maxIters': specifies the maximum number of iterations of the algorithm.
PercentileOptions	setPartition(java.lang.Boolean value) Sets the value of parameter 'partition': when set to True and the table is partitioned, the results are calculated for each partition efficiently.
PercentileOptions	setPartKey(java.lang.String[] value) Sets the value of parameter 'partKey': when the table is partitioned and you specify the partition parameter, you can specify a partition key so that the results are computed for the single partition with the specified partition key.
PercentileOptions	setPctlDef(java.lang.Long value) Sets the value of parameter 'pctlDef': specify one of five definitions for computing quantile statistics (percentiles) as described in the UNIVARIATE procedure documentation.
PercentileOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the settings for an input table.
PercentileOptions	setValues(java.lang.Double[] value) Sets the value of parameter 'values': specifies the values for which to calculate the percentiles.
PercentileOptions	setVarAttrs(Casinvardesc[] value)

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_CASOUT

public static final java.lang.String KEY_CASOUT

See Also:

Constant Field Values

KEY_FREQ

public static final java.lang.String KEY_FREQ

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_VALUES

public static final java.lang.String KEY_VALUES

See Also:

Constant Field Values

KEY_MAXITERS

public static final java.lang.String KEY_MAXITERS

See Also:

Constant Field Values

KEY_EPSILON

public static final java.lang.String KEY_EPSILON

See Also:

Constant Field Values

KEY_PCTLDEF

public static final java.lang.String KEY_PCTLDEF

See Also:

Constant Field Values

KEY_GROUPBYLIMIT

public static final java.lang.String KEY_GROUPBYLIMIT

See Also:

Constant Field Values

KEY_PARTITION

public static final java.lang.String KEY_PARTITION

See Also:

Constant Field Values

KEY_PARTKEY

public static final java.lang.String KEY_PARTKEY

See Also:

Constant Field Values

Constructor Detail

PercentileOptions

public PercentileOptions()

PercentileOptions

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

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

Parameters:

value - The value

Returns:

The options object

getCasOut

public Casouttable getCasOut()

setCasOut

public PercentileOptions setCasOut(Casouttable value)

Sets the value of parameter 'casOut'.

Parameters:

value - The value

Returns:

The options object

getFreq

public java.lang.String getFreq()

getFrequency

public java.lang.String getFrequency()

setFreq

public PercentileOptions setFreq(java.lang.String value)

Sets the value of parameter 'freq'.

Parameters:

value - The value

Returns:

The options object

setFrequency

public PercentileOptions setFrequency(java.lang.String value)

getAttributes

public Casinvardesc[] getAttributes()

getAttribute

public Casinvardesc[] getAttribute()

getAttrs

public Casinvardesc[] getAttrs()

getAttr

public Casinvardesc[] getAttr()

getVarAttrs

public Casinvardesc[] getVarAttrs()

setAttributes

public PercentileOptions setAttributes(Casinvardesc[] value)

Sets the value of parameter 'attributes': specifies temporary attributes, such as a format, to apply to input variables.

Parameters:

value - The value

Returns:

The options object

setAttribute

public PercentileOptions setAttribute(Casinvardesc[] value)

setAttrs

public PercentileOptions setAttrs(Casinvardesc[] value)

setAttr

public PercentileOptions setAttr(Casinvardesc[] value)

setVarAttrs

public PercentileOptions setVarAttrs(Casinvardesc[] value)

getInputs

public Casinvardesc[] getInputs()

getInput

public Casinvardesc[] getInput()

setInputs

public PercentileOptions setInputs(Casinvardesc[] value)

Sets the value of parameter 'inputs': specifies the input variables to use in the analysis.

Parameters:

value - The value

Returns:

The options object

setInput

public PercentileOptions setInput(Casinvardesc[] value)

getValues

public java.lang.Double[] getValues()

setValues

public PercentileOptions setValues(java.lang.Double[] value)

Sets the value of parameter 'values': specifies the values for which to calculate the percentiles. The default is to calculate the 25th, 50th, and 75th percentile. These are also known as the first, second, and third quartile. The second quartile is the median. Specify values between 0 and 100.

Parameters:

value - The value

Returns:

The options object

getMaxIters

public java.lang.Integer getMaxIters()

getMaxIter

public java.lang.Integer getMaxIter()

setMaxIters

public PercentileOptions setMaxIters(java.lang.Integer value)

Sets the value of parameter 'maxIters': specifies the maximum number of iterations of the algorithm. You can also control the computational demand with the epsilon parameter, which affects the tolerance criterion by which the convergence of the iterative algorithm is judged. Whether the percentile calculation has converged is displayed separately for each of the computed percentiles.

Parameters:

value - The value

Returns:

The options object

setMaxIter

public PercentileOptions setMaxIter(java.lang.Integer value)

getEpsilon

public java.lang.Double getEpsilon()

setEpsilon

public PercentileOptions setEpsilon(java.lang.Double value)

Sets the value of parameter 'epsilon': specifies the tolerance that is used in determining the convergence of the iterative algorithm for the percentile calculation. The server default is 1e-05.

Parameters:

value - The value

Returns:

The options object

getPctlDef

public java.lang.Long getPctlDef()

setPctlDef

public PercentileOptions setPctlDef(java.lang.Long value)

Sets the value of parameter 'pctlDef': specify one of five definitions for computing quantile statistics (percentiles) as described in the UNIVARIATE procedure documentation. The default value, 6, is to use an iterative process. The server default is 6.

Parameters:

value - The value

Returns:

The options object

getGroupByLimit

public java.lang.Long getGroupByLimit()

setGroupByLimit

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

getPartition

public java.lang.Boolean getPartition()

setPartition

public PercentileOptions setPartition(java.lang.Boolean value)

Sets the value of parameter 'partition': when set to True and the table is partitioned, the results are calculated for each partition efficiently. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getPartKey

public java.lang.String[] getPartKey()

setPartKey

public PercentileOptions setPartKey(java.lang.String[] value)

Sets the value of parameter 'partKey': when the table is partitioned and you specify the partition parameter, you can specify a partition key so that the results are computed for the single partition with the specified partition key.

Parameters:

value - The value

Returns:

The options object