water.api.schemas3

Class FieldMetadataV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<SchemaMetadata.FieldMetadata,FieldMetadataV3>

water.api.schemas3.FieldMetadataV3

All Implemented Interfaces:

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

public class FieldMetadataV3
extends SchemaV3<SchemaMetadata.FieldMetadata,FieldMetadataV3>

Schema for the metadata for the field of a Schema.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

SchemaV3.Meta

Field Summary

Fields

Modifier and Type	Field and Description
API.Direction	direction
java.lang.String	help
java.lang.String	inherited_from
boolean	is_gridable
boolean	is_inherited
boolean	is_schema
java.lang.String	label
API.Level	level
java.lang.String	name
boolean	required
java.lang.String	schema_name
java.lang.String	type
Iced	value

Fields inherited from class water.api.schemas3.SchemaV3

__meta, _exclude_fields

Constructor Summary

Constructors

Constructor and Description
FieldMetadataV3()

Method Summary

Methods

Modifier and Type	Method and Description
AutoBuffer	writeJSON_impl(AutoBuffer ab) FieldMetadataBase has its own serializer so that value get serialized as its native type.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

name

@API(help="Field name in the Schema",
     direction=OUTPUT)
public java.lang.String name

type

@API(help="Type for this field",
     direction=OUTPUT)
public java.lang.String type

is_schema

@API(help="Type for this field is itself a Schema.",
     direction=OUTPUT)
public boolean is_schema

schema_name

@API(help="Schema name for this field, if it is_schema, or the name of the enum, if it\'s an enum.")
public java.lang.String schema_name

value

@API(help="Value for this field",
     direction=OUTPUT)
public Iced value

help

@API(help="A short help description to appear alongside the field in a UI",
     direction=OUTPUT)
public java.lang.String help

label

@API(help="The label that should be displayed for the field if the name is insufficient",
     direction=OUTPUT)
public java.lang.String label

required

@API(help="Is this field required, or is the default value generally sufficient?",
     direction=OUTPUT)
public boolean required

level

@API(help="How important is this field?  The web UI uses the level to do a slow reveal of the parameters",
     values={"critical","secondary","expert"},
     direction=OUTPUT)
public API.Level level

direction

@API(help="Is this field an input, output or inout?",
     values={"INPUT","OUTPUT","INOUT"},
     direction=OUTPUT)
public API.Direction direction

is_inherited

@API(help="Is the field inherited from the parent schema?",
     direction=OUTPUT)
public boolean is_inherited

inherited_from

@API(help="If this field is inherited from a class higher in the hierarchy which one?",
     direction=OUTPUT)
public java.lang.String inherited_from

is_gridable

@API(help="Is the field gridable (i.e., it can be used in grid call)",
     direction=OUTPUT)
public boolean is_gridable

Constructor Detail

FieldMetadataV3

public FieldMetadataV3()

Method Detail

writeJSON_impl

public final AutoBuffer writeJSON_impl(AutoBuffer ab)

FieldMetadataBase has its own serializer so that value get serialized as its native type. Autobuffer assumes all classes that have their own serializers should be serialized as JSON objects, and wraps them in {}, so this can't just be handled by a customer serializer in IcedWrapper.