com.sas.cas.actions.table

Class FetchOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.table.FetchOptions

All Implemented Interfaces:

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

public class FetchOptions
extends CASGeneratedActionOptions

Options for fetch: Fetches rows from a table or view.

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_FETCHVARS
static java.lang.String	KEY_FORMAT
static java.lang.String	KEY_FROM
static java.lang.String	KEY_INDEX
static java.lang.String	KEY_MAXROWS
static java.lang.String	KEY_SASTYPES
static java.lang.String	KEY_SORTBY
static java.lang.String	KEY_SORTLOCALE
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_TO

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

Method Summary

Modifier and Type	Method and Description
Casinvardesc[]	getFetchVars()
java.lang.Boolean	getFormat()
java.lang.Long	getFrom()
java.lang.Boolean	getIndex()
java.lang.Integer	getMaxRows()
Fetchorderbyelement[]	getOrderBy()
java.lang.Boolean	getSasTypes()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Fetchorderbyelement[]	getSortBy()
java.lang.String	getSortLocale()
Castable	getTable()
java.lang.Long	getTo()
FetchOptions	setFetchVars(Casinvardesc[] value) Sets the value of parameter 'fetchVars'.
FetchOptions	setFormat(java.lang.Boolean value) Sets the value of parameter 'format': when set to True, formats are applied to the variables.
FetchOptions	setFrom(java.lang.Long value) Sets the value of parameter 'from': specifies the ordinal position of the first row to return.
FetchOptions	setIndex(java.lang.Boolean value) Sets the value of parameter 'index': when set to True, adds a column named Index to the results that is to identify each row.
FetchOptions	setMaxRows(java.lang.Integer value) Sets the value of parameter 'maxRows': specifies the maximum number of rows to return.
FetchOptions	setOrderBy(Fetchorderbyelement[] value)
FetchOptions	setSasTypes(java.lang.Boolean value) Sets the value of parameter 'sasTypes': when set to True, converts data to fixed-width character and double data types.
FetchOptions	setSortBy(Fetchorderbyelement[] value) Sets the value of parameter 'sortBy': specifies the variables and variable settings for sorting results.
FetchOptions	setSortLocale(java.lang.String value) Sets the value of parameter 'sortLocale': locale to use for comparisons during sort.
FetchOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the table name, caslib, and other common parameters.
FetchOptions	setTo(java.lang.Long value) Sets the value of parameter 'to': specifies the ordinal position of the last row to return.

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_FROM

public static final java.lang.String KEY_FROM

See Also:

Constant Field Values

KEY_TO

public static final java.lang.String KEY_TO

See Also:

Constant Field Values

KEY_FORMAT

public static final java.lang.String KEY_FORMAT

See Also:

Constant Field Values

KEY_MAXROWS

public static final java.lang.String KEY_MAXROWS

See Also:

Constant Field Values

KEY_SASTYPES

public static final java.lang.String KEY_SASTYPES

See Also:

Constant Field Values

KEY_SORTLOCALE

public static final java.lang.String KEY_SORTLOCALE

See Also:

Constant Field Values

KEY_SORTBY

public static final java.lang.String KEY_SORTBY

See Also:

Constant Field Values

KEY_INDEX

public static final java.lang.String KEY_INDEX

See Also:

Constant Field Values

KEY_FETCHVARS

public static final java.lang.String KEY_FETCHVARS

See Also:

Constant Field Values

Constructor Detail

FetchOptions

public FetchOptions()

FetchOptions

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

getFrom

public java.lang.Long getFrom()

setFrom

public FetchOptions setFrom(java.lang.Long value)

Sets the value of parameter 'from': specifies the ordinal position of the first row to return. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getTo

public java.lang.Long getTo()

setTo

public FetchOptions setTo(java.lang.Long value)

Sets the value of parameter 'to': specifies the ordinal position of the last row to return. The server default is 20.

Parameters:

value - The value

Returns:

The options object

getFormat

public java.lang.Boolean getFormat()

setFormat

public FetchOptions setFormat(java.lang.Boolean value)

Sets the value of parameter 'format': when set to True, formats are applied to the variables. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getMaxRows

public java.lang.Integer getMaxRows()

setMaxRows

public FetchOptions setMaxRows(java.lang.Integer value)

Sets the value of parameter 'maxRows': specifies the maximum number of rows to return. The server default is 1000.

Parameters:

value - The value

Returns:

The options object

getSasTypes

public java.lang.Boolean getSasTypes()

setSasTypes

public FetchOptions setSasTypes(java.lang.Boolean value)

Sets the value of parameter 'sasTypes': when set to True, converts data to fixed-width character and double data types. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getSortLocale

public java.lang.String getSortLocale()

setSortLocale

public FetchOptions setSortLocale(java.lang.String value)

Sets the value of parameter 'sortLocale': locale to use for comparisons during sort.

Parameters:

value - The value

Returns:

The options object

getSortBy

public Fetchorderbyelement[] getSortBy()

getOrderBy

public Fetchorderbyelement[] getOrderBy()

setSortBy

public FetchOptions setSortBy(Fetchorderbyelement[] value)

Sets the value of parameter 'sortBy': specifies the variables and variable settings for sorting results.

Parameters:

value - The value

Returns:

The options object

setOrderBy

public FetchOptions setOrderBy(Fetchorderbyelement[] value)

getIndex

public java.lang.Boolean getIndex()

setIndex

public FetchOptions setIndex(java.lang.Boolean value)

Sets the value of parameter 'index': when set to True, adds a column named Index to the results that is to identify each row. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getFetchVars

public Casinvardesc[] getFetchVars()

setFetchVars

public FetchOptions setFetchVars(Casinvardesc[] value)

Sets the value of parameter 'fetchVars'.

Parameters:

value - The value

Returns:

The options object