UnsuperOptions (cas-client 3.2.9 API)

java.lang.Object
- com.sas.cas.CASActionOptions
- - com.sas.cas.CASGeneratedActionOptions
  - - com.sas.cas.actions.varReduce.UnsuperOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>
```
public class UnsuperOptions
extends CASGeneratedActionOptions
```
Options for unsuper: Provides an action for performing unsupervised dimension reduction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UnsuperOptions.TECH
- 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`	`UnsuperOptions.TECH`

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_ATTRIBUTES`
`static java.lang.String`	`KEY_CLASS`
`static java.lang.String`	`KEY_CLASSGLOBALOPTS`
`static java.lang.String`	`KEY_COLLECTION`
`static java.lang.String`	`KEY_DISPLAY`
`static java.lang.String`	`KEY_FREQ`
`static java.lang.String`	`KEY_INPUTS`
`static java.lang.String`	`KEY_MAXEFFECTS`
`static java.lang.String`	`KEY_MAXSTEPS`
`static java.lang.String`	`KEY_MODEL`
`static java.lang.String`	`KEY_MULTIMEMBER`
`static java.lang.String`	`KEY_NOMINALS`
`static java.lang.String`	`KEY_OUTCP`
`static java.lang.String`	`KEY_OUTPUTTABLES`
`static java.lang.String`	`KEY_POLYNOMIAL`
`static java.lang.String`	`KEY_TABLE`
`static java.lang.String`	`KEY_TECH`
`static java.lang.String`	`KEY_VAREXP`
`static java.lang.String`	`KEY_VARINC`

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

UnsuperOptions()

UnsuperOptions(CASActionOptions options)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Casinvardesc[]`	`getAttribute()`
`Casinvardesc[]`	`getAttributes()`
`Classopts`	`getClassglobalopts()`
`ClassStatement[]`	`getClassParameter()`
`ClassStatement[]`	`getClassVars()`
`Collection[]`	`getCollection()`
`DisplayTables`	`getDisplay()`
`java.lang.String`	`getFreq()`
`Casinvardesc[]`	`getInput()`
`Casinvardesc[]`	`getInputs()`
`java.lang.Long`	`getMaxeffects()`
`java.lang.Long`	`getMaxsteps()`
`ModelStatement`	`getModel()`
`Multimember[]`	`getMultimember()`
`Casinvardesc[]`	`getNominal()`
`Casinvardesc[]`	`getNominals()`
`OutputCPStatement`	`getOutcp()`
`OutputTables`	`getOutputTables()`
`Polynomial[]`	`getPoly()`
`Polynomial[]`	`getPolynomial()`
`java.lang.Object`	`getServerDefaultValue(java.lang.String key)` Gets the server default value, if known.
`Castable`	`getTable()`
`UnsuperOptions.TECH`	`getTech()`
`java.lang.Double`	`getVarexp()`
`java.lang.Double`	`getVarinc()`
`UnsuperOptions`	`setAttribute(Casinvardesc[] value)`
`UnsuperOptions`	`setAttributes(Casinvardesc[] value)` Sets the value of parameter 'attributes': alters attributes on variables used in this action.
`UnsuperOptions`	`setClassglobalopts(Classopts value)` Sets the value of parameter 'classglobalopts': lists options that apply to all classification variables.
`UnsuperOptions`	`setClassParameter(ClassStatement[] value)` Sets the value of parameter 'class': names the classification variables to be used as explanatory variables in the analysis.
`UnsuperOptions`	`setClassVars(ClassStatement[] value)`
`UnsuperOptions`	`setCollection(Collection[] value)` Sets the value of parameter 'collection': defines a set of variables that are treated as a single effect that has multiple degrees of freedom.
`UnsuperOptions`	`setDisplay(DisplayTables value)` Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
`UnsuperOptions`	`setFreq(java.lang.String value)` Sets the value of parameter 'freq': names the numeric variable that contains the frequency of occurrence for each observation.
`UnsuperOptions`	`setInput(Casinvardesc[] value)`
`UnsuperOptions`	`setInputs(Casinvardesc[] value)` Sets the value of parameter 'inputs': specifies variables to use for analysis.
`UnsuperOptions`	`setMaxeffects(java.lang.Long value)` Sets the value of parameter 'maxeffects': specifies the number of effects to select; the number must be greater than or equal to 1.
`UnsuperOptions`	`setMaxsteps(java.lang.Long value)` Sets the value of parameter 'maxsteps': specifies the maximum number of steps to take; the number must be greater than or equal to 1.
`UnsuperOptions`	`setModel(ModelStatement value)` Sets the value of parameter 'model': names the dependent variable, explanatory effects, and model options.
`UnsuperOptions`	`setMultimember(Multimember[] value)` Sets the value of parameter 'multimember': uses one or more classification variables specified in the vars parameter in such a way that each observation can be associated with one or more levels of the union of the levels of the classification variables.
`UnsuperOptions`	`setNominal(Casinvardesc[] value)`
`UnsuperOptions`	`setNominals(Casinvardesc[] value)` Sets the value of parameter 'nominals': specifies nominal variables to use for analysis.
`UnsuperOptions`	`setOutcp(OutputCPStatement value)` Sets the value of parameter 'outcp': creates a data set that contains a symmetric matrix that depicts the relationships among variables and also a set of statistics about the input data set and variables.
`UnsuperOptions`	`setOutputTables(OutputTables value)` Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
`UnsuperOptions`	`setPoly(Polynomial[] value)`
`UnsuperOptions`	`setPolynomial(Polynomial[] value)` Sets the value of parameter 'polynomial': specifies a polynomial effect.
`UnsuperOptions`	`setTable(Castable value)` Sets the value of parameter 'table': specifies the settings for an input table.
`UnsuperOptions`	`setTech(UnsuperOptions.TECH value)` Sets the value of parameter 'tech': specifies the matrix to use to select variables: Pearson correlation (CORR), sum of squares and crossproducts (SSCP), or covariance (COV), respectively.
`UnsuperOptions`	`setVarexp(java.lang.Double value)` Sets the value of parameter 'varexp': specifies the fraction of the total variance to be explained; the value must be between 0 and 1.
`UnsuperOptions`	`setVarinc(java.lang.Double value)` Sets the value of parameter 'varinc': specifies the minimum increment of explained variance (in a fraction of the total variance); the value must be between 0 and 1.

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_FREQ
```
public static final java.lang.String KEY_FREQ
```
    See Also:
    
    Constant Field Values
  - KEY_OUTPUTTABLES
```
public static final java.lang.String KEY_OUTPUTTABLES
```
    See Also:
    
    Constant Field Values
  - KEY_DISPLAY
```
public static final java.lang.String KEY_DISPLAY
```
    See Also:
    
    Constant Field Values
  - KEY_CLASS
```
public static final java.lang.String KEY_CLASS
```
    See Also:
    
    Constant Field Values
  - KEY_CLASSGLOBALOPTS
```
public static final java.lang.String KEY_CLASSGLOBALOPTS
```
    See Also:
    
    Constant Field Values
  - KEY_MODEL
```
public static final java.lang.String KEY_MODEL
```
    See Also:
    
    Constant Field Values
  - KEY_OUTCP
```
public static final java.lang.String KEY_OUTCP
```
    See Also:
    
    Constant Field Values
  - KEY_TECH
```
public static final java.lang.String KEY_TECH
```
    See Also:
    
    Constant Field Values
  - KEY_MAXSTEPS
```
public static final java.lang.String KEY_MAXSTEPS
```
    See Also:
    
    Constant Field Values
  - KEY_MAXEFFECTS
```
public static final java.lang.String KEY_MAXEFFECTS
```
    See Also:
    
    Constant Field Values
  - KEY_VAREXP
```
public static final java.lang.String KEY_VAREXP
```
    See Also:
    
    Constant Field Values
  - KEY_VARINC
```
public static final java.lang.String KEY_VARINC
```
    See Also:
    
    Constant Field Values
  - KEY_COLLECTION
```
public static final java.lang.String KEY_COLLECTION
```
    See Also:
    
    Constant Field Values
  - KEY_MULTIMEMBER
```
public static final java.lang.String KEY_MULTIMEMBER
```
    See Also:
    
    Constant Field Values
  - KEY_POLYNOMIAL
```
public static final java.lang.String KEY_POLYNOMIAL
```
    See Also:
    
    Constant Field Values
  - KEY_INPUTS
```
public static final java.lang.String KEY_INPUTS
```
    See Also:
    
    Constant Field Values
  - KEY_NOMINALS
```
public static final java.lang.String KEY_NOMINALS
```
    See Also:
    
    Constant Field Values
  - KEY_ATTRIBUTES
```
public static final java.lang.String KEY_ATTRIBUTES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UnsuperOptions
```
public UnsuperOptions()
```
  - UnsuperOptions
```
public UnsuperOptions(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 UnsuperOptions setTable(Castable value)
```
    Sets the value of parameter 'table': specifies the settings for an input table.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getFreq
```
public java.lang.String getFreq()
```
  - setFreq
```
public UnsuperOptions setFreq(java.lang.String value)
```
    Sets the value of parameter 'freq': names the numeric variable that contains the frequency of occurrence for each observation.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getOutputTables
```
public OutputTables getOutputTables()
```
  - setOutputTables
```
public UnsuperOptions setOutputTables(OutputTables value)
```
    Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getDisplay
```
public DisplayTables getDisplay()
```
  - setDisplay
```
public UnsuperOptions setDisplay(DisplayTables value)
```
    Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getClassParameter
```
public ClassStatement[] getClassParameter()
```
  - getClassVars
```
public ClassStatement[] getClassVars()
```
  - setClassParameter
```
public UnsuperOptions setClassParameter(ClassStatement[] value)
```
    Sets the value of parameter 'class': names the classification variables to be used as explanatory variables in the analysis.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setClassVars
```
public UnsuperOptions setClassVars(ClassStatement[] value)
```
  - getClassglobalopts
```
public Classopts getClassglobalopts()
```
  - setClassglobalopts
```
public UnsuperOptions setClassglobalopts(Classopts value)
```
    Sets the value of parameter 'classglobalopts': lists options that apply to all classification variables.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getModel
```
public ModelStatement getModel()
```
  - setModel
```
public UnsuperOptions setModel(ModelStatement value)
```
    Sets the value of parameter 'model': names the dependent variable, explanatory effects, and model options.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getOutcp
```
public OutputCPStatement getOutcp()
```
  - setOutcp
```
public UnsuperOptions setOutcp(OutputCPStatement value)
```
    Sets the value of parameter 'outcp': creates a data set that contains a symmetric matrix that depicts the relationships among variables and also a set of statistics about the input data set and variables.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getTech
```
public UnsuperOptions.TECH getTech()
```
  - setTech
```
public UnsuperOptions setTech(UnsuperOptions.TECH value)
```
    Sets the value of parameter 'tech': specifies the matrix to use to select variables: Pearson correlation (CORR), sum of squares and crossproducts (SSCP), or covariance (COV), respectively. The server default is TECH.CORR.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getMaxsteps
```
public java.lang.Long getMaxsteps()
```
  - setMaxsteps
```
public UnsuperOptions setMaxsteps(java.lang.Long value)
```
    Sets the value of parameter 'maxsteps': specifies the maximum number of steps to take; the number must be greater than or equal to 1. The server default is 0.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getMaxeffects
```
public java.lang.Long getMaxeffects()
```
  - setMaxeffects
```
public UnsuperOptions setMaxeffects(java.lang.Long value)
```
    Sets the value of parameter 'maxeffects': specifies the number of effects to select; the number must be greater than or equal to 1. The server default is 200.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getVarexp
```
public java.lang.Double getVarexp()
```
  - setVarexp
```
public UnsuperOptions setVarexp(java.lang.Double value)
```
    Sets the value of parameter 'varexp': specifies the fraction of the total variance to be explained; the value must be between 0 and 1. The server default is 0.9.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getVarinc
```
public java.lang.Double getVarinc()
```
  - setVarinc
```
public UnsuperOptions setVarinc(java.lang.Double value)
```
    Sets the value of parameter 'varinc': specifies the minimum increment of explained variance (in a fraction of the total variance); the value must be between 0 and 1. The server default is 0.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getCollection
```
public Collection[] getCollection()
```
  - setCollection
```
public UnsuperOptions setCollection(Collection[] value)
```
    Sets the value of parameter 'collection': defines a set of variables that are treated as a single effect that has multiple degrees of freedom.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getMultimember
```
public Multimember[] getMultimember()
```
  - setMultimember
```
public UnsuperOptions setMultimember(Multimember[] value)
```
    Sets the value of parameter 'multimember': uses one or more classification variables specified in the vars parameter in such a way that each observation can be associated with one or more levels of the union of the levels of the classification variables.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - getPolynomial
```
public Polynomial[] getPolynomial()
```
  - getPoly
```
public Polynomial[] getPoly()
```
  - setPolynomial
```
public UnsuperOptions setPolynomial(Polynomial[] value)
```
    Sets the value of parameter 'polynomial': specifies a polynomial effect. All specified variables must be numeric. A design matrix column is generated for each term of the specified polynomial. By default, each of these terms is treated as a separate effect for the purpose of model building.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setPoly
```
public UnsuperOptions setPoly(Polynomial[] value)
```
  - getInputs
```
public Casinvardesc[] getInputs()
```
  - getInput
```
public Casinvardesc[] getInput()
```
  - setInputs
```
public UnsuperOptions setInputs(Casinvardesc[] value)
```
    Sets the value of parameter 'inputs': specifies variables to use for analysis.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setInput
```
public UnsuperOptions setInput(Casinvardesc[] value)
```
  - getNominals
```
public Casinvardesc[] getNominals()
```
  - getNominal
```
public Casinvardesc[] getNominal()
```
  - setNominals
```
public UnsuperOptions setNominals(Casinvardesc[] value)
```
    Sets the value of parameter 'nominals': specifies nominal variables to use for analysis.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setNominal
```
public UnsuperOptions setNominal(Casinvardesc[] value)
```
  - getAttributes
```
public Casinvardesc[] getAttributes()
```
  - getAttribute
```
public Casinvardesc[] getAttribute()
```
  - setAttributes
```
public UnsuperOptions setAttributes(Casinvardesc[] value)
```
    Sets the value of parameter 'attributes': alters attributes on variables used in this action.
    
    Parameters:
    
    value - The value
    
    Returns:
    
    The options object
  - setAttribute
```
public UnsuperOptions setAttribute(Casinvardesc[] value)
```

Class UnsuperOptions

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

ACTION_SET_NAME

ACTION_NAME

KEY_TABLE

KEY_FREQ

KEY_OUTPUTTABLES

KEY_DISPLAY

KEY_CLASS

KEY_CLASSGLOBALOPTS

KEY_MODEL

KEY_OUTCP

KEY_TECH

KEY_MAXSTEPS

KEY_MAXEFFECTS

KEY_VAREXP

KEY_VARINC

KEY_COLLECTION

KEY_MULTIMEMBER

KEY_POLYNOMIAL

KEY_INPUTS

KEY_NOMINALS

KEY_ATTRIBUTES

Constructor Detail

UnsuperOptions

UnsuperOptions

Method Detail

getServerDefaultValue

getTable

setTable

getFreq

setFreq

getOutputTables

setOutputTables

getDisplay

setDisplay

getClassParameter

getClassVars

setClassParameter

setClassVars

getClassglobalopts

setClassglobalopts

getModel

setModel

getOutcp

setOutcp

getTech

setTech

getMaxsteps

setMaxsteps

getMaxeffects

setMaxeffects

getVarexp

setVarexp

getVarinc

setVarinc

getCollection

setCollection

getMultimember

setMultimember

getPolynomial

getPoly

setPolynomial

setPoly

getInputs

getInput

setInputs

setInput

getNominals

getNominal