com.sas.cas.actions.table

Class FileInfoOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.table.FileInfoOptions

All Implemented Interfaces:

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

public class FileInfoOptions
extends CASGeneratedActionOptions

Options for fileInfo: Lists the files in a caslib's data source.

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_ALLFILES
static java.lang.String	KEY_CASLIB
static java.lang.String	KEY_DATASOURCEOPTIONS
static java.lang.String	KEY_INCLUDEDIRECTORIES
static java.lang.String	KEY_KBYTES
static java.lang.String	KEY_PATH
static java.lang.String	KEY_ROWCOUNT
static java.lang.String	KEY_WILDIGNORE
static java.lang.String	KEY_WILDSENSITIVE

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllFiles()
java.lang.String	getCaslib()
java.util.Map<java.lang.String,java.lang.Object>	getDataSource()
java.util.Map<java.lang.String,java.lang.Object>	getDataSourceOptions()
java.lang.String	getDirectory()
java.lang.Boolean	getIncludeDirectories()
java.lang.Boolean	getIncludeDirs()
java.lang.Boolean	getKbytes()
java.util.Map<java.lang.String,java.lang.Object>	getOptions()
java.lang.String	getPath()
java.lang.Boolean	getRowCount()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getWildignore()
java.lang.Boolean	getWildsensitive()
FileInfoOptions	setAllFiles(java.lang.Boolean value) Sets the value of parameter 'allFiles': when set to True, lists all file types in the results.
FileInfoOptions	setCaslib(java.lang.String value) Sets the value of parameter 'caslib': specifies the name of the caslib to use.
FileInfoOptions	setDataSource(java.util.Map<java.lang.String,java.lang.Object> value)
FileInfoOptions	setDataSourceOptions(java.util.Map<java.lang.String,java.lang.Object> value) Sets the value of parameter 'dataSourceOptions': specifies data source options.
FileInfoOptions	setDirectory(java.lang.String value)
FileInfoOptions	setIncludeDirectories(java.lang.Boolean value) Sets the value of parameter 'includeDirectories': when set to True, includes directories in the results.
FileInfoOptions	setIncludeDirs(java.lang.Boolean value)
FileInfoOptions	setKbytes(java.lang.Boolean value) Sets the value of parameter 'kbytes': when set to True, lists file sizes in kilobytes.
FileInfoOptions	setOptions(java.util.Map<java.lang.String,java.lang.Object> value)
FileInfoOptions	setPath(java.lang.String value) Sets the value of parameter 'path': specifies the file, directory, or table name.
FileInfoOptions	setRowCount(java.lang.Boolean value) Sets the value of parameter 'rowCount': when set to True, includes the number of rows in the results.
FileInfoOptions	setWildignore(java.lang.Boolean value) Sets the value of parameter 'wildignore': specifies wildcards are ignored.
FileInfoOptions	setWildsensitive(java.lang.Boolean value) Sets the value of parameter 'wildsensitive': specifies case sensitive wildcarding.

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_PATH

public static final java.lang.String KEY_PATH

See Also:

Constant Field Values

KEY_CASLIB

public static final java.lang.String KEY_CASLIB

See Also:

Constant Field Values

KEY_ROWCOUNT

public static final java.lang.String KEY_ROWCOUNT

See Also:

Constant Field Values

KEY_ALLFILES

public static final java.lang.String KEY_ALLFILES

See Also:

Constant Field Values

KEY_INCLUDEDIRECTORIES

public static final java.lang.String KEY_INCLUDEDIRECTORIES

See Also:

Constant Field Values

KEY_KBYTES

public static final java.lang.String KEY_KBYTES

See Also:

Constant Field Values

KEY_WILDSENSITIVE

public static final java.lang.String KEY_WILDSENSITIVE

See Also:

Constant Field Values

KEY_WILDIGNORE

public static final java.lang.String KEY_WILDIGNORE

See Also:

Constant Field Values

KEY_DATASOURCEOPTIONS

public static final java.lang.String KEY_DATASOURCEOPTIONS

See Also:

Constant Field Values

Constructor Detail

FileInfoOptions

public FileInfoOptions()

FileInfoOptions

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

getPath

public java.lang.String getPath()

getDirectory

public java.lang.String getDirectory()

setPath

public FileInfoOptions setPath(java.lang.String value)

Sets the value of parameter 'path': specifies the file, directory, or table name.

Parameters:

value - The value

Returns:

The options object

setDirectory

public FileInfoOptions setDirectory(java.lang.String value)

getCaslib

public java.lang.String getCaslib()

setCaslib

public FileInfoOptions setCaslib(java.lang.String value)

Sets the value of parameter 'caslib': specifies the name of the caslib to use.

Parameters:

value - The value

Returns:

The options object

getRowCount

public java.lang.Boolean getRowCount()

setRowCount

public FileInfoOptions setRowCount(java.lang.Boolean value)

Sets the value of parameter 'rowCount': when set to True, includes the number of rows in the results. Some data sources do not support this parameter. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getAllFiles

public java.lang.Boolean getAllFiles()

setAllFiles

public FileInfoOptions setAllFiles(java.lang.Boolean value)

Sets the value of parameter 'allFiles': when set to True, lists all file types in the results. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getIncludeDirectories

public java.lang.Boolean getIncludeDirectories()

getIncludeDirs

public java.lang.Boolean getIncludeDirs()

setIncludeDirectories

public FileInfoOptions setIncludeDirectories(java.lang.Boolean value)

Sets the value of parameter 'includeDirectories': when set to True, includes directories in the results. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

setIncludeDirs

public FileInfoOptions setIncludeDirs(java.lang.Boolean value)

getKbytes

public java.lang.Boolean getKbytes()

setKbytes

public FileInfoOptions setKbytes(java.lang.Boolean value)

Sets the value of parameter 'kbytes': when set to True, lists file sizes in kilobytes. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getWildsensitive

public java.lang.Boolean getWildsensitive()

setWildsensitive

public FileInfoOptions setWildsensitive(java.lang.Boolean value)

Sets the value of parameter 'wildsensitive': specifies case sensitive wildcarding. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getWildignore

public java.lang.Boolean getWildignore()

setWildignore

public FileInfoOptions setWildignore(java.lang.Boolean value)

Sets the value of parameter 'wildignore': specifies wildcards are ignored. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getDataSourceOptions

public java.util.Map<java.lang.String,java.lang.Object> getDataSourceOptions()

getOptions

public java.util.Map<java.lang.String,java.lang.Object> getOptions()

getDataSource

public java.util.Map<java.lang.String,java.lang.Object> getDataSource()

setDataSourceOptions

public FileInfoOptions setDataSourceOptions(java.util.Map<java.lang.String,java.lang.Object> value)

Sets the value of parameter 'dataSourceOptions': specifies data source options.

Parameters:

value - The value

Returns:

The options object

setOptions

public FileInfoOptions setOptions(java.util.Map<java.lang.String,java.lang.Object> value)

setDataSource

public FileInfoOptions setDataSource(java.util.Map<java.lang.String,java.lang.Object> value)