water.api

Class RequestArguments.FrameKeyMultiVec

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

water.api.RequestArguments.MultipleSelect<int[]>

water.api.RequestArguments.FrameKeyMultiVec

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Enclosing class:

RequestArguments

public class RequestArguments.FrameKeyMultiVec
extends RequestArguments.MultipleSelect<int[]>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.ThreadLocal<java.lang.Integer>	_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.FrameKeyMultiVec(java.lang.String name, Request2.TypeaheadKey key, RequestArguments.FrameClassVec response, java.lang.String description, boolean namesOnly, boolean filterNAs)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkLegality(Vec v)
protected java.util.Comparator<java.lang.Integer>	colComp(ValueArray ary)
protected int[]	defaultValue() Returns the default value of the argument.
protected Frame	fr()
protected boolean	isSelected(java.lang.String value) Returns true if the given option (by its value) is selected.
protected int[]	parse(java.lang.String input) Override this method to provide parsing of the input string to the Java expected value.
protected java.lang.String	queryDescription() Returns the query description.
protected java.lang.String	queryElement() Displays the query element.
protected java.lang.String[]	selectNames() Override this method to determine the value names, that is the names displayed in the browser.
protected java.lang.String[]	selectValues() Override this method to provide the values for the options.
void	setResponse(RequestArguments.FrameClassVec response)
boolean	shouldIgnore(int i, Frame fr)

Methods inherited from class water.api.RequestArguments.MultipleSelect

jsRefresh, jsValue

Methods inherited from class water.api.RequestArguments.Argument

addPrerequisite, check, disable, disable, disabled, errors, 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

Field Detail

_colIdx

protected transient java.lang.ThreadLocal<java.lang.Integer> _colIdx

Constructor Detail

RequestArguments.FrameKeyMultiVec

public RequestArguments.FrameKeyMultiVec(java.lang.String name,
                                 Request2.TypeaheadKey key,
                                 RequestArguments.FrameClassVec response,
                                 java.lang.String description,
                                 boolean namesOnly,
                                 boolean filterNAs)

Method Detail

fr

protected Frame fr()

setResponse

public void setResponse(RequestArguments.FrameClassVec response)

shouldIgnore

public boolean shouldIgnore(int i,
                   Frame fr)

checkLegality

public void checkLegality(Vec v)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

colComp

protected java.util.Comparator<java.lang.Integer> colComp(ValueArray ary)

queryElement

protected java.lang.String queryElement()

Description copied from class: RequestArguments.MultipleSelect

Displays the query element. It is a tabled list of all possibilities with an optional scrollbar on the right.

Overrides:

queryElement in class RequestArguments.MultipleSelect<int[]>

selectValues

protected final java.lang.String[] selectValues()

Description copied from class: RequestArguments.MultipleSelect

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.

Specified by:

selectValues in class RequestArguments.MultipleSelect<int[]>

selectNames

protected java.lang.String[] selectNames()

Description copied from class: RequestArguments.MultipleSelect

Override this method to determine the value names, that is the names displayed in the browser. Return null, if the value strings should be used (this is default behavior).

Overrides:

selectNames in class RequestArguments.MultipleSelect<int[]>

isSelected

protected boolean isSelected(java.lang.String value)

Description copied from class: RequestArguments.MultipleSelect

Returns true if the given option (by its value) is selected. False otherwise.

Specified by:

isSelected in class RequestArguments.MultipleSelect<int[]>

parse

protected int[] parse(java.lang.String input)
               throws java.lang.IllegalArgumentException

Description copied from class: RequestArguments.Argument

Override this method to provide parsing of the input string to the Java expected value. The input is guaranteed to be non-empty when this method is called and all prerequisities are guaranteed to be valid before this method is called.

Specified by:

parse in class RequestArguments.Argument<int[]>

Throws:

java.lang.IllegalArgumentException

defaultValue

protected int[] 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:)

Specified by:

defaultValue in class RequestArguments.Argument<int[]>

queryDescription

protected java.lang.String queryDescription()

Description copied from class: RequestArguments.Argument

Returns the query description. This is a concise description of a correct value for the argument. generally used as a placeholder in the html query elements.

Specified by:

queryDescription in class RequestArguments.Argument<int[]>