AggregateOptions (cas-client 3.2.9 API)

java.lang.Object
- com.sas.cas.CASActionOptions
- - com.sas.cas.CASGeneratedActionOptions
  - - com.sas.cas.actions.aggregation.AggregateOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>
```
public class AggregateOptions
extends CASGeneratedActionOptions
```
Options for aggregate: Performs aggregation on selected variables.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AggregateOptions.ALIGN
- 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>

Nested Classes
Modifier and Type	Class and Description
`static class`	`AggregateOptions.ALIGN`

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_ALIGN`
`static java.lang.String`	`KEY_BIN`
`static java.lang.String`	`KEY_CASOUT`
`static java.lang.String`	`KEY_CONTRIBUTE`
`static java.lang.String`	`KEY_CONTRIBUTECOLUMNLABEL`
`static java.lang.String`	`KEY_CONTRIBUTECOLUMNNAME`
`static java.lang.String`	`KEY_CONTRIBUTEDELIMITER`
`static java.lang.String`	`KEY_CONTRIBUTETRIM`
`static java.lang.String`	`KEY_CONTRIBUTEUNROLL`
`static java.lang.String`	`KEY_COPYVARS`
`static java.lang.String`	`KEY_DOESP`
`static java.lang.String`	`KEY_EDGEID`
`static java.lang.String`	`KEY_EXCLNPWGT`
`static java.lang.String`	`KEY_EXCLUDESELF`
`static java.lang.String`	`KEY_FREQ`
`static java.lang.String`	`KEY_FREQSTRICT`
`static java.lang.String`	`KEY_GROUPBYLIMIT`
`static java.lang.String`	`KEY_GROUPEDINTERVALOUTPUT`
`static java.lang.String`	`KEY_ID`
`static java.lang.String`	`KEY_IDEND`
`static java.lang.String`	`KEY_IDRANGE`
`static java.lang.String`	`KEY_IDSTART`
`static java.lang.String`	`KEY_INCLUDEEMPTYINTERVAL`
`static java.lang.String`	`KEY_INCLUDEMISSING`
`static java.lang.String`	`KEY_INPUTS`
`static java.lang.String`	`KEY_INTERVAL`
`static java.lang.String`	`KEY_JUMPINGWINDOW`
`static java.lang.String`	`KEY_KEEPRECORD`
`static java.lang.String`	`KEY_KEEPRECORDID`
`static java.lang.String`	`KEY_MODESINGLE`
`static java.lang.String`	`KEY_OFFSET`
`static java.lang.String`	`KEY_PARTKEY`
`static java.lang.String`	`KEY_PCTLDEF`
`static java.lang.String`	`KEY_PTI`
`static java.lang.String`	`KEY_PTW`
`static java.lang.String`	`KEY_RAW`
`static java.lang.String`	`KEY_SAVEGROUPBYFORMAT`
`static java.lang.String`	`KEY_SAVEGROUPBYRAW`
`static java.lang.String`	`KEY_SAVEVARIABLECOLUMN`
`static java.lang.String`	`KEY_SAVEVARIABLESPECIFICATION`
`static java.lang.String`	`KEY_SUBBINOFFSET`
`static java.lang.String`	`KEY_SUBBINWIDTH`
`static java.lang.String`	`KEY_SUBINTERVAL`
`static java.lang.String`	`KEY_TABLE`
`static java.lang.String`	`KEY_VARSPECS`
`static java.lang.String`	`KEY_WEIGHT`
`static java.lang.String`	`KEY_WINDOWBIN`
`static java.lang.String`	`KEY_WINDOWINT`
`static java.lang.String`	`KEY_WINDOWOFFSET`
`static java.lang.String`	`KEY_WINDOWSUBBINOFFSET`
`static java.lang.String`	`KEY_WINDOWSUBBINWIDTH`
`static java.lang.String`	`KEY_WINDOWSUBINT`

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

AggregateOptions()

AggregateOptions(CASActionOptions options)

Constructors
Constructor and Description
`AggregateOptions()`
`AggregateOptions(CASActionOptions options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AggregateOptions.ALIGN`	`getAlign()`
`java.lang.Double[]`	`getBin()`
`Casouttable`	`getCasOut()`
`java.lang.String`	`getContribute()`
`java.lang.String`	`getContributeColumnLabel()`
`java.lang.String`	`getContributeColumnName()`
`java.lang.String`	`getContributeDelimiter()`
`java.lang.Boolean`	`getContributeTrim()`
`java.lang.Boolean`	`getContributeUnroll()`
`java.lang.String[]`	`getCopyVar()`
`java.lang.String[]`	`getCopyVars()`
`java.lang.String`	`getDelimiter()`
`java.lang.Integer`	`getDif()`
`java.lang.Boolean`	`getDoESP()`
`java.lang.String`	`getEdgeId()`
`java.lang.Boolean`	`getExclnpwgt()`
`java.lang.Boolean`	`getExcludeNonPositiveWeight()`
`java.lang.Boolean`	`getExcludeSelf()`
`java.lang.String`	`getFreq()`
`java.lang.Boolean`	`getFreqStrict()`
`java.lang.String`	`getFrequency()`
`java.lang.Long`	`getGroupByLimit()`
`java.lang.Boolean`	`getGroupedIntervalOutput()`
`java.lang.String`	`getId()`
`java.lang.Double`	`getIdEnd()`
`java.lang.Double[]`	`getIdRange()`
`java.lang.Double`	`getIdStart()`
`java.lang.Boolean`	`getIncludeEmptyInterval()`
`java.lang.Boolean`	`getIncludeMiss()`
`java.lang.Boolean`	`getIncludeMissing()`
`java.lang.Boolean`	`getIncludeMissingInterval()`
`java.lang.Boolean`	`getIncludeMissInterval()`
`java.lang.Boolean`	`getIncMiss()`
`java.lang.Boolean`	`getIncMissing()`
`Casinvardesc[]`	`getInput()`
`Casinvardesc[]`	`getInputs()`
`java.lang.Integer`	`getIntDif()`
`java.lang.String`	`getInterval()`
`java.lang.Integer`	`getIntOff()`
`java.lang.Integer`	`getIntOffset()`
`java.lang.Boolean`	`getJumpingWindow()`
`java.lang.Boolean`	`getKeepRecord()`
`java.lang.Boolean`	`getKeepRecordId()`
`java.lang.Boolean`	`getModeSingle()`
`java.lang.Integer`	`getOffset()`
`java.lang.Boolean`	`getPartAndOrder()`
`java.lang.Double`	`getPartialToDate()`
`java.lang.Double`	`getPartialToInterval()`
`java.lang.Double`	`getPartialToWindow()`
`java.lang.String[]`	`getPartKey()`
`java.lang.Integer`	`getPctlDef()`
`java.lang.Double`	`getPtd()`
`java.lang.Double`	`getPti()`
`java.lang.Double`	`getPtw()`
`java.lang.Boolean`	`getRaw()`
`java.lang.Boolean`	`getSaveGbyFmt()`
`java.lang.Boolean`	`getSaveGbyRaw()`
`java.lang.Boolean`	`getSaveGroupbyFormat()`
`java.lang.Boolean`	`getSaveGroupbyRaw()`
`java.lang.Boolean`	`getSaveVarCol()`
`java.lang.Boolean`	`getSaveVariableColumn()`
`java.lang.Boolean`	`getSaveVariableSpecification()`
`java.lang.Boolean`	`getSaveVarSpec()`
`java.lang.Object`	`getServerDefaultValue(java.lang.String key)` Gets the server default value, if known.
`java.lang.Double`	`getSubBinOffset()`
`java.lang.Double`	`getSubBinWidth()`
`java.lang.String`	`getSubInt()`
`java.lang.String`	`getSubInterval()`
`Castable`	`getTable()`
`java.lang.Boolean`	`getUnroll()`
`Tkcasagg_varspecs[]`	`getVarSpecs()`
`java.lang.String`	`getWeight()`
`java.lang.Integer`	`getWinDif()`
`java.lang.Double[]`	`getWindowBin()`
`java.lang.String`	`getWindowInt()`
`java.lang.String`	`getWindowInterval()`
`java.lang.Integer`	`getWindowIntervalOffset()`
`java.lang.Integer`	`getWindowIntOffset()`
`java.lang.Integer`	`getWindowOffset()`
`java.lang.Double`	`getWindowSubBinOffset()`
`java.lang.Double`	`getWindowSubBinWidth()`
`java.lang.String`	`getWindowSubInt()`
`java.lang.String`	`getWindowSubInterval()`
`java.lang.String`	`getWinInt()`
`java.lang.Integer`	`getWinIntDif()`
`java.lang.Integer`	`getWinIntOff()`
`java.lang.Double`	`getWinSubBinOffset()`
`java.lang.Double`	`getWinSubBinWidth()`
`java.lang.String`	`getWinSubInt()`
`java.lang.String`	`getWinSubInterval()`
`AggregateOptions`	`setAlign(AggregateOptions.ALIGN value)` Sets the value of parameter 'align': specifies the alignment of the representative value with respect to an interval or bin.
`AggregateOptions`	`setBin(java.lang.Double[] value)` Sets the value of parameter 'bin': specifies the minimum and maximum values of a bin.
`AggregateOptions`	`setCasOut(Casouttable value)` Sets the value of parameter 'casOut': specifies the settings for an output table.
`AggregateOptions`	`setContribute(java.lang.String value)` Sets the value of parameter 'contribute': when the doESP parameter is True, you can specify a variable whose values within each aggregation interval are recorded.
`AggregateOptions`	`setContributeColumnLabel(java.lang.String value)` Sets the value of parameter 'contributeColumnLabel': specifies a value to override the variable label from the contribute variable.
`AggregateOptions`	`setContributeColumnName(java.lang.String value)` Sets the value of parameter 'contributeColumnName': specifies a value to override the variable name from the contribute variable.
`AggregateOptions`	`setContributeDelimiter(java.lang.String value)` Sets the value of parameter 'contributeDelimiter': specifies a delimiter that is used between concatenated values of the contribute variable.
`AggregateOptions`	`setContributeTrim(java.lang.Boolean value)` Sets the value of parameter 'contributeTrim': when set to True, leading and trailing blanks are removed from the formatted value of the contribute variable.
`AggregateOptions`	`setContributeUnroll(java.lang.Boolean value)` Sets the value of parameter 'contributeUnroll': by default, the formatted values from the contribute variable are concatenated together into a single row for the result table.
`AggregateOptions`	`setCopyVar(java.lang.String[] value)`
`AggregateOptions`	`setCopyVars(java.lang.String[] value)` Sets the value of parameter 'copyVars': specifies the variables to copy from the input table to the output table.
`AggregateOptions`	`setDelimiter(java.lang.String value)`
`AggregateOptions`	`setDif(java.lang.Integer value)`
`AggregateOptions`	`setDoESP(java.lang.Boolean value)` Sets the value of parameter 'doESP': when set to True, the action can take advantage of partitioning and ordering on the input table.
`AggregateOptions`	`setEdgeId(java.lang.String value)` Sets the value of parameter 'edgeId': specifies a numeric variable whose values are used to order the values of each varSpecs specification that uses the FIRST, LAST, FNE, or LNE aggregator.
`AggregateOptions`	`setExclnpwgt(java.lang.Boolean value)` Sets the value of parameter 'exclnpwgt': when set to True and a weight variable is specified, then observations with a non-positive weight value are excluded from the analysis.
`AggregateOptions`	`setExcludeNonPositiveWeight(java.lang.Boolean value)`
`AggregateOptions`	`setExcludeSelf(java.lang.Boolean value)` Sets the value of parameter 'excludeSelf': when set to True and the doESP parameter is True, the aggregation excludes the current observation's contribution.
`AggregateOptions`	`setFreq(java.lang.String value)` Sets the value of parameter 'freq': specifies a numeric variable whose values are used as the frequency of analysis variable values.
`AggregateOptions`	`setFreqStrict(java.lang.Boolean value)` Sets the value of parameter 'freqStrict': this parameter is related to using the MODE aggregator.
`AggregateOptions`	`setFrequency(java.lang.String value)`
`AggregateOptions`	`setGroupByLimit(java.lang.Long value)` Sets the value of parameter 'groupByLimit': specifies the maximum number of levels in a group-by set.
`AggregateOptions`	`setGroupedIntervalOutput(java.lang.Boolean value)` Sets the value of parameter 'groupedIntervalOutput': when set to True, save only one of the same aggregated intervals with respect to the last Id value.
`AggregateOptions`	`setId(java.lang.String value)` Sets the value of parameter 'id': specifies a numeric variable that identifies the timestamp that is associated with each observation in the input table.
`AggregateOptions`	`setIdEnd(java.lang.Double value)` Sets the value of parameter 'idEnd': specifies the inclusive maximum value of the ID variable to be considered in the analysis.
`AggregateOptions`	`setIdRange(java.lang.Double[] value)` Sets the value of parameter 'idRange': specifies the inclusive minimum and maximum values of the ID variable to be considered in the analysis.
`AggregateOptions`	`setIdStart(java.lang.Double value)` Sets the value of parameter 'idStart': specifies the inclusive minimum value of the ID variable to be considered in the analysis.
`AggregateOptions`	`setIncludeEmptyInterval(java.lang.Boolean value)` Sets the value of parameter 'includeEmptyInterval': by default, intervals with a missing value for the ID variable are included in the output.
`AggregateOptions`	`setIncludeMiss(java.lang.Boolean value)`
`AggregateOptions`	`setIncludeMissing(java.lang.Boolean value)` Sets the value of parameter 'includeMissing': by default, missing values are included in the analysis.
`AggregateOptions`	`setIncludeMissingInterval(java.lang.Boolean value)`
`AggregateOptions`	`setIncludeMissInterval(java.lang.Boolean value)`
`AggregateOptions`	`setIncMiss(java.lang.Boolean value)`
`AggregateOptions`	`setIncMissing(java.lang.Boolean value)`
`AggregateOptions`	`setInput(Casinvardesc[] value)`
`AggregateOptions`	`setInputs(Casinvardesc[] value)` Sets the value of parameter 'inputs': specifies the input variables to use in the analysis.
`AggregateOptions`	`setIntDif(java.lang.Integer value)`
`AggregateOptions`	`setInterval(java.lang.String value)` Sets the value of parameter 'interval': specifies the time period for the accumulation of observations.
`AggregateOptions`	`setIntOff(java.lang.Integer value)`
`AggregateOptions`	`setIntOffset(java.lang.Integer value)`
`AggregateOptions`	`setJumpingWindow(java.lang.Boolean value)` Sets the value of parameter 'jumpingWindow': when set to True, specifies that aggregation occurs over a time window that can contain multiple intervals and aggregation is reset when the specified time range elapses.
`AggregateOptions`	`setKeepRecord(java.lang.Boolean value)` Sets the value of parameter 'keepRecord': when set to True, each observation's original value for the ID variable is kept without performing interval alignment.
`AggregateOptions`	`setKeepRecordId(java.lang.Boolean value)` Sets the value of parameter 'keepRecordId': when set to True and the doESP parameter is True, each observation's original ID value is kept without performing interval alignment.
`AggregateOptions`	`setModeSingle(java.lang.Boolean value)` Sets the value of parameter 'modeSingle': this parameter is related to using the MODE aggregator.
`AggregateOptions`	`setOffset(java.lang.Integer value)` Sets the value of parameter 'offset': specifies the offset of each interval.
`AggregateOptions`	`setPartAndOrder(java.lang.Boolean value)`
`AggregateOptions`	`setPartialToDate(java.lang.Double value)`
`AggregateOptions`	`setPartialToInterval(java.lang.Double value)`
`AggregateOptions`	`setPartialToWindow(java.lang.Double value)`
`AggregateOptions`	`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 partition only.
`AggregateOptions`	`setPctlDef(java.lang.Integer value)` Sets the value of parameter 'pctlDef': specifies how to compute quantile statistics (percentiles) as described in the UNIVARIATE procedure documentation.
`AggregateOptions`	`setPtd(java.lang.Double value)`
`AggregateOptions`	`setPti(java.lang.Double value)` Sets the value of parameter 'pti': specifies the time value when the aggregation within an interval or a bin is terminated.
`AggregateOptions`	`setPtw(java.lang.Double value)` Sets the value of parameter 'ptw': specifies the subinterval with respect to each window interval.
`AggregateOptions`	`setRaw(java.lang.Boolean value)` Sets the value of parameter 'raw': when set to True, raw values of the variables in the input parameter are used.
`AggregateOptions`	`setSaveGbyFmt(java.lang.Boolean value)`
`AggregateOptions`	`setSaveGbyRaw(java.lang.Boolean value)`
`AggregateOptions`	`setSaveGroupbyFormat(java.lang.Boolean value)` Sets the value of parameter 'saveGroupbyFormat': by default, the formatted values of the groupBy variables from the input table are copied to the results.
`AggregateOptions`	`setSaveGroupbyRaw(java.lang.Boolean value)` Sets the value of parameter 'saveGroupbyRaw': by default, the raw values of the groupBy variables from the input table are copied to the results.
`AggregateOptions`	`setSaveVarCol(java.lang.Boolean value)`
`AggregateOptions`	`setSaveVariableColumn(java.lang.Boolean value)` Sets the value of parameter 'saveVariableColumn': by default, the variable name for each analysis variable is included in the results.
`AggregateOptions`	`setSaveVariableSpecification(java.lang.Boolean value)` Sets the value of parameter 'saveVariableSpecification': by default, the results include a column that is named 'Variable Specification' to identify the varSpecs specification that produced the result.
`AggregateOptions`	`setSaveVarSpec(java.lang.Boolean value)`
`AggregateOptions`	`setSubBinOffset(java.lang.Double value)` Sets the value of parameter 'subBinOffset': specifies an offset from the beginning of a bin.
`AggregateOptions`	`setSubBinWidth(java.lang.Double value)` Sets the value of parameter 'subBinWidth': specifies the width of the sub bin within a bin.
`AggregateOptions`	`setSubInt(java.lang.String value)`
`AggregateOptions`	`setSubInterval(java.lang.String value)` Sets the value of parameter 'subInterval': specifies a smaller interval to control the time period alignment within each interval for the aggregation of observations.
`AggregateOptions`	`setTable(Castable value)` Sets the value of parameter 'table': specifies the table name, caslib, and other common parameters.
`AggregateOptions`	`setUnroll(java.lang.Boolean value)`
`AggregateOptions`	`setVarSpecs(Tkcasagg_varspecs[] value)` Sets the value of parameter 'varSpecs': specifies the variable to aggregate and the settings for the aggregator.
`AggregateOptions`	`setWeight(java.lang.String value)` Sets the value of parameter 'weight': specifies a numeric variable whose values are used as the weight of numeric analysis variable values when the aggregator is SUMMARY.
`AggregateOptions`	`setWinDif(java.lang.Integer value)`
`AggregateOptions`	`setWindowBin(java.lang.Double[] value)` Sets the value of parameter 'windowBin': specifies the minimum and maximum values of a window bin.
`AggregateOptions`	`setWindowInt(java.lang.String value)` Sets the value of parameter 'windowInt': specifies the time window for the accumulation of observations with respect to each time interval.
`AggregateOptions`	`setWindowInterval(java.lang.String value)`
`AggregateOptions`	`setWindowIntervalOffset(java.lang.Integer value)`
`AggregateOptions`	`setWindowIntOffset(java.lang.Integer value)`
`AggregateOptions`	`setWindowOffset(java.lang.Integer value)` Sets the value of parameter 'windowOffset': specifies the offset of each window interval.
`AggregateOptions`	`setWindowSubBinOffset(java.lang.Double value)` Sets the value of parameter 'windowSubBinOffset': specifies the starting point within a window bin in which record values are aggregated.
`AggregateOptions`	`setWindowSubBinWidth(java.lang.Double value)` Sets the value of parameter 'windowSubBinWidth': specifies the width of the sub bin within each windowBin.
`AggregateOptions`	`setWindowSubInt(java.lang.String value)` Sets the value of parameter 'windowSubInt': this parameter is similar to subInterval.
`AggregateOptions`	`setWindowSubInterval(java.lang.String value)`
`AggregateOptions`	`setWinInt(java.lang.String value)`
`AggregateOptions`	`setWinIntDif(java.lang.Integer value)`
`AggregateOptions`	`setWinIntOff(java.lang.Integer value)`
`AggregateOptions`	`setWinSubBinOffset(java.lang.Double value)`
`AggregateOptions`	`setWinSubBinWidth(java.lang.Double value)`
`AggregateOptions`	`setWinSubInt(java.lang.String value)`
`AggregateOptions`	`setWinSubInterval(java.lang.String 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_CASOUT
```
public static final java.lang.String KEY_CASOUT
```
    See Also:
    
    Constant Field Values
  - KEY_GROUPBYLIMIT
```
public static final java.lang.String KEY_GROUPBYLIMIT
```
    See Also:
    
    Constant Field Values
  - KEY_TABLE
```
public static final java.lang.String KEY_TABLE
```
    See Also:
    
    Constant Field Values
  - KEY_PARTKEY
```
public static final java.lang.String KEY_PARTKEY
```
    See Also:
    
    Constant Field Values
  - KEY_VARSPECS
```
public static final java.lang.String KEY_VARSPECS
```
    See Also:
    
    Constant Field Values
  - KEY_ID
```
public static final java.lang.String KEY_ID
```
    See Also:
    
    Constant Field Values
  - KEY_ALIGN
```
public static final java.lang.String KEY_ALIGN
```
    See Also:
    
    Constant Field Values
  - KEY_IDSTART
```
public static final java.lang.String KEY_IDSTART
```
    See Also:
    
    Constant Field Values
  - KEY_IDEND
```
public static final java.lang.String KEY_IDEND
```
    See Also:
    
    Constant Field Values
  - KEY_IDRANGE
```
public static final java.lang.String KEY_IDRANGE
```
    See Also:
    
    Constant Field Values
  - KEY_INTERVAL
```
public static final java.lang.String KEY_INTERVAL
```
    See Also:
    
    Constant Field Values
  - KEY_SUBINTERVAL
```
public static final java.lang.String KEY_SUBINTERVAL
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOWINT
```
public static final java.lang.String KEY_WINDOWINT
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOWSUBINT
```
public static final java.lang.String KEY_WINDOWSUBINT
```
    See Also:
    
    Constant Field Values
  - KEY_BIN
```
public static final java.lang.String KEY_BIN
```
    See Also:
    
    Constant Field Values
  - KEY_SUBBINOFFSET
```
public static final java.lang.String KEY_SUBBINOFFSET
```
    See Also:
    
    Constant Field Values
  - KEY_SUBBINWIDTH
```
public static final java.lang.String KEY_SUBBINWIDTH
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOWBIN
```
public static final java.lang.String KEY_WINDOWBIN
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOWSUBBINOFFSET
```
public static final java.lang.String KEY_WINDOWSUBBINOFFSET
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOWSUBBINWIDTH
```
public static final java.lang.String KEY_WINDOWSUBBINWIDTH
```
    See Also:
    
    Constant Field Values
  - KEY_OFFSET
```
public static final java.lang.String KEY_OFFSET
```
    See Also:
    
    Constant Field Values
  - KEY_WINDOWOFFSET
```
public static final java.lang.String KEY_WINDOWOFFSET
```
    See Also:
    
    Constant Field Values
  - KEY_PTI
```
public static final java.lang.String KEY_PTI
```
    See Also:
    
    Constant Field Values
  - KEY_PTW
```
public static final java.lang.String KEY_PTW
```
    See Also:
    
    Constant Field Values
  - KEY_EDGEID
```
public static final java.lang.String KEY_EDGEID
```
    See Also:
    
    Constant Field Values
  - KEY_COPYVARS
```
public static final java.lang.String KEY_COPYVARS
```
    See Also:
    
    Constant Field Values
  - KEY_INCLUDEEMPTYINTERVAL
```
public static final java.lang.String KEY_INCLUDEEMPTYINTERVAL
```
    See Also:
    
    Constant Field Values
  - KEY_INCLUDEMISSING
```
public static final java.lang.String KEY_INCLUDEMISSING
```
    See Also:
    
    Constant Field Values
  - KEY_JUMPINGWINDOW
```
public static final java.lang.String KEY_JUMPINGWINDOW
```
    See Also:
    
    Constant Field Values
  - KEY_MODESINGLE
```
public static final java.lang.String KEY_MODESINGLE
```
    See Also:
    
    Constant Field Values
  - KEY_KEEPRECORD
```
public static final java.lang.String KEY_KEEPRECORD
```
    See Also:
    
    Constant Field Values
  - KEY_WEIGHT
```
public static final java.lang.String KEY_WEIGHT
```
    See Also:
    
    Constant Field Values
  - KEY_EXCLNPWGT
```
public static final java.lang.String KEY_EXCLNPWGT
```
    See Also:
    
    Constant Field Values
  - KEY_FREQ
```
public static final java.lang.String KEY_FREQ
```
    See Also:
    
    Constant Field Values
  - KEY_FREQSTRICT
```
public static final java.lang.String KEY_FREQSTRICT
```
    See Also:
    
    Constant Field Values
  - KEY_PCTLDEF
```
public static final java.lang.String KEY_PCTLDEF
```
    See Also:
    
    Constant Field Values
  - KEY_DOESP
```
public static final java.lang.String KEY_DOESP
```
    See Also:
    
    Constant Field Values
  - KEY_KEEPRECORDID
```
public static final java.lang.String KEY_KEEPRECORDID
```
    See Also:
    
    Constant Field Values
  - KEY_EXCLUDESELF
```
public static final java.lang.String KEY_EXCLUDESELF
```
    See Also:
    
    Constant Field Values
  - KEY_CONTRIBUTE
```
public static final java.lang.String KEY_CONTRIBUTE
```
    See Also:
    
    Constant Field Values
  - KEY_CONTRIBUTECOLUMNLABEL
```
public static final java.lang.String KEY_CONTRIBUTECOLUMNLABEL
```
    See Also:
    
    Constant Field Values
  - KEY_CONTRIBUTECOLUMNNAME
```
public static final java.lang.String KEY_CONTRIBUTECOLUMNNAME
```
    See Also:
    
    Constant Field Values
  - KEY_CONTRIBUTETRIM
```
public static final java.lang.String KEY_CONTRIBUTETRIM
```
    See Also:
    
    Constant Field Values
  - KEY_CONTRIBUTEDELIMITER
```
public static final java.lang.String KEY_CONTRIBUTEDELIMITER
```
    See Also:
    
    Constant Field Values
  - KEY_CONTRIBUTEUNROLL
```
public static final java.lang.String KEY_CONTRIBUTEUNROLL
```
    See Also:
    
    Constant Field Values
  - KEY_GROUPEDINTERVALOUTPUT
```
public static final java.lang.String KEY_GROUPEDINTERVALOUTPUT
```
    See Also:
    
    Constant Field Values
  - KEY_SAVEGROUPBYRAW
```
public static final java.lang.String KEY_SAVEGROUPBYRAW
```
    See Also:
    
    Constant Field Values
  - KEY_SAVEGROUPBYFORMAT
```
public static final java.lang.String KEY_SAVEGROUPBYFORMAT
```
    See Also:
    
    Constant Field Values
  - KEY_SAVEVARIABLECOLUMN
```
public static final java.lang.String KEY_SAVEVARIABLECOLUMN
```
    See Also:
    
    Constant Field Values
  - KEY_SAVEVARIABLESPECIFICATION
```
public static final java.lang.String KEY_SAVEVARIABLESPECIFICATION
```
    See Also:
    
    Constant Field Values
  - KEY_INPUTS
```
public static final java.lang.String KEY_INPUTS
```
    See Also:
    
    Constant Field Values
  - KEY_RAW
```
public static final java.lang.String KEY_RAW
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AggregateOptions
```
public AggregateOptions()
```
  - AggregateOptions
```
public AggregateOptions(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
  - getCasOut
```
public Casouttable getCasOut()
```
  - setCasOut
```
public AggregateOptions setCasOut(Casouttable value)
```
    Sets the value of parameter 'casOut': specifies the settings for an output table.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getGroupByLimit
```
public java.lang.Long getGroupByLimit()
```
  - setGroupByLimit
```
public AggregateOptions 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
  - getTable
```
public Castable getTable()
```
  - setTable
```
public AggregateOptions 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
  - getPartKey
```
public java.lang.String[] getPartKey()
```
  - setPartKey
```
public AggregateOptions 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 partition only.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getVarSpecs
```
public Tkcasagg_varspecs[] getVarSpecs()
```
  - setVarSpecs
```
public AggregateOptions setVarSpecs(Tkcasagg_varspecs[] value)
```
    Sets the value of parameter 'varSpecs': specifies the variable to aggregate and the settings for the aggregator.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getId
```
public java.lang.String getId()
```
  - setId
```
public AggregateOptions setId(java.lang.String value)
```
    Sets the value of parameter 'id': specifies a numeric variable that identifies the timestamp that is associated with each observation in the input table. The values are typically SAS DATE, TIME, or DATETIME values, but that is not required. The specified variable must also be specified in the groupBy parameter for the input table.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getAlign
```
public AggregateOptions.ALIGN getAlign()
```
  - setAlign
```
public AggregateOptions setAlign(AggregateOptions.ALIGN value)
```
    Sets the value of parameter 'align': specifies the alignment of the representative value with respect to an interval or bin. The server default is ALIGN.B.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getIdStart
```
public java.lang.Double getIdStart()
```
  - setIdStart
```
public AggregateOptions setIdStart(java.lang.Double value)
```
    Sets the value of parameter 'idStart': specifies the inclusive minimum value of the ID variable to be considered in the analysis. If the minimum value of the ID variable is greater than the idStart value, then the series is prefixed with missing values. If the first ID variable value is less than the idStart value, then the series is truncated. This parameter is ignored unless you also specify an ID variable.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getIdEnd
```
public java.lang.Double getIdEnd()
```
  - setIdEnd
```
public AggregateOptions setIdEnd(java.lang.Double value)
```
    Sets the value of parameter 'idEnd': specifies the inclusive maximum value of the ID variable to be considered in the analysis. If the maximum value of the ID variable is less than the idEnd value, the series is extended with missing values. If the last ID variable value is greater than the idEnd value, the series is truncated. This parameter is ignored unless you also specify an ID variable.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getIdRange
```
public java.lang.Double[] getIdRange()
```
  - setIdRange
```
public AggregateOptions setIdRange(java.lang.Double[] value)
```
    Sets the value of parameter 'idRange': specifies the inclusive minimum and maximum values of the ID variable to be considered in the analysis. It is equivalent to specifying both idStart and idEnd.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getInterval
```
public java.lang.String getInterval()
```
  - setInterval
```
public AggregateOptions setInterval(java.lang.String value)
```
    Sets the value of parameter 'interval': specifies the time period for the accumulation of observations. For example, if you specify interval='MONTH', then the action summarizes the observations in monthly intervals. This parameter is ignored unless you also specify an ID variable.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getSubInterval
```
public java.lang.String getSubInterval()
```
  - getSubInt
```
public java.lang.String getSubInt()
```
  - setSubInterval
```
public AggregateOptions setSubInterval(java.lang.String value)
```
    Sets the value of parameter 'subInterval': specifies a smaller interval to control the time period alignment within each interval for the aggregation of observations.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setSubInt
```
public AggregateOptions setSubInt(java.lang.String value)
```
  - getWindowInt
```
public java.lang.String getWindowInt()
```
  - getWinInt
```
public java.lang.String getWinInt()
```
  - getWindowInterval
```
public java.lang.String getWindowInterval()
```
  - setWindowInt
```
public AggregateOptions setWindowInt(java.lang.String value)
```
    Sets the value of parameter 'windowInt': specifies the time window for the accumulation of observations with respect to each time interval. For example, if you specify interval='MONTH' and windowInt='YEAR', then the action summarizes one year's worth of observations in monthly intervals.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setWinInt
```
public AggregateOptions setWinInt(java.lang.String value)
```
  - setWindowInterval
```
public AggregateOptions setWindowInterval(java.lang.String value)
```
  - getWindowSubInt
```
public java.lang.String getWindowSubInt()
```
  - getWinSubInterval
```
public java.lang.String getWinSubInterval()
```
  - getWinSubInt
```
public java.lang.String getWinSubInt()
```
  - getWindowSubInterval
```
public java.lang.String getWindowSubInterval()
```
  - setWindowSubInt
```
public AggregateOptions setWindowSubInt(java.lang.String value)
```
    Sets the value of parameter 'windowSubInt': this parameter is similar to subInterval. You can specify a smaller interval to control the sub time period alignment within each window interval for the aggregation of observations.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setWinSubInterval
```
public AggregateOptions setWinSubInterval(java.lang.String value)
```
  - setWinSubInt
```
public AggregateOptions setWinSubInt(java.lang.String value)
```
  - setWindowSubInterval
```
public AggregateOptions setWindowSubInterval(java.lang.String value)
```
  - getBin
```
public java.lang.Double[] getBin()
```
  - setBin
```
public AggregateOptions setBin(java.lang.Double[] value)
```
    Sets the value of parameter 'bin': specifies the minimum and maximum values of a bin. For example, if the values of the ID variable range from 0 to 100 and you specify bin={5, 15}, then the action constructs a time series with 11 bins. The first bin is [-5, 5] and the last bin is [95, 105]. The values on the upper boundary of a bin belong to this bin. The values on the lower boundary of a bin belong to the adjacent lower bin. This parameter is ignored unless you also specify an ID variable.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getSubBinOffset
```
public java.lang.Double getSubBinOffset()
```
  - setSubBinOffset
```
public AggregateOptions setSubBinOffset(java.lang.Double value)
```
    Sets the value of parameter 'subBinOffset': specifies an offset from the beginning of a bin. The value must be positive and less than or equal to the bin width. If the specified value is out of range, this parameter is ignored. This parameter is ignored unless you specify an ID variable and the bin parameter.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getSubBinWidth
```
public java.lang.Double getSubBinWidth()
```
  - setSubBinWidth
```
public AggregateOptions setSubBinWidth(java.lang.Double value)
```
    Sets the value of parameter 'subBinWidth': specifies the width of the sub bin within a bin. For example, if the values of the ID variable range from 0 to 100 and you specify bin={5, 15}, subBinOffset=2, and subBinWidth=5, then the action summarizes only the observations with ID variable values that fall into [-2, 3], [8, 13], [18, 23], ..., [98, 103]. The specified value must be positive and the sum of the subBinOffset value and subBinWidth value must be less than or equal to the bin width. If the value is out of range, this parameter is ignored. This parameter is ignored unless you also specify an ID variable and the bin parameter.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getWindowBin
```
public java.lang.Double[] getWindowBin()
```
  - setWindowBin
```
public AggregateOptions setWindowBin(java.lang.Double[] value)
```
    Sets the value of parameter 'windowBin': specifies the minimum and maximum values of a window bin. The specification and concepts are similar to the bin parameter, except the bins apply to intervals.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getWindowSubBinOffset
```
public java.lang.Double getWindowSubBinOffset()
```
  - getWinSubBinOffset
```
public java.lang.Double getWinSubBinOffset()
```
  - setWindowSubBinOffset
```
public AggregateOptions setWindowSubBinOffset(java.lang.Double value)
```
    Sets the value of parameter 'windowSubBinOffset': specifies the starting point within a window bin in which record values are aggregated. For example, if you specify windowBin={0, 10} and windowSubBinOffset=2, then records with ID variable values in the interval [0, 2) are ignored. The specified value must not be larger than the window bin's width.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setWinSubBinOffset
```
public AggregateOptions setWinSubBinOffset(java.lang.Double value)
```
  - getWindowSubBinWidth
```
public java.lang.Double getWindowSubBinWidth()
```
  - getWinSubBinWidth
```
public java.lang.Double getWinSubBinWidth()
```
  - setWindowSubBinWidth
```
public AggregateOptions setWindowSubBinWidth(java.lang.Double value)
```
    Sets the value of parameter 'windowSubBinWidth': specifies the width of the sub bin within each windowBin. The minimum acceptable value is 0, which renders windows ineffective. For example, if you specify windowBin={0, 10}, windowSubBinOffset=2, and windowSubBinWidth=5, then records with ID variable values in the intervals [0, 2) and [7, 10) are ignored.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setWinSubBinWidth
```
public AggregateOptions setWinSubBinWidth(java.lang.Double value)
```
  - getOffset
```
public java.lang.Integer getOffset()
```
  - getIntOffset
```
public java.lang.Integer getIntOffset()
```
  - getDif
```
public java.lang.Integer getDif()
```
  - getIntDif
```
public java.lang.Integer getIntDif()
```
  - getIntOff
```
public java.lang.Integer getIntOff()
```
  - setOffset
```
public AggregateOptions setOffset(java.lang.Integer value)
```
    Sets the value of parameter 'offset': specifies the offset of each interval. If you specify offset=-1, then every interval that is derived from the data set is shifted one interval backward. For example, a timestamp value for March 1 is derived from the data set to become February 1. The server default is 0.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setIntOffset
```
public AggregateOptions setIntOffset(java.lang.Integer value)
```
  - setDif
```
public AggregateOptions setDif(java.lang.Integer value)
```
  - setIntDif
```
public AggregateOptions setIntDif(java.lang.Integer value)
```
  - setIntOff
```
public AggregateOptions setIntOff(java.lang.Integer value)
```
  - getWindowOffset
```
public java.lang.Integer getWindowOffset()
```
  - getWindowIntOffset
```
public java.lang.Integer getWindowIntOffset()
```
  - getWinDif
```
public java.lang.Integer getWinDif()
```
  - getWinIntDif
```
public java.lang.Integer getWinIntDif()
```
  - getWinIntOff
```
public java.lang.Integer getWinIntOff()
```
  - getWindowIntervalOffset
```
public java.lang.Integer getWindowIntervalOffset()
```
  - setWindowOffset
```
public AggregateOptions setWindowOffset(java.lang.Integer value)
```
    Sets the value of parameter 'windowOffset': specifies the offset of each window interval. The effect is similar to how the offset parameter impacts the values for the interval parameter. The server default is 0.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setWindowIntOffset
```
public AggregateOptions setWindowIntOffset(java.lang.Integer value)
```
  - setWinDif
```
public AggregateOptions setWinDif(java.lang.Integer value)
```
  - setWinIntDif
```
public AggregateOptions setWinIntDif(java.lang.Integer value)
```
  - setWinIntOff
```
public AggregateOptions setWinIntOff(java.lang.Integer value)
```
  - setWindowIntervalOffset
```
public AggregateOptions setWindowIntervalOffset(java.lang.Integer value)
```
  - getPti
```
public java.lang.Double getPti()
```
  - getPtd
```
public java.lang.Double getPtd()
```
  - getPartialToDate
```
public java.lang.Double getPartialToDate()
```
  - getPartialToInterval
```
public java.lang.Double getPartialToInterval()
```
  - setPti
```
public AggregateOptions setPti(java.lang.Double value)
```
    Sets the value of parameter 'pti': specifies the time value when the aggregation within an interval or a bin is terminated. For example, if you specify interval='MONTH' and partialToInterval='10FEB98'd, then the action aggregates only records from the first 10 days of each month. The server default is 0.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setPtd
```
public AggregateOptions setPtd(java.lang.Double value)
```
  - setPartialToDate
```
public AggregateOptions setPartialToDate(java.lang.Double value)
```
  - setPartialToInterval
```
public AggregateOptions setPartialToInterval(java.lang.Double value)
```
  - getPtw
```
public java.lang.Double getPtw()
```
  - getPartialToWindow
```
public java.lang.Double getPartialToWindow()
```
  - setPtw
```
public AggregateOptions setPtw(java.lang.Double value)
```
    Sets the value of parameter 'ptw': specifies the subinterval with respect to each window interval. For example, if you specify windowInterval='MONTH' and partialToWindow='08FEB98'd, then the action counts only the first 8 days from JANUARY and the first 8 days from FEBURARY when it aggregates on window interval FEBURARY, ..., DECEMBER each year. This parameter is ignored unless you also specify the jumpingWindow parameter because the starting time varies for a sliding window (a non-jumping window). The server default is 0.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setPartialToWindow
```
public AggregateOptions setPartialToWindow(java.lang.Double value)
```
  - getEdgeId
```
public java.lang.String getEdgeId()
```
  - setEdgeId
```
public AggregateOptions setEdgeId(java.lang.String value)
```
    Sets the value of parameter 'edgeId': specifies a numeric variable whose values are used to order the values of each varSpecs specification that uses the FIRST, LAST, FNE, or LNE aggregator. This parameter can be overridden in a varSpecs specification that includes an edgeId subparameter.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getCopyVars
```
public java.lang.String[] getCopyVars()
```
  - getCopyVar
```
public java.lang.String[] getCopyVar()
```
  - setCopyVars
```
public AggregateOptions setCopyVars(java.lang.String[] value)
```
    Sets the value of parameter 'copyVars': specifies the variables to copy from the input table to the output table. The raw values are kept in the output. This parameter is ignored unless you also specify the groupBy parameter for the input table. When more than one record exists in a group, the minimum raw value is copied.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setCopyVar
```
public AggregateOptions setCopyVar(java.lang.String[] value)
```
  - getIncludeEmptyInterval
```
public java.lang.Boolean getIncludeEmptyInterval()
```
  - getIncludeMissInterval
```
public java.lang.Boolean getIncludeMissInterval()
```
  - getIncludeMissingInterval
```
public java.lang.Boolean getIncludeMissingInterval()
```
  - setIncludeEmptyInterval
```
public AggregateOptions setIncludeEmptyInterval(java.lang.Boolean value)
```
    Sets the value of parameter 'includeEmptyInterval': by default, intervals with a missing value for the ID variable are included in the output. When set to False, these intervals are excluded from the output. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setIncludeMissInterval
```
public AggregateOptions setIncludeMissInterval(java.lang.Boolean value)
```
  - setIncludeMissingInterval
```
public AggregateOptions setIncludeMissingInterval(java.lang.Boolean value)
```
  - getIncludeMissing
```
public java.lang.Boolean getIncludeMissing()
```
  - getIncludeMiss
```
public java.lang.Boolean getIncludeMiss()
```
  - getIncMissing
```
public java.lang.Boolean getIncMissing()
```
  - getIncMiss
```
public java.lang.Boolean getIncMiss()
```
  - setIncludeMissing
```
public AggregateOptions setIncludeMissing(java.lang.Boolean value)
```
    Sets the value of parameter 'includeMissing': by default, missing values are included in the analysis. When set to False, observations with missing values are excluded. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setIncludeMiss
```
public AggregateOptions setIncludeMiss(java.lang.Boolean value)
```
  - setIncMissing
```
public AggregateOptions setIncMissing(java.lang.Boolean value)
```
  - setIncMiss
```
public AggregateOptions setIncMiss(java.lang.Boolean value)
```
  - getJumpingWindow
```
public java.lang.Boolean getJumpingWindow()
```
  - setJumpingWindow
```
public AggregateOptions setJumpingWindow(java.lang.Boolean value)
```
    Sets the value of parameter 'jumpingWindow': when set to True, specifies that aggregation occurs over a time window that can contain multiple intervals and aggregation is reset when the specified time range elapses. By default, a window always retains the same multiple of intervals. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getModeSingle
```
public java.lang.Boolean getModeSingle()
```
  - setModeSingle
```
public AggregateOptions setModeSingle(java.lang.Boolean value)
```
    Sets the value of parameter 'modeSingle': this parameter is related to using the MODE aggregator. By default, the most frequent value is 'missing' if all the distinct values have a frequency of 1. When set to True, the minimum of these distinct values is returned as the most frequent value. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getKeepRecord
```
public java.lang.Boolean getKeepRecord()
```
  - setKeepRecord
```
public AggregateOptions setKeepRecord(java.lang.Boolean value)
```
    Sets the value of parameter 'keepRecord': when set to True, each observation's original value for the ID variable is kept without performing interval alignment. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getWeight
```
public java.lang.String getWeight()
```
  - setWeight
```
public AggregateOptions setWeight(java.lang.String value)
```
    Sets the value of parameter 'weight': specifies a numeric variable whose values are used as the weight of numeric analysis variable values when the aggregator is SUMMARY. This parameter is meaningful with the SUMMARY aggregator only. Observations with missing values are excluded from the analysis. By default, negative values of the weight variable are treated as 0. Use the excludeNonPositiveWeight parameter to change this behavior.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getExclnpwgt
```
public java.lang.Boolean getExclnpwgt()
```
  - getExcludeNonPositiveWeight
```
public java.lang.Boolean getExcludeNonPositiveWeight()
```
  - setExclnpwgt
```
public AggregateOptions setExclnpwgt(java.lang.Boolean value)
```
    Sets the value of parameter 'exclnpwgt': when set to True and a weight variable is specified, then observations with a non-positive weight value are excluded from the analysis. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setExcludeNonPositiveWeight
```
public AggregateOptions setExcludeNonPositiveWeight(java.lang.Boolean value)
```
  - getFreq
```
public java.lang.String getFreq()
```
  - getFrequency
```
public java.lang.String getFrequency()
```
  - setFreq
```
public AggregateOptions setFreq(java.lang.String value)
```
    Sets the value of parameter 'freq': specifies a numeric variable whose values are used as the frequency of analysis variable values. This parameter has an effect when the aggregator is SUMMARY, Q1, Q2, Q3, PERCENTILE, PLT, PIN, PGT, or MODE. With the exception of MODE, records with frequency values that are missing or less than 1 are excluded from the analysis. Only the integer portion of the frequency value is used.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setFrequency
```
public AggregateOptions setFrequency(java.lang.String value)
```
  - getFreqStrict
```
public java.lang.Boolean getFreqStrict()
```
  - setFreqStrict
```
public AggregateOptions setFreqStrict(java.lang.Boolean value)
```
    Sets the value of parameter 'freqStrict': this parameter is related to using the MODE aggregator. By default, observations with frequency values that are missing or less than 1 are excluded and only the integer portion of decimal values is used. When set to False, negative and the decimal values are used. Missing values are still excluded. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getPctlDef
```
public java.lang.Integer getPctlDef()
```
  - setPctlDef
```
public AggregateOptions setPctlDef(java.lang.Integer value)
```
    Sets the value of parameter 'pctlDef': specifies how to compute quantile statistics (percentiles) as described in the UNIVARIATE procedure documentation. The server default is 5.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getDoESP
```
public java.lang.Boolean getDoESP()
```
  - getPartAndOrder
```
public java.lang.Boolean getPartAndOrder()
```
  - setDoESP
```
public AggregateOptions setDoESP(java.lang.Boolean value)
```
    Sets the value of parameter 'doESP': when set to True, the action can take advantage of partitioning and ordering on the input table. You must specify the groupBy parameter for the input table. The ID variable must be specified as the last groupBy parameter and in the orderBy parameter. Setting this parameter to True implies setting the keepRecord parameter to True. When set to False (the default value), the keepRecordId, excludeSelf, contribute, contributeColumnName, contributeTrim, contributeDelimiter, and contributeUnroll parameters are ignored. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setPartAndOrder
```
public AggregateOptions setPartAndOrder(java.lang.Boolean value)
```
  - getKeepRecordId
```
public java.lang.Boolean getKeepRecordId()
```
  - setKeepRecordId
```
public AggregateOptions setKeepRecordId(java.lang.Boolean value)
```
    Sets the value of parameter 'keepRecordId': when set to True and the doESP parameter is True, each observation's original ID value is kept without performing interval alignment. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getExcludeSelf
```
public java.lang.Boolean getExcludeSelf()
```
  - setExcludeSelf
```
public AggregateOptions setExcludeSelf(java.lang.Boolean value)
```
    Sets the value of parameter 'excludeSelf': when set to True and the doESP parameter is True, the aggregation excludes the current observation's contribution. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getContribute
```
public java.lang.String getContribute()
```
  - setContribute
```
public AggregateOptions setContribute(java.lang.String value)
```
    Sets the value of parameter 'contribute': when the doESP parameter is True, you can specify a variable whose values within each aggregation interval are recorded. The value can be used as a key to join with the original table in order to understand each row contribution toward the aggregated interval.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getContributeColumnLabel
```
public java.lang.String getContributeColumnLabel()
```
  - setContributeColumnLabel
```
public AggregateOptions setContributeColumnLabel(java.lang.String value)
```
    Sets the value of parameter 'contributeColumnLabel': specifies a value to override the variable label from the contribute variable. By default, the contribute variable's label is shown in the results.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getContributeColumnName
```
public java.lang.String getContributeColumnName()
```
  - setContributeColumnName
```
public AggregateOptions setContributeColumnName(java.lang.String value)
```
    Sets the value of parameter 'contributeColumnName': specifies a value to override the variable name from the contribute variable. By default, the contribute variable's name is shown in the results.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getContributeTrim
```
public java.lang.Boolean getContributeTrim()
```
  - setContributeTrim
```
public AggregateOptions setContributeTrim(java.lang.Boolean value)
```
    Sets the value of parameter 'contributeTrim': when set to True, leading and trailing blanks are removed from the formatted value of the contribute variable. This parameter is ignored if the contributeUnroll parameter is set to True. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getContributeDelimiter
```
public java.lang.String getContributeDelimiter()
```
  - getDelimiter
```
public java.lang.String getDelimiter()
```
  - setContributeDelimiter
```
public AggregateOptions setContributeDelimiter(java.lang.String value)
```
    Sets the value of parameter 'contributeDelimiter': specifies a delimiter that is used between concatenated values of the contribute variable. The server default is ",".
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setDelimiter
```
public AggregateOptions setDelimiter(java.lang.String value)
```
  - getContributeUnroll
```
public java.lang.Boolean getContributeUnroll()
```
  - getUnroll
```
public java.lang.Boolean getUnroll()
```
  - setContributeUnroll
```
public AggregateOptions setContributeUnroll(java.lang.Boolean value)
```
    Sets the value of parameter 'contributeUnroll': by default, the formatted values from the contribute variable are concatenated together into a single row for the result table. When set to True, each raw value from the contribute variable adds a row to the result table. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setUnroll
```
public AggregateOptions setUnroll(java.lang.Boolean value)
```
  - getGroupedIntervalOutput
```
public java.lang.Boolean getGroupedIntervalOutput()
```
  - setGroupedIntervalOutput
```
public AggregateOptions setGroupedIntervalOutput(java.lang.Boolean value)
```
    Sets the value of parameter 'groupedIntervalOutput': when set to True, save only one of the same aggregated intervals with respect to the last Id value. The option is ignored if 'doESP' is set to False. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getSaveGroupbyRaw
```
public java.lang.Boolean getSaveGroupbyRaw()
```
  - getSaveGbyRaw
```
public java.lang.Boolean getSaveGbyRaw()
```
  - setSaveGroupbyRaw
```
public AggregateOptions setSaveGroupbyRaw(java.lang.Boolean value)
```
    Sets the value of parameter 'saveGroupbyRaw': by default, the raw values of the groupBy variables from the input table are copied to the results. When set to False, the raw values are not copied. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setSaveGbyRaw
```
public AggregateOptions setSaveGbyRaw(java.lang.Boolean value)
```
  - getSaveGroupbyFormat
```
public java.lang.Boolean getSaveGroupbyFormat()
```
  - getSaveGbyFmt
```
public java.lang.Boolean getSaveGbyFmt()
```
  - setSaveGroupbyFormat
```
public AggregateOptions setSaveGroupbyFormat(java.lang.Boolean value)
```
    Sets the value of parameter 'saveGroupbyFormat': by default, the formatted values of the groupBy variables from the input table are copied to the results. When set to False, the formatted values are not copied. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setSaveGbyFmt
```
public AggregateOptions setSaveGbyFmt(java.lang.Boolean value)
```
  - getSaveVariableColumn
```
public java.lang.Boolean getSaveVariableColumn()
```
  - getSaveVarCol
```
public java.lang.Boolean getSaveVarCol()
```
  - setSaveVariableColumn
```
public AggregateOptions setSaveVariableColumn(java.lang.Boolean value)
```
    Sets the value of parameter 'saveVariableColumn': by default, the variable name for each analysis variable is included in the results. The result table includes the name in a column that is named 'Column.' When set to False, this column is not included in the results. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setSaveVarCol
```
public AggregateOptions setSaveVarCol(java.lang.Boolean value)
```
  - getSaveVariableSpecification
```
public java.lang.Boolean getSaveVariableSpecification()
```
  - getSaveVarSpec
```
public java.lang.Boolean getSaveVarSpec()
```
  - setSaveVariableSpecification
```
public AggregateOptions setSaveVariableSpecification(java.lang.Boolean value)
```
    Sets the value of parameter 'saveVariableSpecification': by default, the results include a column that is named 'Variable Specification' to identify the varSpecs specification that produced the result. When set to False, this column is not included in the results. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setSaveVarSpec
```
public AggregateOptions setSaveVarSpec(java.lang.Boolean value)
```
  - getInputs
```
public Casinvardesc[] getInputs()
```
  - getInput
```
public Casinvardesc[] getInput()
```
  - setInputs
```
public AggregateOptions setInputs(Casinvardesc[] value)
```
    Sets the value of parameter 'inputs': specifies the input variables to use in the analysis. For raw numeric variables, the default aggregator is SUMMARY. For all other situations, the default aggregator is N. You can specify variables in this parameter or exercise more control by specifying the varSpecs parameter, but you cannot use both.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setInput
```
public AggregateOptions setInput(Casinvardesc[] value)
```
  - getRaw
```
public java.lang.Boolean getRaw()
```
  - setRaw
```
public AggregateOptions setRaw(java.lang.Boolean value)
```
    Sets the value of parameter 'raw': when set to True, raw values of the variables in the input parameter are used. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object

Class AggregateOptions

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.sas.cas.CASActionOptions

Constructor Summary

Method Summary

Methods inherited from class com.sas.cas.CASActionOptions

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

ACTION_SET_NAME

ACTION_NAME

KEY_CASOUT

KEY_GROUPBYLIMIT

KEY_TABLE

KEY_PARTKEY

KEY_VARSPECS

KEY_ID

KEY_ALIGN

KEY_IDSTART

KEY_IDEND

KEY_IDRANGE

KEY_INTERVAL

KEY_SUBINTERVAL

KEY_WINDOWINT

KEY_WINDOWSUBINT

KEY_BIN

KEY_SUBBINOFFSET

KEY_SUBBINWIDTH

KEY_WINDOWBIN

KEY_WINDOWSUBBINOFFSET

KEY_WINDOWSUBBINWIDTH

KEY_OFFSET

KEY_WINDOWOFFSET

KEY_PTI

KEY_PTW

KEY_EDGEID

KEY_COPYVARS

KEY_INCLUDEEMPTYINTERVAL

KEY_INCLUDEMISSING

KEY_JUMPINGWINDOW

KEY_MODESINGLE

KEY_KEEPRECORD

KEY_WEIGHT

KEY_EXCLNPWGT

KEY_FREQ

KEY_FREQSTRICT

KEY_PCTLDEF

KEY_DOESP

KEY_KEEPRECORDID

KEY_EXCLUDESELF

KEY_CONTRIBUTE

KEY_CONTRIBUTECOLUMNLABEL

KEY_CONTRIBUTECOLUMNNAME

KEY_CONTRIBUTETRIM

KEY_CONTRIBUTEDELIMITER

KEY_CONTRIBUTEUNROLL

KEY_GROUPEDINTERVALOUTPUT

KEY_SAVEGROUPBYRAW

KEY_SAVEGROUPBYFORMAT

KEY_SAVEVARIABLECOLUMN

KEY_SAVEVARIABLESPECIFICATION

KEY_INPUTS

KEY_RAW

Constructor Detail

AggregateOptions

AggregateOptions

Method Detail

getServerDefaultValue

getCasOut

setCasOut

getGroupByLimit

setGroupByLimit

getTable

setTable

getPartKey

setPartKey

getVarSpecs