water.api.schemas3

Class SplitFrameV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<SplitFrame,SplitFrameV3>

water.api.schemas3.SplitFrameV3

All Implemented Interfaces:

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

public class SplitFrameV3
extends SchemaV3<SplitFrame,SplitFrameV3>

See Also:

Serialized Form

Nested Class Summary

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

SchemaV3.Meta

Field Summary

Fields

Modifier and Type	Field and Description
KeyV3.FrameKeyV3	dataset
KeyV3.FrameKeyV3[]	destination_frames
KeyV3.JobKeyV3	key
double[]	ratios

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
SplitFrameV3()
SplitFrameV3(SplitFrame impl)

Method Summary

Methods

Modifier and Type	Method and Description
SplitFrame	createImpl() Create an appropriate implementation object and any child objects but does not fill them.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, extractVersionFromSchemaName, fillFromImpl, fillFromImpl, 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, toString, wait, wait, wait

Field Detail

key

@API(help="Job Key")
public KeyV3.JobKeyV3 key

dataset

@API(help="Dataset")
public KeyV3.FrameKeyV3 dataset

ratios

@API(help="Split ratios - resulting number of split is ratios.length+1",
     json=true)
public double[] ratios

destination_frames

@API(help="Destination keys for each output frame split.",
     direction=INOUT)
public KeyV3.FrameKeyV3[] destination_frames

Constructor Detail

SplitFrameV3

public SplitFrameV3()

SplitFrameV3

public SplitFrameV3(SplitFrame impl)

Method Detail

createImpl

public SplitFrame 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<SplitFrame,SplitFrameV3>