water.api

Class FrameV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.FrameBase<Frame,FrameV3>

water.api.FrameV3

All Implemented Interfaces:

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

public class FrameV3
extends FrameBase<Frame,FrameV3>

All the details on a Frame. Note that inside ColV3 there are fields which won't be populated if we don't compute rollups, e.g. via the REST API endpoint /Frames//columns//summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrameV3.ColSpecifierV3
static class	FrameV3.ColV3

Nested classes/interfaces inherited from class water.api.Schema

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
long	checksum
TwoDimTableBase	chunk_summary
int	column_count
int	column_offset
FrameV3.ColV3[]	columns
java.lang.String[]	compatible_models
double[]	default_percentiles
TwoDimTableBase	distribution_summary
int	row_count
long	row_offset
long	rows
int	total_column_count
KeyV3.VecKeyV3[]	vec_ids

Fields inherited from class water.api.FrameBase

byte_size, frame_id, is_text

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
FrameV3()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBinsField()
FrameV3	fillFromImpl(Frame f) Version and Schema-specific filling from the implementation object.
FrameV3	fillFromImpl(Frame f, long row_offset, int row_count, int column_offset, int column_count, boolean force_summary)
DocGen.HTML	writeHTML_impl(DocGen.HTML ab) Implementation of the Iced serialization protocol, only called by auto-genned code.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, 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, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

row_offset

@API(help="Row offset to display",
     direction=INPUT)
public long row_offset

row_count

@API(help="Number of rows to display",
     direction=INOUT)
public int row_count

column_offset

@API(help="Column offset to return",
     direction=INOUT)
public int column_offset

column_count

@API(help="Number of columns to return",
     direction=INOUT)
public int column_count

total_column_count

@API(help="Total number of columns in the Frame",
     direction=INOUT)
public int total_column_count

checksum

@API(help="checksum",
     direction=OUTPUT)
public long checksum

rows

@API(help="Number of rows in the Frame",
     direction=OUTPUT)
public long rows

default_percentiles

@API(help="Default percentiles, from 0 to 1",
     direction=OUTPUT)
public double[] default_percentiles

columns

@API(help="Columns in the Frame",
     direction=OUTPUT)
public FrameV3.ColV3[] columns

compatible_models

@API(help="Compatible models, if requested",
     direction=OUTPUT)
public java.lang.String[] compatible_models

vec_ids

@API(help="The set of IDs of vectors in the Frame",
     direction=OUTPUT)
public KeyV3.VecKeyV3[] vec_ids

chunk_summary

@API(help="Chunk summary",
     direction=OUTPUT)
public TwoDimTableBase chunk_summary

distribution_summary

@API(help="Distribution summary",
     direction=OUTPUT)
public TwoDimTableBase distribution_summary

Constructor Detail

FrameV3

public FrameV3()

Method Detail

fillFromImpl

public FrameV3 fillFromImpl(Frame f)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<Frame,FrameV3>

fillFromImpl

public FrameV3 fillFromImpl(Frame f,
                   long row_offset,
                   int row_count,
                   int column_offset,
                   int column_count,
                   boolean force_summary)

clearBinsField

public void clearBinsField()

writeHTML_impl

public DocGen.HTML writeHTML_impl(DocGen.HTML ab)

Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

writeHTML_impl in interface Freezable

Overrides:

writeHTML_impl in class Iced

Parameters:

ab - html to write object to.

Returns:

Returns the instance of HTML object.