water.api.schemas3

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.schemas3.SchemaV3<I,KeyV3<I,S,K>>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

KeyV3.AssemblyKeyV3, KeyV3.FrameKeyV3, KeyV3.GridKeyV3, KeyV3.JobKeyV3, KeyV3.ModelKeyV3

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

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.AssemblyKeyV3
static class	KeyV3.FrameKeyV3
static class	KeyV3.GridKeyV3
static class	KeyV3.JobKeyV3
static class	KeyV3.ModelKeyV3

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

SchemaV3.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.schemas3.SchemaV3

__meta, _exclude_fields

Constructor Summary

Constructors

Constructor and Description
KeyV3()
KeyV3(Key key)

Method Summary

Methods

Modifier and Type	Method and Description
I	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
S	fillFromImpl(Iced i) Fill this Schema from the given implementation object.
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.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, extractVersionFromSchemaName, 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, 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.

fillFromImpl

public S fillFromImpl(Iced i)

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object