water.api

Class SchemaMetadata.FieldMetadata

java.lang.Object

water.Iced

water.api.SchemaMetadata.FieldMetadata

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

Enclosing class:

SchemaMetadata

public static final class SchemaMetadata.FieldMetadata
extends Iced

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	is_gridable Is this field gridable? Set from the @API annotation.
boolean	is_schema Type for this field is itself a Schema.
java.lang.String	name Field name in the POJO.
java.lang.String	schema_name Schema name for this field, if it is_schema.
java.lang.String	type Type for this field.
Iced	value Value for this field.

Constructor Summary

Constructors

Constructor and Description
SchemaMetadata.FieldMetadata()
SchemaMetadata.FieldMetadata(Schema schema, java.lang.reflect.Field f) Create a new FieldMetadata object for the given Field of the given Schema.
SchemaMetadata.FieldMetadata(java.lang.String name, java.lang.String type, boolean is_schema, java.lang.String schema_name, Iced value, java.lang.String help, java.lang.String label, boolean required, API.Level level, API.Direction direction, java.lang.String[] values, boolean json, java.lang.String[] is_member_of_frames, java.lang.String[] is_mutually_exclusive_with)

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	consType(Schema schema, java.lang.Class clz, java.lang.String field_name) For a given Class generate a client-friendly type name (e.g., int[][] or Frame).
static Iced	consValue(java.lang.Object o)
static SchemaMetadata.FieldMetadata	createIfApiAnnotation(Schema schema, java.lang.reflect.Field f) Factory method to create a new FieldMetadata instance if the Field has an @API annotation.

Methods inherited from class water.Iced

clone, copyOver, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

Field name in the POJO. Set through reflection.

type

public java.lang.String type

Type for this field. Set through reflection.

is_schema

public boolean is_schema

Type for this field is itself a Schema. Set through reflection.

schema_name

public java.lang.String schema_name

Schema name for this field, if it is_schema. Set through reflection.

value

public Iced value

Value for this field. Set through reflection.

is_gridable

public boolean is_gridable

Is this field gridable? Set from the @API annotation.

Constructor Detail

SchemaMetadata.FieldMetadata

public SchemaMetadata.FieldMetadata()

SchemaMetadata.FieldMetadata

public SchemaMetadata.FieldMetadata(java.lang.String name,
                            java.lang.String type,
                            boolean is_schema,
                            java.lang.String schema_name,
                            Iced value,
                            java.lang.String help,
                            java.lang.String label,
                            boolean required,
                            API.Level level,
                            API.Direction direction,
                            java.lang.String[] values,
                            boolean json,
                            java.lang.String[] is_member_of_frames,
                            java.lang.String[] is_mutually_exclusive_with)

Parameters:

name - field name

type - field type, which can be a primitive type like "string" or "double" or an H2O type like ModelParameters

value - value of the field, represented as a string

help - help text (description) for the field

label - label for the field in the UI, if it should be different from the field name

required - if the field is an INPUT field is it required, or is there a reasonable default value?

level - one of {critical, secondary, expert}: is this a basic field that everyone needs to set, or something only for experts?

direction - one of {INPUT, OUTPUT, INOUT}: is this something the client needs to supply, or something that's only generated by H2O?

values - for enum-type fields this is a list of allowed string values

json - should this field be included in generated JSON?

SchemaMetadata.FieldMetadata

public SchemaMetadata.FieldMetadata(Schema schema,
                            java.lang.reflect.Field f)

Create a new FieldMetadata object for the given Field of the given Schema.

Parameters:

schema - water.api.Schema object

f - java.lang.reflect.Field for the Schema class

See Also:

water.api.SchemaMetadata.FieldMetadata#FieldMetadata(String, String, boolean, String, Iced, String, String, boolean, water.api.API.Level, water.api.API.Direction, String[], boolean, String[], String[])

Method Detail

createIfApiAnnotation

public static SchemaMetadata.FieldMetadata createIfApiAnnotation(Schema schema,
                                                 java.lang.reflect.Field f)

Factory method to create a new FieldMetadata instance if the Field has an @API annotation.

Parameters:

schema - water.api.Schema object

f - java.lang.reflect.Field for the Schema class

Returns:

a new FieldMetadata instance if the Field has an @API annotation, else null

consType

public static java.lang.String consType(Schema schema,
                        java.lang.Class clz,
                        java.lang.String field_name)

For a given Class generate a client-friendly type name (e.g., int[][] or Frame).

consValue

public static Iced consValue(java.lang.Object o)