water.api

Class KeyV3<I extends Iced,S extends KeyV3<I,S,K>,K extends Keyed>

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.KeyV3<I,S,K>

All Implemented Interfaces:

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

Direct Known Subclasses:

KeyV3.FrameKeyV3, KeyV3.JobKeyV3, KeyV3.ModelKeyV3, KeyV3.VecKeyV3

public class KeyV3<I extends Iced,S extends KeyV3<I,S,K>,K extends Keyed>
extends Schema<I,S>

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

The type parameters are a bit subtle, because we have several schemas that map to Key, by type. We want to be parameterized by the type of Keyed that we point to, but the Iced type we pass up to Schema must be Iced, so that a lookup for a Schema for Key doesn't get an arbitrary subclass of KeyV1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyV3.FrameKeyV3
static class	KeyV3.JobKeyV3
static class	KeyV3.ModelKeyV3
static class	KeyV3.VecKeyV3

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, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
KeyV3()
KeyV3(Key key)

Method Summary

Methods

Modifier and Type	Method and Description
I	createImpl() Create an implementation object and any child objects but DO NOT fill them.
S	fillFromImpl(Iced i) Version and Schema-specific filling from the implementation object.
static KeyV3	forKeyedClass(java.lang.Class<? extends Keyed> keyed_class, Key key) Factory method which returns the correct KeyV1 for the given Keyed class (e.g., for Frame.class).
java.lang.Class<? extends Keyed>	getKeyedClass()
static java.lang.Class<? extends Keyed>	getKeyedClass(java.lang.Class<? extends KeyV3> clz)
java.lang.String	getKeyedClassType()
static java.lang.String	getKeyedClassType(java.lang.Class<? extends KeyV3> clz)
Key<K>	key()
static KeyV3	make(java.lang.Class<? extends KeyV3> clz, Key key)
static KeyV3	make(Key key) TODO: figure out the right KeyV1 class from the Key, so the type is set properly.
java.lang.String	toString()

Methods inherited from class water.api.Schema

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

Field Detail

name

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

type

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

URL

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

Constructor Detail

KeyV3

public KeyV3()

KeyV3

public KeyV3(Key key)

Method Detail

make

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

make

public static KeyV3 make(Key key)

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

forKeyedClass

public static KeyV3 forKeyedClass(java.lang.Class<? extends Keyed> keyed_class,
                  Key key)

Factory method which returns the correct KeyV1 for the given Keyed class (e.g., for Frame.class).

fillFromImpl

public S fillFromImpl(Iced i)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<I extends Iced,S extends KeyV3<I,S,K>>

getKeyedClass

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

getKeyedClass

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

getKeyedClassType

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

getKeyedClassType

public java.lang.String getKeyedClassType()

key

public Key<K> key()

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 Iced,S extends KeyV3<I,S,K>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object