water.api

Class RequestArguments.H2OCategoryStrata

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

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

water.api.RequestArguments.H2OCategoryStrata

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Enclosing class:

RequestArguments

public class RequestArguments.H2OCategoryStrata
extends RequestArguments.MultipleText<int[]>

Field Summary

Fields

Modifier and Type	Field and Description
RequestArguments.H2OHexKeyCol	_classCol
int	_defaultValue
RequestArguments.H2OHexKey	_key

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.H2OCategoryStrata(java.lang.String name, RequestArguments.H2OHexKey key, RequestArguments.H2OHexKeyCol classCol, int defaultValue)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,java.lang.Integer>	convertToMap()
protected int[]	defaultValue() Returns the default value of the argument.
protected java.lang.String[]	determineColumnClassNames(int maxClasses)
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[]	textNames()
protected java.lang.String	textSuffix()
protected java.lang.String[]	textValues()

Methods inherited from class water.api.RequestArguments.MultipleText

jsRefresh, jsValue, queryElement, textPrefixes, textSuffixes

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

_key

public final RequestArguments.H2OHexKey _key

_classCol

public final RequestArguments.H2OHexKeyCol _classCol

_defaultValue

public final int _defaultValue

Constructor Detail

RequestArguments.H2OCategoryStrata

public RequestArguments.H2OCategoryStrata(java.lang.String name,
                                  RequestArguments.H2OHexKey key,
                                  RequestArguments.H2OHexKeyCol classCol,
                                  int defaultValue)

Method Detail

determineColumnClassNames

protected java.lang.String[] determineColumnClassNames(int maxClasses)
                                                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

textValues

protected java.lang.String[] textValues()

Specified by:

textValues in class RequestArguments.MultipleText<int[]>

textNames

protected java.lang.String[] textNames()

Specified by:

textNames in class RequestArguments.MultipleText<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[]>

convertToMap

public java.util.Map<java.lang.Integer,java.lang.Integer> convertToMap()

textSuffix

protected java.lang.String textSuffix()

Overrides:

textSuffix in class RequestArguments.MultipleText<int[]>