water.api

Class RequestArguments.FrameClassVec

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

water.api.RequestArguments.InputSelect<Vec>

water.api.RequestArguments.FrameKeyVec

water.api.RequestArguments.FrameClassVec

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Enclosing class:

RequestArguments

public class RequestArguments.FrameClassVec
extends RequestArguments.FrameKeyVec

A Class Vec/Column within a Frame. Limited to 1000 classes, just to prevent madness.

Field Summary

Fields inherited from class water.api.RequestArguments.FrameKeyVec

_colIdx

Fields inherited from class water.api.RequestArguments.Argument

_displayName, _field, _gridable, _hideInQuery, _mustExist, _name, _prerequisites, _readOnly, _requestHelp, _required, _validator

Constructor Summary

Constructors

Constructor and Description
RequestArguments.FrameClassVec(java.lang.String name, Request2.TypeaheadKey key)

Method Summary

Methods

Modifier and Type	Method and Description
protected Vec	defaultValue() Returns the default value of the argument.
protected java.lang.String[]	selectValues() Override this method to provide the values for the options.

Methods inherited from class water.api.RequestArguments.FrameKeyVec

errors, fr, parse, queryDescription, selectedItemValue

Methods inherited from class water.api.RequestArguments.InputSelect

jsRefresh, jsValue, queryElement, selectNames

Methods inherited from class water.api.RequestArguments.Argument

addPrerequisite, check, disable, disable, disabled, getDisplayName, getName, jsAddons, originalValue, query, queryAddons, queryComment, record, refreshOnChange, requestHelp, reset, run, setRefreshOnChange, specified, valid, value

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON, writeJSONFields

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestArguments.FrameClassVec

public RequestArguments.FrameClassVec(java.lang.String name,
                              Request2.TypeaheadKey key)

Method Detail

selectValues

protected java.lang.String[] selectValues()

Description copied from class: RequestArguments.InputSelect

Override this method to provide the values for the options. These will be the possible values returned by the form's input and should be the possible values for the JSON argument.

Overrides:

selectValues in class RequestArguments.FrameKeyVec

defaultValue

protected Vec defaultValue()

Description copied from class: RequestArguments.Argument

Returns the default value of the argument. Note that the method will be called also on required arguments, in which case it is ok return null. It is kept abstract because defining a proper default value might be tricky and in many case you do not want it to be null. Overriding it always makes you think:)

Overrides:

defaultValue in class RequestArguments.FrameKeyVec