water.api.schemas3

Class SchemaMetadataV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<SchemaMetadata,SchemaMetadataV3>

water.api.schemas3.SchemaMetadataV3

All Implemented Interfaces:

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

public class SchemaMetadataV3
extends SchemaV3<SchemaMetadata,SchemaMetadataV3>

See Also:

Serialized Form

Nested Class Summary

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

SchemaV3.Meta

Nested classes/interfaces inherited from class water.api.Schema

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
FieldMetadataV3[]	fields
java.lang.String	label
java.lang.String	name The simple schema (class) name, e.g.
java.lang.String	superclass The simple schema superclass name, e.g.
java.lang.String	type
int	version

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
SchemaMetadataV3()
SchemaMetadataV3(SchemaMetadata impl)

Method Summary

Modifier and Type	Method and Description
SchemaMetadata	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
SchemaMetadataV3	fillFromImpl(SchemaMetadata impl) Fill this Schema from the given implementation object.
SchemaMetadata	fillImpl(SchemaMetadata impl) Fill an impl object and any children from this schema and its children.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, 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, toJsonBytes, toJsonString, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

version

@API(help="Version number of the Schema.")
public int version

name

@API(help="Simple name of the Schema. NOTE: the schema_names form a single namespace.")
public java.lang.String name

The simple schema (class) name, e.g. DeepLearningParametersV2, used in the schema metadata. Must not be changed after creation (treat as final).

label

@API(help="[DEPRECATED] This field is always the same as name.",
     direction=OUTPUT)
public java.lang.String label

superclass

@API(help="Simple name of the superclass of the Schema.  NOTE: the schema_names form a single namespace.")
public java.lang.String superclass

The simple schema superclass name, e.g. ModelSchemaV3, used in the schema metadata. Must not be changed after creation (treat as final).

type

@API(help="Simple name of H2O type that this Schema represents. Must not be changed after creation (treat as final).")
public java.lang.String type

fields

@API(help="All the public fields of the schema",
     direction=OUTPUT)
public FieldMetadataV3[] fields

Constructor Detail

SchemaMetadataV3

public SchemaMetadataV3()

SchemaMetadataV3

public SchemaMetadataV3(SchemaMetadata impl)

Method Detail

createImpl

public SchemaMetadata createImpl()

Description copied from class: Schema

Create an appropriate implementation object and any child objects but does not fill them. The standard purpose of a createImpl without a fillImpl is to be able to get the default values for all the impl's fields.

For objects without children this method does all the required work. For objects with children the subclass will need to override, e.g. by calling super.createImpl() and then calling createImpl() on its children.

Note that impl objects for schemas which override this method don't need to have a default constructor (e.g., a Keyed object constructor can still create and set the Key), but they must not fill any fields which can be filled later from the schema.

TODO: We could handle the common case of children with the same field names here by finding all of our fields that are themselves Schemas.

Overrides:

createImpl in class Schema<SchemaMetadata,SchemaMetadataV3>

fillImpl

public SchemaMetadata fillImpl(SchemaMetadata impl)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillImpl in class Schema<SchemaMetadata,SchemaMetadataV3>

fillFromImpl

public SchemaMetadataV3 fillFromImpl(SchemaMetadata impl)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillFromImpl in class Schema<SchemaMetadata,SchemaMetadataV3>