com.sas.cas.actions.pls

Class OutputOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.pls.OutputOptions

All Implemented Interfaces:

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

public class OutputOptions
extends CASGeneratedActionOptions

Options for pls: Fits models by using any one of a number of linear predictive methods, including partial least squares.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputOptions.COPYVARS

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_CASOUT
static java.lang.String	KEY_COPYVARS
static java.lang.String	KEY_H
static java.lang.String	KEY_PREDICTED
static java.lang.String	KEY_PRESS
static java.lang.String	KEY_ROLE
static java.lang.String	KEY_T2
static java.lang.String	KEY_XRESIDUAL
static java.lang.String	KEY_XSCORE
static java.lang.String	KEY_XSTD
static java.lang.String	KEY_XSTDSSE
static java.lang.String	KEY_YRESIDUAL
static java.lang.String	KEY_YSCORE
static java.lang.String	KEY_YSTD
static java.lang.String	KEY_YSTDSSE

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

Method Summary

Modifier and Type	Method and Description
Casouttable	getCasOut()
java.lang.Object	getCopyVars()
java.lang.String	getH()
java.lang.String	getP()
java.lang.String	getPred()
java.lang.String	getPredicted()
java.lang.String	getPress()
java.lang.String	getRole()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.String	getStdX()
java.lang.String	getStdXsse()
java.lang.String	getStdY()
java.lang.String	getStdYsse()
java.lang.String	getT2()
java.lang.String	getTSquare()
java.lang.String	getXQres()
java.lang.String	getXr()
java.lang.String	getXResid()
java.lang.String	getXResidual()
java.lang.String	getXScore()
java.lang.String	getXStd()
java.lang.String	getXStdsse()
java.lang.String	getYQres()
java.lang.String	getYr()
java.lang.String	getYResid()
java.lang.String	getYResidual()
java.lang.String	getYScore()
java.lang.String	getYStd()
java.lang.String	getYStdsse()
OutputOptions	setCasOut(Casouttable value) Sets the value of parameter 'casOut': specifies the settings for an output table.
OutputOptions	setCopyVars(OutputOptions.COPYVARS value) Sets the value of parameter 'copyVars' for alternative 1.
OutputOptions	setCopyVars(java.lang.String[] value) Sets the value of parameter 'copyVars' for alternative 2.
OutputOptions	setH(java.lang.String value) Sets the value of parameter 'h': requests the approximate leverage.
OutputOptions	setP(java.lang.String value)
OutputOptions	setPred(java.lang.String value)
OutputOptions	setPredicted(java.lang.String value) Sets the value of parameter 'predicted': requests predicted values for each response.
OutputOptions	setPress(java.lang.String value) Sets the value of parameter 'press': requests approximate predicted residuals for each response.
OutputOptions	setRole(java.lang.String value) Sets the value of parameter 'role': requests numeric values that indicate the role played by each observation in fitting the model.
OutputOptions	setStdX(java.lang.String value)
OutputOptions	setStdXsse(java.lang.String value)
OutputOptions	setStdY(java.lang.String value)
OutputOptions	setStdYsse(java.lang.String value)
OutputOptions	setT2(java.lang.String value) Sets the value of parameter 't2': requests scaled sum of squares of score values.
OutputOptions	setTSquare(java.lang.String value)
OutputOptions	setXQres(java.lang.String value)
OutputOptions	setXr(java.lang.String value)
OutputOptions	setXResid(java.lang.String value)
OutputOptions	setXResidual(java.lang.String value) Sets the value of parameter 'xResidual': requests residuals for each predictor.
OutputOptions	setXScore(java.lang.String value) Sets the value of parameter 'xScore': requests extracted factors (X-scores, latent vectors, latent variables, T) for each selected model factor.
OutputOptions	setXStd(java.lang.String value) Sets the value of parameter 'xStd': requests standardized (centered and scaled) predictor values for each predictor.
OutputOptions	setXStdsse(java.lang.String value) Sets the value of parameter 'xStdsse': requests the sum of squares of residuals for standardized predictors.
OutputOptions	setYQres(java.lang.String value)
OutputOptions	setYr(java.lang.String value)
OutputOptions	setYResid(java.lang.String value)
OutputOptions	setYResidual(java.lang.String value) Sets the value of parameter 'yResidual': requests residuals for each response.
OutputOptions	setYScore(java.lang.String value) Sets the value of parameter 'yScore': requests extracted responses (Y-scores, U) for each selected model factor.
OutputOptions	setYStd(java.lang.String value) Sets the value of parameter 'yStd': requests standardized (centered and scaled) response values for each response.
OutputOptions	setYStdsse(java.lang.String value) Sets the value of parameter 'yStdsse': requests the sum of squares of residuals for standardized responses.

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_CASOUT

public static final java.lang.String KEY_CASOUT

See Also:

Constant Field Values

KEY_COPYVARS

public static final java.lang.String KEY_COPYVARS

See Also:

Constant Field Values

KEY_PREDICTED

public static final java.lang.String KEY_PREDICTED

See Also:

Constant Field Values

KEY_XRESIDUAL

public static final java.lang.String KEY_XRESIDUAL

See Also:

Constant Field Values

KEY_YRESIDUAL

public static final java.lang.String KEY_YRESIDUAL

See Also:

Constant Field Values

KEY_XSCORE

public static final java.lang.String KEY_XSCORE

See Also:

Constant Field Values

KEY_YSCORE

public static final java.lang.String KEY_YSCORE

See Also:

Constant Field Values

KEY_XSTD

public static final java.lang.String KEY_XSTD

See Also:

Constant Field Values

KEY_YSTD

public static final java.lang.String KEY_YSTD

See Also:

Constant Field Values

KEY_XSTDSSE

public static final java.lang.String KEY_XSTDSSE

See Also:

Constant Field Values

KEY_YSTDSSE

public static final java.lang.String KEY_YSTDSSE

See Also:

Constant Field Values

KEY_H

public static final java.lang.String KEY_H

See Also:

Constant Field Values

KEY_PRESS

public static final java.lang.String KEY_PRESS

See Also:

Constant Field Values

KEY_T2

public static final java.lang.String KEY_T2

See Also:

Constant Field Values

KEY_ROLE

public static final java.lang.String KEY_ROLE

See Also:

Constant Field Values

Constructor Detail

OutputOptions

public OutputOptions()

OutputOptions

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

getCasOut

public Casouttable getCasOut()

setCasOut

public OutputOptions setCasOut(Casouttable value)

Sets the value of parameter 'casOut': specifies the settings for an output table.

Parameters:

value - The value

Returns:

The options object

getCopyVars

public java.lang.Object getCopyVars()

setCopyVars

public OutputOptions setCopyVars(OutputOptions.COPYVARS value)

Sets the value of parameter 'copyVars' for alternative 1. The server default is COPYVARS.ALL_MODEL.

Parameters:

value - The value

Returns:

The options object

setCopyVars

public OutputOptions setCopyVars(java.lang.String[] value)

Sets the value of parameter 'copyVars' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getPredicted

public java.lang.String getPredicted()

getP

public java.lang.String getP()

getPred

public java.lang.String getPred()

setPredicted

public OutputOptions setPredicted(java.lang.String value)

Sets the value of parameter 'predicted': requests predicted values for each response. If set to an empty string, the prefix Pred is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

setP

public OutputOptions setP(java.lang.String value)

setPred

public OutputOptions setPred(java.lang.String value)

getXResidual

public java.lang.String getXResidual()

getXr

public java.lang.String getXr()

getXResid

public java.lang.String getXResid()

setXResidual

public OutputOptions setXResidual(java.lang.String value)

Sets the value of parameter 'xResidual': requests residuals for each predictor. If set to an empty string, the prefix XResid is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

setXr

public OutputOptions setXr(java.lang.String value)

setXResid

public OutputOptions setXResid(java.lang.String value)

getYResidual

public java.lang.String getYResidual()

getYr

public java.lang.String getYr()

getYResid

public java.lang.String getYResid()

setYResidual

public OutputOptions setYResidual(java.lang.String value)

Sets the value of parameter 'yResidual': requests residuals for each response. If set to an empty string, the prefix YResid is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

setYr

public OutputOptions setYr(java.lang.String value)

setYResid

public OutputOptions setYResid(java.lang.String value)

getXScore

public java.lang.String getXScore()

setXScore

public OutputOptions setXScore(java.lang.String value)

Sets the value of parameter 'xScore': requests extracted factors (X-scores, latent vectors, latent variables, T) for each selected model factor. If set to an empty string, the prefix XScore is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

getYScore

public java.lang.String getYScore()

setYScore

public OutputOptions setYScore(java.lang.String value)

Sets the value of parameter 'yScore': requests extracted responses (Y-scores, U) for each selected model factor. If set to an empty string, the prefix YScore is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

getXStd

public java.lang.String getXStd()

getStdX

public java.lang.String getStdX()

setXStd

public OutputOptions setXStd(java.lang.String value)

Sets the value of parameter 'xStd': requests standardized (centered and scaled) predictor values for each predictor. If set to an empty string, the prefix StdX is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

setStdX

public OutputOptions setStdX(java.lang.String value)

getYStd

public java.lang.String getYStd()

getStdY

public java.lang.String getStdY()

setYStd

public OutputOptions setYStd(java.lang.String value)

Sets the value of parameter 'yStd': requests standardized (centered and scaled) response values for each response. If set to an empty string, the prefix StdY is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

setStdY

public OutputOptions setStdY(java.lang.String value)

getXStdsse

public java.lang.String getXStdsse()

getXQres

public java.lang.String getXQres()

getStdXsse

public java.lang.String getStdXsse()

setXStdsse

public OutputOptions setXStdsse(java.lang.String value)

Sets the value of parameter 'xStdsse': requests the sum of squares of residuals for standardized predictors. If set to an empty string, the prefix StdXSSE is used for naming the output variable.

Parameters:

value - The value

Returns:

The options object

setXQres

public OutputOptions setXQres(java.lang.String value)

setStdXsse

public OutputOptions setStdXsse(java.lang.String value)

getYStdsse

public java.lang.String getYStdsse()

getYQres

public java.lang.String getYQres()

getStdYsse

public java.lang.String getStdYsse()

setYStdsse

public OutputOptions setYStdsse(java.lang.String value)

Sets the value of parameter 'yStdsse': requests the sum of squares of residuals for standardized responses. If set to an empty string, the prefix StdYSSE is used for naming the output variable.

Parameters:

value - The value

Returns:

The options object

setYQres

public OutputOptions setYQres(java.lang.String value)

setStdYsse

public OutputOptions setStdYsse(java.lang.String value)

getH

public java.lang.String getH()

setH

public OutputOptions setH(java.lang.String value)

Sets the value of parameter 'h': requests the approximate leverage. If set to an empty string, the prefix H is used for naming the output variable.

Parameters:

value - The value

Returns:

The options object

getPress

public java.lang.String getPress()

setPress

public OutputOptions setPress(java.lang.String value)

Sets the value of parameter 'press': requests approximate predicted residuals for each response. If set to an empty string, the prefix PRESS is used for naming the output variables.

Parameters:

value - The value

Returns:

The options object

getT2

public java.lang.String getT2()

getTSquare

public java.lang.String getTSquare()

setT2

public OutputOptions setT2(java.lang.String value)

Sets the value of parameter 't2': requests scaled sum of squares of score values. If set to an empty string, the prefix TSquare is used for naming the output variable.

Parameters:

value - The value

Returns:

The options object

setTSquare

public OutputOptions setTSquare(java.lang.String value)

getRole

public java.lang.String getRole()

setRole

public OutputOptions setRole(java.lang.String value)

Sets the value of parameter 'role': requests numeric values that indicate the role played by each observation in fitting the model. If set to an empty string, the prefix _ROLE_ is used for naming the output variable.

Parameters:

value - The value

Returns:

The options object