water.api

Class KeySchema<T extends Keyed>

java.lang.Object

water.Iced

water.api.Schema<Key<T>,KeySchema<T>>

water.api.KeySchema<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

KeyV1, KeyV1.FrameKeyV1, KeyV1.JobKeyV1, KeyV1.ModelKeyV1

public class KeySchema<T extends Keyed>
extends Schema<Key<T>,KeySchema<T>>

Base Schema Class for Keys. Note that Key schemas are generally typed by the type of object they point to (e.g., the front something like a Key).

See Also:

Serialized Form

Nested Class Summary

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name
java.lang.String	type
java.lang.String	URL

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

Constructor Summary

Constructors

Constructor and Description
KeySchema()
KeySchema(Key key)

Method Summary

Methods

Modifier and Type	Method and Description
KeySchema<T>	fillFromImpl(Key key) Version and Schema-specific filling from the implementation object.
java.lang.Class<? extends Keyed>	getKeyedClass()
static java.lang.Class<? extends Keyed>	getKeyedClass(java.lang.Class<? extends KeySchema> clz)
java.lang.String	getKeyedClassType()
static java.lang.String	getKeyedClassType(java.lang.Class<? extends KeySchema> clz)
Key<T>	key()
static KeySchema	make(java.lang.Class<? extends KeySchema> clz, Key key)
static KeySchema	make(Key key) TODO: figure out the right KeySchema class from the Key, so the type is set properly.
java.lang.String	toString()

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromParms, fillImpl, getImplClass, getImplClass, 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, wait, wait, wait

Field Detail

name

@API(help="Name (string representation) for this Key.")
public java.lang.String name

type

@API(help="Name (string representation) for the type of Keyed this Key points to.")
public java.lang.String type

URL

@API(help="URL for the resource that this Key points to, if one exists.")
public java.lang.String URL

Constructor Detail

KeySchema

public KeySchema(Key key)

KeySchema

public KeySchema()

Method Detail

make

public static KeySchema make(java.lang.Class<? extends KeySchema> clz,
             Key key)

make

public static KeySchema make(Key key)

TODO: figure out the right KeySchema class from the Key, so the type is set properly.

fillFromImpl

public KeySchema<T> fillFromImpl(Key key)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<Key<T extends Keyed>,KeySchema<T extends Keyed>>

getKeyedClass

public static java.lang.Class<? extends Keyed> getKeyedClass(java.lang.Class<? extends KeySchema> clz)

getKeyedClass

public java.lang.Class<? extends Keyed> getKeyedClass()

getKeyedClassType

public static java.lang.String getKeyedClassType(java.lang.Class<? extends KeySchema> clz)

getKeyedClassType

public java.lang.String getKeyedClassType()

key

public Key<T> key()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object