com.sas.cas.actions.dataPreprocess

Class FunctionArguments

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.dataPreprocess.FunctionArguments

All Implemented Interfaces:

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

public class FunctionArguments
extends CASGeneratedActionOptions

Options for transform: Performs pipelined variable imputation, outlier detection and treatment, functional transformation, binning, and robust univariate statistics to evaluate the quality of the transformation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FunctionArguments.LOCATION
static class	FunctionArguments.SCALE

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_AADLOCATIONUSEMEAN
static java.lang.String	KEY_LOCATION
static java.lang.String	KEY_LOCATIONBIWEIGHTTUNING
static java.lang.String	KEY_LOWERPERCENTILE
static java.lang.String	KEY_OTHERARGUMENTS
static java.lang.String	KEY_SCALE
static java.lang.String	KEY_SCALEBIWEIGHTTUNING
static java.lang.String	KEY_SCALEMULTIPLIER
static java.lang.String	KEY_SHIFTPOSITIVE
static java.lang.String	KEY_SYMMETRICPERCENTILE
static java.lang.String	KEY_UPPERPERCENTILE

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAadLocationUseMean()
java.lang.Boolean	getAadLocUseMean()
FunctionArguments.LOCATION	getLocation()
java.lang.Double	getLocationBiweightTuning()
java.lang.Double	getLocBiweightTuning()
java.lang.Double	getLowerPerc()
java.lang.Double	getLowerPercentile()
java.lang.Double[]	getOtherArgs()
java.lang.Double[]	getOtherArguments()
FunctionArguments.SCALE	getScale()
java.lang.Double	getScaleBiweightTuning()
java.lang.Double	getScaleMulFac()
java.lang.Double	getScaleMultiplier()
java.lang.Double	getSclBiweightTuning()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Double	getShiftPositive()
java.lang.Double	getSymmetricPercentile()
java.lang.Double	getSymPerc()
java.lang.Double	getUpperPerc()
java.lang.Double	getUpperPercentile()
FunctionArguments	setAadLocationUseMean(java.lang.Boolean value) Sets the value of parameter 'aadLocationUseMean': when set to True, the mean is used, instead of the median, as the center for the absolute average deviation (AAD) scale estimator.
FunctionArguments	setAadLocUseMean(java.lang.Boolean value)
FunctionArguments	setLocation(FunctionArguments.LOCATION value) Sets the value of parameter 'location': specifies the estimation method of location.
FunctionArguments	setLocationBiweightTuning(java.lang.Double value) Sets the value of parameter 'locationBiweightTuning': specifies the tuning factor for the Tukey biweight location estimator.
FunctionArguments	setLocBiweightTuning(java.lang.Double value)
FunctionArguments	setLowerPerc(java.lang.Double value)
FunctionArguments	setLowerPercentile(java.lang.Double value) Sets the value of parameter 'lowerPercentile': specifies the lower percentile threshold (PERC outlier definition).
FunctionArguments	setOtherArgs(java.lang.Double[] value)
FunctionArguments	setOtherArguments(java.lang.Double[] value) Sets the value of parameter 'otherArguments': specifies other values to use.
FunctionArguments	setScale(FunctionArguments.SCALE value) Sets the value of parameter 'scale': specifies the scale method to use.
FunctionArguments	setScaleBiweightTuning(java.lang.Double value) Sets the value of parameter 'scaleBiweightTuning': specifies the tuning factor for the Tukey biweight scale estimator.
FunctionArguments	setScaleMulFac(java.lang.Double value)
FunctionArguments	setScaleMultiplier(java.lang.Double value) Sets the value of parameter 'scaleMultiplier': specifies the multiplying factor for the chosen scale estimator.
FunctionArguments	setSclBiweightTuning(java.lang.Double value)
FunctionArguments	setShiftPositive(java.lang.Double value) Sets the value of parameter 'shiftPositive': specifies that the argument be shifted to positive value by subtracting the minimum and adding the shiftPositive value.
FunctionArguments	setSymmetricPercentile(java.lang.Double value) Sets the value of parameter 'symmetricPercentile': specifies the symmetric percentile threshold to use.
FunctionArguments	setSymPerc(java.lang.Double value)
FunctionArguments	setUpperPerc(java.lang.Double value)
FunctionArguments	setUpperPercentile(java.lang.Double value) Sets the value of parameter 'upperPercentile': specifies the upper percentile threshold to use.

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_SHIFTPOSITIVE

public static final java.lang.String KEY_SHIFTPOSITIVE

See Also:

Constant Field Values

KEY_LOCATION

public static final java.lang.String KEY_LOCATION

See Also:

Constant Field Values

KEY_SCALE

public static final java.lang.String KEY_SCALE

See Also:

Constant Field Values

KEY_LOWERPERCENTILE

public static final java.lang.String KEY_LOWERPERCENTILE

See Also:

Constant Field Values

KEY_UPPERPERCENTILE

public static final java.lang.String KEY_UPPERPERCENTILE

See Also:

Constant Field Values

KEY_SYMMETRICPERCENTILE

public static final java.lang.String KEY_SYMMETRICPERCENTILE

See Also:

Constant Field Values

KEY_SCALEMULTIPLIER

public static final java.lang.String KEY_SCALEMULTIPLIER

See Also:

Constant Field Values

KEY_LOCATIONBIWEIGHTTUNING

public static final java.lang.String KEY_LOCATIONBIWEIGHTTUNING

See Also:

Constant Field Values

KEY_SCALEBIWEIGHTTUNING

public static final java.lang.String KEY_SCALEBIWEIGHTTUNING

See Also:

Constant Field Values

KEY_AADLOCATIONUSEMEAN

public static final java.lang.String KEY_AADLOCATIONUSEMEAN

See Also:

Constant Field Values

KEY_OTHERARGUMENTS

public static final java.lang.String KEY_OTHERARGUMENTS

See Also:

Constant Field Values

Constructor Detail

FunctionArguments

public FunctionArguments()

FunctionArguments

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

getShiftPositive

public java.lang.Double getShiftPositive()

setShiftPositive

public FunctionArguments setShiftPositive(java.lang.Double value)

Sets the value of parameter 'shiftPositive': specifies that the argument be shifted to positive value by subtracting the minimum and adding the shiftPositive value.

Parameters:

value - The value

Returns:

The options object

getLocation

public FunctionArguments.LOCATION getLocation()

setLocation

public FunctionArguments setLocation(FunctionArguments.LOCATION value)

Sets the value of parameter 'location': specifies the estimation method of location. The server default is LOCATION.BIWEIGHT.

Parameters:

value - The value

Returns:

The options object

getScale

public FunctionArguments.SCALE getScale()

setScale

public FunctionArguments setScale(FunctionArguments.SCALE value)

Sets the value of parameter 'scale': specifies the scale method to use. The server default is SCALE.AAD.

Parameters:

value - The value

Returns:

The options object

getLowerPercentile

public java.lang.Double getLowerPercentile()

getLowerPerc

public java.lang.Double getLowerPerc()

setLowerPercentile

public FunctionArguments setLowerPercentile(java.lang.Double value)

Sets the value of parameter 'lowerPercentile': specifies the lower percentile threshold (PERC outlier definition). The server default is 10.

Parameters:

value - The value

Returns:

The options object

setLowerPerc

public FunctionArguments setLowerPerc(java.lang.Double value)

getUpperPercentile

public java.lang.Double getUpperPercentile()

getUpperPerc

public java.lang.Double getUpperPerc()

setUpperPercentile

public FunctionArguments setUpperPercentile(java.lang.Double value)

Sets the value of parameter 'upperPercentile': specifies the upper percentile threshold to use. The server default is 90.

Parameters:

value - The value

Returns:

The options object

setUpperPerc

public FunctionArguments setUpperPerc(java.lang.Double value)

getSymmetricPercentile

public java.lang.Double getSymmetricPercentile()

getSymPerc

public java.lang.Double getSymPerc()

setSymmetricPercentile

public FunctionArguments setSymmetricPercentile(java.lang.Double value)

Sets the value of parameter 'symmetricPercentile': specifies the symmetric percentile threshold to use. For example, a value of 20 indicates to set a lower percentile to 10 and the upper percentile to 90. The server default is 10.

Parameters:

value - The value

Returns:

The options object

setSymPerc

public FunctionArguments setSymPerc(java.lang.Double value)

getScaleMultiplier

public java.lang.Double getScaleMultiplier()

getScaleMulFac

public java.lang.Double getScaleMulFac()

setScaleMultiplier

public FunctionArguments setScaleMultiplier(java.lang.Double value)

Sets the value of parameter 'scaleMultiplier': specifies the multiplying factor for the chosen scale estimator.

Parameters:

value - The value

Returns:

The options object

setScaleMulFac

public FunctionArguments setScaleMulFac(java.lang.Double value)

getLocationBiweightTuning

public java.lang.Double getLocationBiweightTuning()

getLocBiweightTuning

public java.lang.Double getLocBiweightTuning()

setLocationBiweightTuning

public FunctionArguments setLocationBiweightTuning(java.lang.Double value)

Sets the value of parameter 'locationBiweightTuning': specifies the tuning factor for the Tukey biweight location estimator.

Parameters:

value - The value

Returns:

The options object

setLocBiweightTuning

public FunctionArguments setLocBiweightTuning(java.lang.Double value)

getScaleBiweightTuning

public java.lang.Double getScaleBiweightTuning()

getSclBiweightTuning

public java.lang.Double getSclBiweightTuning()

setScaleBiweightTuning

public FunctionArguments setScaleBiweightTuning(java.lang.Double value)

Sets the value of parameter 'scaleBiweightTuning': specifies the tuning factor for the Tukey biweight scale estimator.

Parameters:

value - The value

Returns:

The options object

setSclBiweightTuning

public FunctionArguments setSclBiweightTuning(java.lang.Double value)

getAadLocationUseMean

public java.lang.Boolean getAadLocationUseMean()

getAadLocUseMean

public java.lang.Boolean getAadLocUseMean()

setAadLocationUseMean

public FunctionArguments setAadLocationUseMean(java.lang.Boolean value)

Sets the value of parameter 'aadLocationUseMean': when set to True, the mean is used, instead of the median, as the center for the absolute average deviation (AAD) scale estimator. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

setAadLocUseMean

public FunctionArguments setAadLocUseMean(java.lang.Boolean value)

getOtherArguments

public java.lang.Double[] getOtherArguments()

getOtherArgs

public java.lang.Double[] getOtherArgs()

setOtherArguments

public FunctionArguments setOtherArguments(java.lang.Double[] value)

Sets the value of parameter 'otherArguments': specifies other values to use. The values depend on the type of functional transformation.

Parameters:

value - The value

Returns:

The options object

setOtherArgs

public FunctionArguments setOtherArgs(java.lang.Double[] value)