com.sas.cas.actions.search

Class SearchAggregateOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.search.SearchAggregateOptions

All Implemented Interfaces:

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

public class SearchAggregateOptions
extends CASGeneratedActionOptions

Options for searchAggregate: Aggregates certain fields in a table that is usually generated by searchIndex.

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_JSON
static java.lang.String	KEY_JSONOUT
static java.lang.String	KEY_TABLE

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
SearchAggregateOptions()
SearchAggregateOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getJson()
java.lang.Boolean	getJsonOut()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Castable	getTable()
SearchAggregateOptions	setJson(java.lang.String value) Sets the value of parameter 'json': a JSON string that contains parameters for the aggregation.
SearchAggregateOptions	setJsonOut(java.lang.Boolean value) Sets the value of parameter 'jsonOut': requests a json output of the results.
SearchAggregateOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the name of the table that contains the documents used for the aggregation.

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_JSON

public static final java.lang.String KEY_JSON

See Also:

Constant Field Values

KEY_JSONOUT

public static final java.lang.String KEY_JSONOUT

See Also:

Constant Field Values

Constructor Detail

SearchAggregateOptions

public SearchAggregateOptions()

SearchAggregateOptions

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

Sets the value of parameter 'table': specifies the name of the table that contains the documents used for the aggregation.

Parameters:

value - The value

Returns:

The options object

getJson

public java.lang.String getJson()

setJson

public SearchAggregateOptions setJson(java.lang.String value)

Sets the value of parameter 'json': a JSON string that contains parameters for the aggregation.

Parameters:

value - The value

Returns:

The options object

getJsonOut

public java.lang.Boolean getJsonOut()

setJsonOut

public SearchAggregateOptions setJsonOut(java.lang.Boolean value)

Sets the value of parameter 'jsonOut': requests a json output of the results. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object