com.sas.cas.actions.dataPreprocess

Class KdeRequestPackage

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.dataPreprocess.KdeRequestPackage

All Implemented Interfaces:

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

public class KdeRequestPackage
extends CASGeneratedActionOptions

Options for kde: Computes kernel density estimation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KdeRequestPackage.KERNEL
static class	KdeRequestPackage.METHOD
static class	KdeRequestPackage.OUTLIERMETHOD
static class	KdeRequestPackage.OUTLIERTREATMENT
static class	KdeRequestPackage.SCALETYPE

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_ALLSCALETYPES
static java.lang.String	KEY_BANDWIDTHOPTS
static java.lang.String	KEY_BOUNDARYEFFECTS
static java.lang.String	KEY_DIMENSION
static java.lang.String	KEY_GRID
static java.lang.String	KEY_HISTOGRAMARGUMENTS
static java.lang.String	KEY_KERNEL
static java.lang.String	KEY_METHOD
static java.lang.String	KEY_OUTLIERARGUMENTS
static java.lang.String	KEY_OUTLIERMETHOD
static java.lang.String	KEY_OUTLIERTREATMENT
static java.lang.String	KEY_SCALETYPE
static java.lang.String	KEY_VARTUPLES

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllScaleTypes()
KdeBandwidthOptions	getBandwidthOpts()
KdeBoundaryEffects	getBoundaryEffects()
java.lang.Integer	getDim()
java.lang.Integer	getDimension()
KdeGrid	getGrid()
KdeGrid	getGridSpec()
KdeOverlayHistogramArguments	getHistogramArguments()
KdeRequestPackage.KERNEL	getKernel()
KdeRequestPackage.METHOD	getMethod()
OutlierArguments	getOutlierArguments()
KdeRequestPackage.OUTLIERMETHOD	getOutlierMethod()
KdeRequestPackage.OUTLIERTREATMENT	getOutlierTreatment()
KdeRequestPackage.SCALETYPE	getScaleType()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
KdeVarTuple	getVarsTuples()
KdeVarTuple	getVarTuples()
KdeRequestPackage	setAllScaleTypes(java.lang.Boolean value) Sets the value of parameter 'allScaleTypes': when set to True, computes all scale estimates.
KdeRequestPackage	setBandwidthOpts(KdeBandwidthOptions value) Sets the value of parameter 'bandwidthOpts': specifies the options for the bandwidth computation.
KdeRequestPackage	setBoundaryEffects(KdeBoundaryEffects value) Sets the value of parameter 'boundaryEffects': specifies the options for the boundary effects.
KdeRequestPackage	setDim(java.lang.Integer value)
KdeRequestPackage	setDimension(java.lang.Integer value) Sets the value of parameter 'dimension': specifies the KDE dimension.
KdeRequestPackage	setGrid(KdeGrid value) Sets the value of parameter 'grid': specifies the options for the grid determination.
KdeRequestPackage	setGridSpec(KdeGrid value)
KdeRequestPackage	setHistogramArguments(KdeOverlayHistogramArguments value) Sets the value of parameter 'histogramArguments': specifies the options for the overlay histogram.
KdeRequestPackage	setKernel(KdeRequestPackage.KERNEL value) Sets the value of parameter 'kernel': specifies the kernel type to use for the KDE computation.
KdeRequestPackage	setMethod(KdeRequestPackage.METHOD value) Sets the value of parameter 'method': specifies the method to use for the KDE computation.
KdeRequestPackage	setOutlierArguments(OutlierArguments value) Sets the value of parameter 'outlierArguments': specifies the outlier definition and treatment.
KdeRequestPackage	setOutlierMethod(KdeRequestPackage.OUTLIERMETHOD value) Sets the value of parameter 'outlierMethod': specifies the outlier definition method.
KdeRequestPackage	setOutlierTreatment(KdeRequestPackage.OUTLIERTREATMENT value) Sets the value of parameter 'outlierTreatment': specifies how to treat outliers.
KdeRequestPackage	setScaleType(KdeRequestPackage.SCALETYPE value) Sets the value of parameter 'scaleType': specifies how to present the results.
KdeRequestPackage	setVarsTuples(KdeVarTuple value)
KdeRequestPackage	setVarTuples(KdeVarTuple value) Sets the value of parameter 'varTuples': specifies how to construct the variable tuples for which the KDE is computed.

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_DIMENSION

public static final java.lang.String KEY_DIMENSION

See Also:

Constant Field Values

KEY_VARTUPLES

public static final java.lang.String KEY_VARTUPLES

See Also:

Constant Field Values

KEY_METHOD

public static final java.lang.String KEY_METHOD

See Also:

Constant Field Values

KEY_KERNEL

public static final java.lang.String KEY_KERNEL

See Also:

Constant Field Values

KEY_BANDWIDTHOPTS

public static final java.lang.String KEY_BANDWIDTHOPTS

See Also:

Constant Field Values

KEY_GRID

public static final java.lang.String KEY_GRID

See Also:

Constant Field Values

KEY_BOUNDARYEFFECTS

public static final java.lang.String KEY_BOUNDARYEFFECTS

See Also:

Constant Field Values

KEY_SCALETYPE

public static final java.lang.String KEY_SCALETYPE

See Also:

Constant Field Values

KEY_ALLSCALETYPES

public static final java.lang.String KEY_ALLSCALETYPES

See Also:

Constant Field Values

KEY_HISTOGRAMARGUMENTS

public static final java.lang.String KEY_HISTOGRAMARGUMENTS

See Also:

Constant Field Values

KEY_OUTLIERMETHOD

public static final java.lang.String KEY_OUTLIERMETHOD

See Also:

Constant Field Values

KEY_OUTLIERTREATMENT

public static final java.lang.String KEY_OUTLIERTREATMENT

See Also:

Constant Field Values

KEY_OUTLIERARGUMENTS

public static final java.lang.String KEY_OUTLIERARGUMENTS

See Also:

Constant Field Values

Constructor Detail

KdeRequestPackage

public KdeRequestPackage()

KdeRequestPackage

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

getDimension

public java.lang.Integer getDimension()

getDim

public java.lang.Integer getDim()

setDimension

public KdeRequestPackage setDimension(java.lang.Integer value)

Sets the value of parameter 'dimension': specifies the KDE dimension.

Parameters:

value - The value

Returns:

The options object

setDim

public KdeRequestPackage setDim(java.lang.Integer value)

getVarTuples

public KdeVarTuple getVarTuples()

getVarsTuples

public KdeVarTuple getVarsTuples()

setVarTuples

public KdeRequestPackage setVarTuples(KdeVarTuple value)

Sets the value of parameter 'varTuples': specifies how to construct the variable tuples for which the KDE is computed.

Parameters:

value - The value

Returns:

The options object

setVarsTuples

public KdeRequestPackage setVarsTuples(KdeVarTuple value)

getMethod

public KdeRequestPackage.METHOD getMethod()

setMethod

public KdeRequestPackage setMethod(KdeRequestPackage.METHOD value)

Sets the value of parameter 'method': specifies the method to use for the KDE computation. The server default is METHOD.BRUTEFORCE.

Parameters:

value - The value

Returns:

The options object

getKernel

public KdeRequestPackage.KERNEL getKernel()

setKernel

public KdeRequestPackage setKernel(KdeRequestPackage.KERNEL value)

Sets the value of parameter 'kernel': specifies the kernel type to use for the KDE computation. The server default is KERNEL.BIWEIGHT.

Parameters:

value - The value

Returns:

The options object

getBandwidthOpts

public KdeBandwidthOptions getBandwidthOpts()

setBandwidthOpts

public KdeRequestPackage setBandwidthOpts(KdeBandwidthOptions value)

Sets the value of parameter 'bandwidthOpts': specifies the options for the bandwidth computation.

Parameters:

value - The value

Returns:

The options object

getGrid

public KdeGrid getGrid()

getGridSpec

public KdeGrid getGridSpec()

setGrid

public KdeRequestPackage setGrid(KdeGrid value)

Sets the value of parameter 'grid': specifies the options for the grid determination.

Parameters:

value - The value

Returns:

The options object

setGridSpec

public KdeRequestPackage setGridSpec(KdeGrid value)

getBoundaryEffects

public KdeBoundaryEffects getBoundaryEffects()

setBoundaryEffects

public KdeRequestPackage setBoundaryEffects(KdeBoundaryEffects value)

Sets the value of parameter 'boundaryEffects': specifies the options for the boundary effects.

Parameters:

value - The value

Returns:

The options object

getScaleType

public KdeRequestPackage.SCALETYPE getScaleType()

setScaleType

public KdeRequestPackage setScaleType(KdeRequestPackage.SCALETYPE value)

Sets the value of parameter 'scaleType': specifies how to present the results. PERCENT uses the range [0, 100]. DENSITY and PROPORTION use [0, 1]. The server default is SCALETYPE.DENSITY.

Parameters:

value - The value

Returns:

The options object

getAllScaleTypes

public java.lang.Boolean getAllScaleTypes()

setAllScaleTypes

public KdeRequestPackage setAllScaleTypes(java.lang.Boolean value)

Sets the value of parameter 'allScaleTypes': when set to True, computes all scale estimates. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getHistogramArguments

public KdeOverlayHistogramArguments getHistogramArguments()

setHistogramArguments

public KdeRequestPackage setHistogramArguments(KdeOverlayHistogramArguments value)

Sets the value of parameter 'histogramArguments': specifies the options for the overlay histogram.

Parameters:

value - The value

Returns:

The options object

getOutlierMethod

public KdeRequestPackage.OUTLIERMETHOD getOutlierMethod()

setOutlierMethod

public KdeRequestPackage setOutlierMethod(KdeRequestPackage.OUTLIERMETHOD value)

Sets the value of parameter 'outlierMethod': specifies the outlier definition method. The server default is OUTLIERMETHOD.IQR.

Parameters:

value - The value

Returns:

The options object

getOutlierTreatment

public KdeRequestPackage.OUTLIERTREATMENT getOutlierTreatment()

setOutlierTreatment

public KdeRequestPackage setOutlierTreatment(KdeRequestPackage.OUTLIERTREATMENT value)

Sets the value of parameter 'outlierTreatment': specifies how to treat outliers. The server default is OUTLIERTREATMENT.REPLACE.

Parameters:

value - The value

Returns:

The options object

getOutlierArguments

public OutlierArguments getOutlierArguments()

setOutlierArguments

public KdeRequestPackage setOutlierArguments(OutlierArguments value)

Sets the value of parameter 'outlierArguments': specifies the outlier definition and treatment.

Parameters:

value - The value

Returns:

The options object