water.api

Class FrameBase<I extends Iced,S extends Schema<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.FrameBase<I,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

FrameSynopsisV3, FrameV3

public class FrameBase<I extends Iced,S extends Schema<I,S>>
extends Schema<I,S>

The minimal amount of information on a Frame.

See Also:

FramesHandler.list(int, FramesV3), Serialized Form

Nested Class Summary

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
long	byte_size
KeyV3.FrameKeyV3	frame_id
boolean	is_text

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

Constructor Summary

Constructors

Constructor and Description
FrameBase()

Method Summary

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromImpl, 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_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

frame_id

@API(help="Frame ID",
     required=true,
     direction=INOUT)
public KeyV3.FrameKeyV3 frame_id

byte_size

@API(help="Total data size in bytes",
     direction=OUTPUT)
public long byte_size

is_text

@API(help="Is this Frame raw unparsed data?",
     direction=OUTPUT)
public boolean is_text

Constructor Detail

FrameBase

public FrameBase()