com.sas.cas.actions.sgComp

Class FitNormalOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.sgComp.FitNormalOptions

All Implemented Interfaces:

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

public class FitNormalOptions
extends CASGeneratedActionOptions

Options for fitNormal: Fits normal distribution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FitNormalOptions.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	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_FREQ
static java.lang.String	KEY_GROUPBYLIMIT
static java.lang.String	KEY_INCLUDEMISSGROUP
static java.lang.String	KEY_INCREMENT
static java.lang.String	KEY_LOWERBOUND
static java.lang.String	KEY_MAXPOINTS
static java.lang.String	KEY_MU
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_SCALETYPE
static java.lang.String	KEY_SIGMA
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_UPPERBOUND
static java.lang.String	KEY_WEIGHT
static java.lang.String	KEY_X

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

Method Summary

Modifier and Type	Method and Description
DisplayTables	getDisplay()
java.lang.String	getFreq()
java.lang.Long	getGroupbyLimit()
java.lang.Boolean	getIncludeMissGroup()
java.lang.Double	getIncrement()
java.lang.Double	getLowerBound()
java.lang.Integer	getMaxPoints()
java.lang.Double	getMu()
OutputTables	getOutputTables()
FitNormalOptions.SCALETYPE	getScaleType()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Double	getSigma()
Castable	getTable()
java.lang.Double	getUpperBound()
java.lang.String	getWeight()
java.lang.String	getX()
FitNormalOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
FitNormalOptions	setFreq(java.lang.String value) Sets the value of parameter 'freq': specifies the frequency variable.
FitNormalOptions	setGroupbyLimit(java.lang.Long value) Sets the value of parameter 'groupbyLimit'.
FitNormalOptions	setIncludeMissGroup(java.lang.Boolean value) Sets the value of parameter 'includeMissGroup': requests observations that have missing values for group-by variables are included in the analysis.
FitNormalOptions	setIncrement(java.lang.Double value) Sets the value of parameter 'increment': specifies the bin width for fitting.
FitNormalOptions	setLowerBound(java.lang.Double value) Sets the value of parameter 'lowerBound': specifies the lower bound of range to fit.
FitNormalOptions	setMaxPoints(java.lang.Integer value) Sets the value of parameter 'maxPoints': specifies the maximum number of points on the density curve.
FitNormalOptions	setMu(java.lang.Double value) Sets the value of parameter 'mu': specifies the mean for normal distribution.
FitNormalOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
FitNormalOptions	setScaleType(FitNormalOptions.SCALETYPE value) Sets the value of parameter 'scaleType': specifies the vertical axis scaling type.
FitNormalOptions	setSigma(java.lang.Double value) Sets the value of parameter 'sigma': specifies the standard deviation for normal distribution.
FitNormalOptions	setTable(Castable value) Sets the value of parameter 'table': specifies the settings for an input table.
FitNormalOptions	setUpperBound(java.lang.Double value) Sets the value of parameter 'upperBound': specifies the upper bound of range to fit.
FitNormalOptions	setWeight(java.lang.String value) Sets the value of parameter 'weight': specifies the weight variable.
FitNormalOptions	setX(java.lang.String value) Sets the value of parameter 'x': specifies the analysis variable x.

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_GROUPBYLIMIT

public static final java.lang.String KEY_GROUPBYLIMIT

See Also:

Constant Field Values

KEY_DISPLAY

public static final java.lang.String KEY_DISPLAY

See Also:

Constant Field Values

KEY_OUTPUTTABLES

public static final java.lang.String KEY_OUTPUTTABLES

See Also:

Constant Field Values

KEY_X

public static final java.lang.String KEY_X

See Also:

Constant Field Values

KEY_FREQ

public static final java.lang.String KEY_FREQ

See Also:

Constant Field Values

KEY_WEIGHT

public static final java.lang.String KEY_WEIGHT

See Also:

Constant Field Values

KEY_MAXPOINTS

public static final java.lang.String KEY_MAXPOINTS

See Also:

Constant Field Values

KEY_INCREMENT

public static final java.lang.String KEY_INCREMENT

See Also:

Constant Field Values

KEY_LOWERBOUND

public static final java.lang.String KEY_LOWERBOUND

See Also:

Constant Field Values

KEY_UPPERBOUND

public static final java.lang.String KEY_UPPERBOUND

See Also:

Constant Field Values

KEY_SCALETYPE

public static final java.lang.String KEY_SCALETYPE

See Also:

Constant Field Values

KEY_INCLUDEMISSGROUP

public static final java.lang.String KEY_INCLUDEMISSGROUP

See Also:

Constant Field Values

KEY_MU

public static final java.lang.String KEY_MU

See Also:

Constant Field Values

KEY_SIGMA

public static final java.lang.String KEY_SIGMA

See Also:

Constant Field Values

Constructor Detail

FitNormalOptions

public FitNormalOptions()

FitNormalOptions

public FitNormalOptions(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 FitNormalOptions setTable(Castable value)

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

Parameters:

value - The value

Returns:

The options object

getGroupbyLimit

public java.lang.Long getGroupbyLimit()

setGroupbyLimit

public FitNormalOptions setGroupbyLimit(java.lang.Long value)

Sets the value of parameter 'groupbyLimit'. The server default is INT64_MAX.

Parameters:

value - The value

Returns:

The options object

getDisplay

public DisplayTables getDisplay()

setDisplay

public FitNormalOptions 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

getOutputTables

public OutputTables getOutputTables()

setOutputTables

public FitNormalOptions 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

getX

public java.lang.String getX()

setX

public FitNormalOptions setX(java.lang.String value)

Sets the value of parameter 'x': specifies the analysis variable x.

Parameters:

value - The value

Returns:

The options object

getFreq

public java.lang.String getFreq()

setFreq

public FitNormalOptions setFreq(java.lang.String value)

Sets the value of parameter 'freq': specifies the frequency variable.

Parameters:

value - The value

Returns:

The options object

getWeight

public java.lang.String getWeight()

setWeight

public FitNormalOptions setWeight(java.lang.String value)

Sets the value of parameter 'weight': specifies the weight variable.

Parameters:

value - The value

Returns:

The options object

getMaxPoints

public java.lang.Integer getMaxPoints()

setMaxPoints

public FitNormalOptions setMaxPoints(java.lang.Integer value)

Sets the value of parameter 'maxPoints': specifies the maximum number of points on the density curve. The server default is 200.

Parameters:

value - The value

Returns:

The options object

getIncrement

public java.lang.Double getIncrement()

setIncrement

public FitNormalOptions setIncrement(java.lang.Double value)

Sets the value of parameter 'increment': specifies the bin width for fitting. The value should be specified to ensure that the area under the density curve will be the same as that of the histogram on which it is overlaid, if the curve is to be scaled. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getLowerBound

public java.lang.Double getLowerBound()

setLowerBound

public FitNormalOptions setLowerBound(java.lang.Double value)

Sets the value of parameter 'lowerBound': specifies the lower bound of range to fit. If not specified, it is calculated from the data. The value should be specified to ensure that the ranges of the histogram and density curve match.

Parameters:

value - The value

Returns:

The options object

getUpperBound

public java.lang.Double getUpperBound()

setUpperBound

public FitNormalOptions setUpperBound(java.lang.Double value)

Sets the value of parameter 'upperBound': specifies the upper bound of range to fit. If not specified, it is calculated from the data. The value should be specified to ensure that the ranges of the histogram and density curve match.

Parameters:

value - The value

Returns:

The options object

getScaleType

public FitNormalOptions.SCALETYPE getScaleType()

setScaleType

public FitNormalOptions setScaleType(FitNormalOptions.SCALETYPE value)

Sets the value of parameter 'scaleType': specifies the vertical axis scaling type. The server default is SCALETYPE.DENSITY.

Parameters:

value - The value

Returns:

The options object

getIncludeMissGroup

public java.lang.Boolean getIncludeMissGroup()

setIncludeMissGroup

public FitNormalOptions setIncludeMissGroup(java.lang.Boolean value)

Sets the value of parameter 'includeMissGroup': requests observations that have missing values for group-by variables are included in the analysis. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getMu

public java.lang.Double getMu()

setMu

public FitNormalOptions setMu(java.lang.Double value)

Sets the value of parameter 'mu': specifies the mean for normal distribution. If not specified, it is calculated from the data.

Parameters:

value - The value

Returns:

The options object

getSigma

public java.lang.Double getSigma()

setSigma

public FitNormalOptions setSigma(java.lang.Double value)

Sets the value of parameter 'sigma': specifies the standard deviation for normal distribution. If not specified, it is calculated from the data.

Parameters:

value - The value

Returns:

The options object