Castable (cas-client 3.2.9 API)

java.lang.Object
- com.sas.cas.CASActionOptions
- - com.sas.cas.CASGeneratedActionOptions
  - - com.sas.cas.actions.Castable

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>
```
public class Castable
extends CASGeneratedActionOptions
```
Options for castable.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Castable.GROUPBYMODE
- 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`	`Castable.GROUPBYMODE`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`KEY_CASLIB`
`static java.lang.String`	`KEY_COMPUTEDONDEMAND`
`static java.lang.String`	`KEY_COMPUTEDVARS`
`static java.lang.String`	`KEY_COMPUTEDVARSPROGRAM`
`static java.lang.String`	`KEY_GROUPBY`
`static java.lang.String`	`KEY_GROUPBYMODE`
`static java.lang.String`	`KEY_IMPORTOPTIONS`
`static java.lang.String`	`KEY_NAME`
`static java.lang.String`	`KEY_ONDEMAND`
`static java.lang.String`	`KEY_ORDERBY`
`static java.lang.String`	`KEY_SINGLEPASS`
`static java.lang.String`	`KEY_VARS`
`static java.lang.String`	`KEY_WHERE`

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

Castable()

Castable(CASActionOptions options)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCaslib()`
`java.lang.Boolean`	`getCompOnDemand()`
`java.lang.String`	`getCompPgm()`
`java.lang.Boolean`	`getComputedOnDemand()`
`Casinvardesc[]`	`getComputedVars()`
`java.lang.String`	`getComputedVarsProgram()`
`Casinvardesc[]`	`getCompVars()`
`Casinvardesc[]`	`getGroupBy()`
`Castable.GROUPBYMODE`	`getGroupByMode()`
`java.lang.Object`	`getImport()`
`java.lang.Object`	`getImportOptions()`
`java.lang.String`	`getName()`
`java.lang.Boolean`	`getOnDemand()`
`Casinvardesc[]`	`getOrderBy()`
`java.lang.Object`	`getServerDefaultValue(java.lang.String key)` Gets the server default value, if known.
`java.lang.Boolean`	`getSinglePass()`
`Casinvardesc[]`	`getVars()`
`java.lang.String`	`getWhere()`
`Castable`	`setCaslib(java.lang.String value)` Sets the value of parameter 'caslib': specifies the caslib containing the table that you want to use with the action.
`Castable`	`setCompOnDemand(java.lang.Boolean value)`
`Castable`	`setCompPgm(java.lang.String value)`
`Castable`	`setComputedOnDemand(java.lang.Boolean value)` Sets the value of parameter 'computedOnDemand': when set to True, the computed variables are created when the table is loaded instead of when the action begins.
`Castable`	`setComputedVars(Casinvardesc[] value)` Sets the value of parameter 'computedVars': specifies the names of the computed variables to create.
`Castable`	`setComputedVarsProgram(java.lang.String value)` Sets the value of parameter 'computedVarsProgram': specifies an expression for each computed variable that you include in the computedVars parameter.
`Castable`	`setCompVars(Casinvardesc[] value)`
`Castable`	`setGroupBy(Casinvardesc[] value)` Sets the value of parameter 'groupBy': specifies the names of the variables to use for grouping results.
`Castable`	`setGroupByMode(Castable.GROUPBYMODE value)` Sets the value of parameter 'groupByMode': specifies how the server creates groups.
`Castable`	`setImport(Autoopts value)`
`Castable`	`setImport(Basesasopts value)`
`Castable`	`setImport(Csvopts value)`
`Castable`	`setImport(Dtaopts value)`
`Castable`	`setImport(Espopts value)`
`Castable`	`setImport(Excelopts value)`
`Castable`	`setImport(Fmtopts value)`
`Castable`	`setImport(Hdatopts value)`
`Castable`	`setImport(Jmpopts value)`
`Castable`	`setImport(Lasropts value)`
`Castable`	`setImport(Mvaopts value)`
`Castable`	`setImport(Spssopts value)`
`Castable`	`setImport(Xlsopts value)`
`Castable`	`setImportOptions(Autoopts value)` Sets the value of parameter 'importOptions' for alternative 1.
`Castable`	`setImportOptions(Basesasopts value)` Sets the value of parameter 'importOptions' for alternative 10.
`Castable`	`setImportOptions(Csvopts value)` Sets the value of parameter 'importOptions' for alternative 3.
`Castable`	`setImportOptions(Dtaopts value)` Sets the value of parameter 'importOptions' for alternative 7.
`Castable`	`setImportOptions(Espopts value)` Sets the value of parameter 'importOptions' for alternative 8.
`Castable`	`setImportOptions(Excelopts value)` Sets the value of parameter 'importOptions' for alternative 4.
`Castable`	`setImportOptions(Fmtopts value)` Sets the value of parameter 'importOptions' for alternative 13.
`Castable`	`setImportOptions(Hdatopts value)` Sets the value of parameter 'importOptions' for alternative 2.
`Castable`	`setImportOptions(Jmpopts value)` Sets the value of parameter 'importOptions' for alternative 5.
`Castable`	`setImportOptions(Lasropts value)` Sets the value of parameter 'importOptions' for alternative 9.
`Castable`	`setImportOptions(Mvaopts value)` Sets the value of parameter 'importOptions' for alternative 11.
`Castable`	`setImportOptions(Spssopts value)` Sets the value of parameter 'importOptions' for alternative 6.
`Castable`	`setImportOptions(Xlsopts value)` Sets the value of parameter 'importOptions' for alternative 12.
`Castable`	`setName(java.lang.String value)` Sets the value of parameter 'name': specifies the name of the table to use.
`Castable`	`setOnDemand(java.lang.Boolean value)` Sets the value of parameter 'onDemand': when set to True, table access is less aggressive with virtual memory use.
`Castable`	`setOrderBy(Casinvardesc[] value)` Sets the value of parameter 'orderBy': specifies the variables to use for ordering observations within partitions.
`Castable`	`setSinglePass(java.lang.Boolean value)` Sets the value of parameter 'singlePass': when set to True, the data does not create a transient table in the server.
`Castable`	`setVars(Casinvardesc[] value)` Sets the value of parameter 'vars': specifies the variables to use in the action.
`Castable`	`setWhere(java.lang.String value)` Sets the value of parameter 'where': specifies an expression for subsetting the input data.

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_NAME
```
public static final java.lang.String KEY_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_CASLIB
```
public static final java.lang.String KEY_CASLIB
```
    See Also:
    
    Constant Field Values
  - KEY_WHERE
```
public static final java.lang.String KEY_WHERE
```
    See Also:
    
    Constant Field Values
  - KEY_GROUPBY
```
public static final java.lang.String KEY_GROUPBY
```
    See Also:
    
    Constant Field Values
  - KEY_ORDERBY
```
public static final java.lang.String KEY_ORDERBY
```
    See Also:
    
    Constant Field Values
  - KEY_COMPUTEDVARS
```
public static final java.lang.String KEY_COMPUTEDVARS
```
    See Also:
    
    Constant Field Values
  - KEY_COMPUTEDVARSPROGRAM
```
public static final java.lang.String KEY_COMPUTEDVARSPROGRAM
```
    See Also:
    
    Constant Field Values
  - KEY_GROUPBYMODE
```
public static final java.lang.String KEY_GROUPBYMODE
```
    See Also:
    
    Constant Field Values
  - KEY_COMPUTEDONDEMAND
```
public static final java.lang.String KEY_COMPUTEDONDEMAND
```
    See Also:
    
    Constant Field Values
  - KEY_SINGLEPASS
```
public static final java.lang.String KEY_SINGLEPASS
```
    See Also:
    
    Constant Field Values
  - KEY_IMPORTOPTIONS
```
public static final java.lang.String KEY_IMPORTOPTIONS
```
    See Also:
    
    Constant Field Values
  - KEY_ONDEMAND
```
public static final java.lang.String KEY_ONDEMAND
```
    See Also:
    
    Constant Field Values
  - KEY_VARS
```
public static final java.lang.String KEY_VARS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Castable
```
public Castable()
```
  - Castable
```
public Castable(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
  - getName
```
public java.lang.String getName()
```
  - setName
```
public Castable setName(java.lang.String value)
```
    Sets the value of parameter 'name': specifies the name of the table to use.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getCaslib
```
public java.lang.String getCaslib()
```
  - setCaslib
```
public Castable setCaslib(java.lang.String value)
```
    Sets the value of parameter 'caslib': specifies the caslib containing the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getWhere
```
public java.lang.String getWhere()
```
  - setWhere
```
public Castable setWhere(java.lang.String value)
```
    Sets the value of parameter 'where': specifies an expression for subsetting the input data.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getGroupBy
```
public Casinvardesc[] getGroupBy()
```
  - setGroupBy
```
public Castable setGroupBy(Casinvardesc[] value)
```
    Sets the value of parameter 'groupBy': specifies the names of the variables to use for grouping results.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getOrderBy
```
public Casinvardesc[] getOrderBy()
```
  - setOrderBy
```
public Castable setOrderBy(Casinvardesc[] value)
```
    Sets the value of parameter 'orderBy': specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables or it can be combined with groupBy variables when groupByMode is set to REDISTRIBUTE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getComputedVars
```
public Casinvardesc[] getComputedVars()
```
  - getCompVars
```
public Casinvardesc[] getCompVars()
```
  - setComputedVars
```
public Castable setComputedVars(Casinvardesc[] value)
```
    Sets the value of parameter 'computedVars': specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setCompVars
```
public Castable setCompVars(Casinvardesc[] value)
```
  - getComputedVarsProgram
```
public java.lang.String getComputedVarsProgram()
```
  - getCompPgm
```
public java.lang.String getCompPgm()
```
  - setComputedVarsProgram
```
public Castable setComputedVarsProgram(java.lang.String value)
```
    Sets the value of parameter 'computedVarsProgram': specifies an expression for each computed variable that you include in the computedVars parameter.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setCompPgm
```
public Castable setCompPgm(java.lang.String value)
```
  - getGroupByMode
```
public Castable.GROUPBYMODE getGroupByMode()
```
  - setGroupByMode
```
public Castable setGroupByMode(Castable.GROUPBYMODE value)
```
    Sets the value of parameter 'groupByMode': specifies how the server creates groups. The server default is GROUPBYMODE.NOSORT.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getComputedOnDemand
```
public java.lang.Boolean getComputedOnDemand()
```
  - getCompOnDemand
```
public java.lang.Boolean getCompOnDemand()
```
  - setComputedOnDemand
```
public Castable setComputedOnDemand(java.lang.Boolean value)
```
    Sets the value of parameter 'computedOnDemand': when set to True, the computed variables are created when the table is loaded instead of when the action begins. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setCompOnDemand
```
public Castable setCompOnDemand(java.lang.Boolean value)
```
  - getSinglePass
```
public java.lang.Boolean getSinglePass()
```
  - setSinglePass
```
public Castable setSinglePass(java.lang.Boolean value)
```
    Sets the value of parameter 'singlePass': when set to True, the data does not create a transient table in the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs. The server default is FALSE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getImportOptions
```
public java.lang.Object getImportOptions()
```
  - getImport
```
public java.lang.Object getImport()
```
  - setImportOptions
```
public Castable setImportOptions(Autoopts value)
```
    Sets the value of parameter 'importOptions' for alternative 1.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Autoopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Hdatopts value)
```
    Sets the value of parameter 'importOptions' for alternative 2.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Hdatopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Csvopts value)
```
    Sets the value of parameter 'importOptions' for alternative 3.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Csvopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Excelopts value)
```
    Sets the value of parameter 'importOptions' for alternative 4.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Excelopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Jmpopts value)
```
    Sets the value of parameter 'importOptions' for alternative 5.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Jmpopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Spssopts value)
```
    Sets the value of parameter 'importOptions' for alternative 6.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Spssopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Dtaopts value)
```
    Sets the value of parameter 'importOptions' for alternative 7.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Dtaopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Espopts value)
```
    Sets the value of parameter 'importOptions' for alternative 8.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Espopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Lasropts value)
```
    Sets the value of parameter 'importOptions' for alternative 9.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Lasropts value)
```
  - setImportOptions
```
public Castable setImportOptions(Basesasopts value)
```
    Sets the value of parameter 'importOptions' for alternative 10.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Basesasopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Mvaopts value)
```
    Sets the value of parameter 'importOptions' for alternative 11.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Mvaopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Xlsopts value)
```
    Sets the value of parameter 'importOptions' for alternative 12.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Xlsopts value)
```
  - setImportOptions
```
public Castable setImportOptions(Fmtopts value)
```
    Sets the value of parameter 'importOptions' for alternative 13.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setImport
```
public Castable setImport(Fmtopts value)
```
  - getOnDemand
```
public java.lang.Boolean getOnDemand()
```
  - setOnDemand
```
public Castable setOnDemand(java.lang.Boolean value)
```
    Sets the value of parameter 'onDemand': when set to True, table access is less aggressive with virtual memory use. The server default is TRUE.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getVars
```
public Casinvardesc[] getVars()
```
  - setVars
```
public Castable setVars(Casinvardesc[] value)
```
    Sets the value of parameter 'vars': specifies the variables to use in the action.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object

Class Castable

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

KEY_NAME

KEY_CASLIB

KEY_WHERE

KEY_GROUPBY

KEY_ORDERBY

KEY_COMPUTEDVARS

KEY_COMPUTEDVARSPROGRAM

KEY_GROUPBYMODE

KEY_COMPUTEDONDEMAND

KEY_SINGLEPASS

KEY_IMPORTOPTIONS

KEY_ONDEMAND

KEY_VARS

Constructor Detail

Castable

Castable

Method Detail

getServerDefaultValue

getName

setName

getCaslib

setCaslib

getWhere

setWhere

getGroupBy

setGroupBy

getOrderBy

setOrderBy

getComputedVars

getCompVars

setComputedVars

setCompVars

getComputedVarsProgram

getCompPgm

setComputedVarsProgram

setCompPgm

getGroupByMode

setGroupByMode

getComputedOnDemand

getCompOnDemand

setComputedOnDemand

setCompOnDemand

getSinglePass

setSinglePass

getImportOptions

getImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport

setImportOptions

setImport