com.sas.cas.actions

Class Excelopts

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.Excelopts

All Implemented Interfaces:

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

public class Excelopts
extends CASGeneratedActionOptions

Options for castable.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Excelopts.FILETYPE

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	KEY_FILETYPE
static java.lang.String	KEY_GETNAMES
static java.lang.String	KEY_RANGE
static java.lang.String	KEY_SHEET

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

Method Summary

Modifier and Type	Method and Description
Excelopts.FILETYPE	getFileType()
java.lang.Boolean	getGetNames()
java.lang.String	getRange()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.String	getSheet()
Excelopts	setFileType(Excelopts.FILETYPE value) Sets the value of parameter 'fileType': imports a Microsoft Excel workbook.
Excelopts	setGetNames(java.lang.Boolean value) Sets the value of parameter 'getNames': when set to True, the values in the first line of the file are used as variable names.
Excelopts	setRange(java.lang.String value) Sets the value of parameter 'range': specifies a subset of the cells to import.
Excelopts	setSheet(java.lang.String value) Sets the value of parameter 'sheet': specifies the name of the worksheet to import.

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

KEY_FILETYPE

public static final java.lang.String KEY_FILETYPE

See Also:

Constant Field Values

KEY_SHEET

public static final java.lang.String KEY_SHEET

See Also:

Constant Field Values

KEY_RANGE

public static final java.lang.String KEY_RANGE

See Also:

Constant Field Values

KEY_GETNAMES

public static final java.lang.String KEY_GETNAMES

See Also:

Constant Field Values

Constructor Detail

Excelopts

public Excelopts()

Excelopts

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

getFileType

public Excelopts.FILETYPE getFileType()

setFileType

public Excelopts setFileType(Excelopts.FILETYPE value)

Sets the value of parameter 'fileType': imports a Microsoft Excel workbook. The server default is FILETYPE.EXCEL.

Parameters:

value - The value

Returns:

The options object

getSheet

public java.lang.String getSheet()

setSheet

public Excelopts setSheet(java.lang.String value)

Sets the value of parameter 'sheet': specifies the name of the worksheet to import.

Parameters:

value - The value

Returns:

The options object

getRange

public java.lang.String getRange()

setRange

public Excelopts setRange(java.lang.String value)

Sets the value of parameter 'range': specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

Parameters:

value - The value

Returns:

The options object

getGetNames

public java.lang.Boolean getGetNames()

setGetNames

public Excelopts setGetNames(java.lang.Boolean value)

Sets the value of parameter 'getNames': when set to True, the values in the first line of the file are used as variable names. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object