water.api

Class SchemaMetadataBase<I extends SchemaMetadata,S extends SchemaMetadataBase<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,SchemaMetadataBase<I,S>>

water.api.SchemaMetadataBase<I,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

SchemaMetadataV3

public class SchemaMetadataBase<I extends SchemaMetadata,S extends SchemaMetadataBase<I,S>>
extends Schema<I,SchemaMetadataBase<I,S>>

Schema for the metadata for a Schema.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaMetadataBase.FieldMetadataBase<I extends SchemaMetadata.FieldMetadata,S extends SchemaMetadataBase.FieldMetadataBase<I,S>> Schema for the metadata for the field of a Schema.

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
SchemaMetadataBase.FieldMetadataBase[]	fields
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.Schema

__meta, _impl_class, _version_pattern, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
SchemaMetadataBase()

Method Summary

Methods

Modifier and Type	Method and Description
I	createImpl() Create an implementation object and any child objects but DO NOT fill them.
SchemaMetadataBase	fillFromImpl(SchemaMetadata impl) Version and Schema-specific filling from the implementation object.
I	fillImpl(I impl) Fill an impl object and any children from this schema and its children.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, extractVersion, fillFromParms, getExperimentalVersion, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, markdown, markdown, markdown, markdown, newInstance, register, registerAllSchemasIfNecessary, schema, schema, schema, schema, schema, schemaClass, schemaClass, schemaClass, schemaClass, schemas

Methods inherited from class water.Iced

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

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).

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. ModelSchema, 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 SchemaMetadataBase.FieldMetadataBase[] fields

Constructor Detail

SchemaMetadataBase

public SchemaMetadataBase()

Method Detail

createImpl

public I createImpl()

Description copied from class: Schema

Create an implementation object and any child objects but DO NOT fill them. The 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<I extends SchemaMetadata,SchemaMetadataBase<I extends SchemaMetadata,S extends SchemaMetadataBase<I,S>>>

fillImpl

public I fillImpl(I impl)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children.

Overrides:

fillImpl in class Schema<I extends SchemaMetadata,SchemaMetadataBase<I extends SchemaMetadata,S extends SchemaMetadataBase<I,S>>>

fillFromImpl

public SchemaMetadataBase fillFromImpl(SchemaMetadata impl)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<I extends SchemaMetadata,SchemaMetadataBase<I extends SchemaMetadata,S extends SchemaMetadataBase<I,S>>>