water.api.schemas3

Class CreateFrameV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<CreateFrame,CreateFrameV3>

water.api.schemas3.CreateFrameV3

All Implemented Interfaces:

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

public class CreateFrameV3
extends SchemaV3<CreateFrame,CreateFrameV3>

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
double	binary_fraction
double	binary_ones_fraction
double	categorical_fraction
int	cols
KeyV3.FrameKeyV3	dest
int	factors
boolean	has_response
double	integer_fraction
long	integer_range
KeyV3.JobKeyV3	key
double	missing_fraction
boolean	randomize
long	real_range
int	response_factors
long	rows
long	seed
long	seed_for_column_types
double	string_fraction
double	time_fraction
long	value

Fields inherited from class water.api.schemas3.SchemaV3

__meta, _exclude_fields

Constructor Summary

Constructors

Constructor and Description
CreateFrameV3()

Method Summary

Methods

Modifier and Type	Method and Description
CreateFrame	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, 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

dest

@API(help="destination key",
     direction=INOUT)
public KeyV3.FrameKeyV3 dest

rows

@API(help="Number of rows",
     direction=INOUT)
public long rows

cols

@API(help="Number of data columns (in addition to the first response column)",
     direction=INOUT)
public int cols

seed

@API(help="Random number seed that determines the random values",
     direction=INOUT)
public long seed

seed_for_column_types

@API(help="Random number seed for setting the column types",
     direction=INOUT)
public long seed_for_column_types

randomize

@API(help="Whether frame should be randomized",
     direction=INOUT)
public boolean randomize

value

@API(help="Constant value (for randomize=false)",
     direction=INOUT)
public long value

real_range

@API(help="Range for real variables (-range ... range)",
     direction=INOUT)
public long real_range

categorical_fraction

@API(help="Fraction of categorical columns (for randomize=true)",
     direction=INOUT)
public double categorical_fraction

factors

@API(help="Factor levels for categorical variables",
     direction=INOUT)
public int factors

integer_fraction

@API(help="Fraction of integer columns (for randomize=true)",
     direction=INOUT)
public double integer_fraction

integer_range

@API(help="Range for integer variables (-range ... range)",
     direction=INOUT)
public long integer_range

binary_fraction

@API(help="Fraction of binary columns (for randomize=true)",
     direction=INOUT)
public double binary_fraction

binary_ones_fraction

@API(help="Fraction of 1\'s in binary columns",
     direction=INOUT)
public double binary_ones_fraction

time_fraction

@API(help="Fraction of date/time columns (for randomize=true)",
     direction=INOUT)
public double time_fraction

string_fraction

@API(help="Fraction of string columns (for randomize=true)",
     direction=INOUT)
public double string_fraction

missing_fraction

@API(help="Fraction of missing values",
     direction=INOUT)
public double missing_fraction

response_factors

@API(help="Number of factor levels of the first column (1=real, 2=binomial, N=multinomial)",
     direction=INOUT)
public int response_factors

has_response

@API(help="Whether an additional response column should be generated",
     direction=INOUT)
public boolean has_response

key

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

Constructor Detail

CreateFrameV3

public CreateFrameV3()

Method Detail

createImpl

public CreateFrame 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<CreateFrame,CreateFrameV3>