water.api.schemas3

Class TabulateV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<Tabulate,TabulateV3>

water.api.schemas3.TabulateV3

All Implemented Interfaces:

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

public class TabulateV3
extends SchemaV3<Tabulate,TabulateV3>

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
TwoDimTableV3	count_table
KeyV3.FrameKeyV3	dataset
int	nbins_predictor
int	nbins_response
FrameV3.ColSpecifierV3	predictor
FrameV3.ColSpecifierV3	response
TwoDimTableV3	response_table
FrameV3.ColSpecifierV3	weight

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
TabulateV3()
TabulateV3(Tabulate impl)

Method Summary

Methods

Modifier and Type	Method and Description
Tabulate	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
TabulateV3	fillFromImpl(Tabulate impl) Fill this Schema from the given implementation object.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

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

dataset

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

predictor

@API(help="Predictor",
     required=true,
     level=critical,
     is_member_of_frames="dataset",
     is_mutually_exclusive_with="col_y",
     direction=INOUT)
public FrameV3.ColSpecifierV3 predictor

response

@API(help="Response",
     required=true,
     level=critical,
     is_member_of_frames="dataset",
     is_mutually_exclusive_with="col_x",
     direction=INOUT)
public FrameV3.ColSpecifierV3 response

weight

@API(help="Observation weights (optional)",
     required=false,
     level=critical,
     is_member_of_frames="dataset",
     is_mutually_exclusive_with="col_x",
     direction=INOUT)
public FrameV3.ColSpecifierV3 weight

nbins_predictor

@API(help="Number of bins for predictor column")
public int nbins_predictor

nbins_response

@API(help="Number of bins for response column")
public int nbins_response

count_table

@API(help="Counts table",
     direction=OUTPUT)
public TwoDimTableV3 count_table

response_table

@API(help="Response table",
     direction=OUTPUT)
public TwoDimTableV3 response_table

Constructor Detail

TabulateV3

public TabulateV3()

TabulateV3

public TabulateV3(Tabulate impl)

Method Detail

fillFromImpl

public TabulateV3 fillFromImpl(Tabulate impl)

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<Tabulate,TabulateV3>

createImpl

public Tabulate 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<Tabulate,TabulateV3>