water.api.schemas3

Class FrameV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<I,S>

water.api.schemas3.FrameBaseV3<Frame,FrameV3>

water.api.schemas3.FrameV3

All Implemented Interfaces:

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

public class FrameV3
extends FrameBaseV3<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.schemas3.SchemaV3

SchemaV3.Meta

Field Summary

Fields

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

Fields inherited from class water.api.schemas3.FrameBaseV3

_fr, byte_size, frame_id, is_text

Fields inherited from class water.api.schemas3.SchemaV3

__meta, _exclude_fields

Constructor Summary

Constructors

Constructor and Description
FrameV3()
FrameV3(Frame fr)
FrameV3(Frame f, long row_offset, int row_count)
FrameV3(Frame f, long row_offset, int row_count, int column_offset, int column_count)
FrameV3(Key<Frame> frame_id)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBinsField()
FrameV3	fillFromImpl(Frame f) Fill this Schema from the given implementation object.
FrameV3	fillFromImpl(Frame f, long row_offset, int row_count, int column_offset, int column_count)

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

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

num_columns

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

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

chunk_summary

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

distribution_summary

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

Constructor Detail

FrameV3

public FrameV3()

FrameV3

public FrameV3(Key<Frame> frame_id)

FrameV3

public FrameV3(Frame fr)

FrameV3

public FrameV3(Frame f,
       long row_offset,
       int row_count)

FrameV3

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

Method Detail

fillFromImpl

public FrameV3 fillFromImpl(Frame f)

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<Frame,FrameV3>

fillFromImpl

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

clearBinsField

public void clearBinsField()