water

Class Iced<D extends Iced>

java.lang.Object

water.Iced<D>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<D>

Direct Known Subclasses:

AstGroup.AGG, AstGroup.G, AstRoot, AUC2, AUC2.AUCBuilder, BufferedString, Categorical, Chunk, ConfusionMatrix, CreateFrame, Distribution, DMatrix.MatrixMulStats, Env, Frame.VecSpecifier, FramesHandler.Frames, FrameUtils.CategoricalBinaryEncoder, FrameUtils.CategoricalOneHotEncoder, FrameUtils.MissingInserter, FVecParseWriter, GainsLift, GetLogsFromNode, Grids, H2OError, H2ONode, HeartBeat, HyperSpaceSearchCriteria, IcedBitSet, IcedDouble, IcedHashMapBase, IcedInt, IcedLong, IcedWrapper, Interaction, JProfile, JProfile.ProfileSummary, JStack, JStackCollectorTask.DStackTrace, Key, Keyed, KeySnapshot.KeyInfo, MathUtils.BasicStats, MeanResidualDeviance, Model.InteractionPair, Model.Output, Model.Parameters, ModelBuilder, ModelBuilder.ValidationMessage, ModelMetrics.MetricBuilder, ModelsHandler.Models, NetworkBench, NetworkTest, NodePersistentStorage.NodePersistentStorageEntry, Parser, ParserInfo, ParseSetup, ParseWriter.ParseErr, PreviewParseWriter, ProfileCollectorTask.NodeProfile, Route, Schema, SchemaMetadata, SchemaMetadata.FieldMetadata, SchemaV3.Meta, ScoreKeeper, ScoringInfo, ShutdownHandler.Shutdown, TimelineHandler.Timeline, Transform, Transformer, TwoDimTable, Val, Value, VarImp, WaterMeterCpuTicks, WaterMeterIo

public abstract class Iced<D extends Iced>
extends java.lang.Object
implements Freezable<D>, java.io.Externalizable

H2O uses Iced classes as the primary means of moving Java Objects around the cluster.

Auto-serializer base-class using a delegator pattern (the faster option is to byte-code gen directly in all Iced classes, but this requires all Iced classes go through a ClassLoader).

Iced is a marker class, and Freezable is the companion marker interface. Marked classes have 2-byte integer type associated with them, and an auto-genned delegate class created to actually do byte-stream and JSON serialization and deserialization. Byte-stream serialization is extremely dense (includes various compressions), and typically memory-bandwidth bound to generate.

During startup time the Weaver creates a parallel set of classes called (classname)$Icer. These provide bytestream and JSON serializers and deserializers which get called by AutoBuffer.write* and AutoBuffer.read*.

To debug the automagic serialization code create a transient field in your Iced class called DEBUG_WEAVER. The generated source code will get written to STDOUT:

transient int DEBUG_WEAVER = 1;

See Also:

Freezable, Weaver, AutoBuffer, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Iced()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	asBytes() Return serialized version of self as a byte array.
D	clone() Clone, without the annoying exception
protected void	copyOver(D src) Copy over cloned instance 'src' over 'this', field by field.
int	frozenType() Returns a small dense integer, which is cluster-wide unique per-class.
D	read(AutoBuffer ab) Standard "read thyself from the AutoBuffer" call, using the fast Iced protocol.
void	readExternal(java.io.ObjectInput ois) Implementation of the Iced serialization protocol, only called by auto-genned code.
D	readJSON(AutoBuffer ab) Standard "read thyself from the AutoBuffer" call, using JSON.
D	reloadFromBytes(byte[] ary) Replace yourself with deserialized version from the given bytes.
java.lang.String	toJsonString() Helper for folks that want a JSON String for this object.
AutoBuffer	write(AutoBuffer ab) Standard "write thyself into the AutoBuffer" call, using the fast Iced protocol.
void	writeExternal(java.io.ObjectOutput oos)
AutoBuffer	writeJSON(AutoBuffer ab) Standard "write thyself into the AutoBuffer" call, using JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

Iced

public Iced()

Method Detail

asBytes

public byte[] asBytes()

Description copied from interface: Freezable

Return serialized version of self as a byte array. Useful for Freezables directly supported by byte array (@see Chunk) In most cases, just use the Autobuffer version.

Specified by:

asBytes in interface Freezable<D extends Iced>

Returns:

serialized bytes

reloadFromBytes

public D reloadFromBytes(byte[] ary)

Description copied from interface: Freezable

Replace yourself with deserialized version from the given bytes. Useful for Freezables directly supported by byte array (@see Chunk). In most cases, just use the Autobuffer version.

Specified by:

reloadFromBytes in interface Freezable<D extends Iced>

Parameters:

ary - byte array containing exactly (i.e. nothing else) the serialized version of the Freezable

Returns:

this freshly reloaded from the given bytes.

write

public final AutoBuffer write(AutoBuffer ab)

Standard "write thyself into the AutoBuffer" call, using the fast Iced protocol. Real work is in the delegate Icer classes.

Specified by:

write in interface Freezable<D extends Iced>

Parameters:

ab - AutoBuffer to write this object to.

Returns:

Returns the original AutoBuffer for flow-coding.

writeJSON

public AutoBuffer writeJSON(AutoBuffer ab)

Standard "write thyself into the AutoBuffer" call, using JSON. Real work is in the delegate Icer classes.

Specified by:

writeJSON in interface Freezable<D extends Iced>

Parameters:

ab - AutoBuffer to write this object to.

Returns:

Returns the original AutoBuffer for flow-coding.

read

public final D read(AutoBuffer ab)

Standard "read thyself from the AutoBuffer" call, using the fast Iced protocol. Real work is in the delegate Icer classes.

Specified by:

read in interface Freezable<D extends Iced>

Parameters:

ab - AutoBuffer to read this object from.

Returns:

Returns the original AutoBuffer for flow-coding.

readJSON

public final D readJSON(AutoBuffer ab)

Standard "read thyself from the AutoBuffer" call, using JSON. Real work is in the delegate Icer classes.

Specified by:

readJSON in interface Freezable<D extends Iced>

Parameters:

ab - AutoBuffer to read this object from.

Returns:

Returns the original AutoBuffer for flow-coding.

toJsonString

public final java.lang.String toJsonString()

Helper for folks that want a JSON String for this object.

frozenType

public final int frozenType()

Returns a small dense integer, which is cluster-wide unique per-class. Useful as an array index.

Specified by:

frozenType in interface Freezable<D extends Iced>

Returns:

Small integer, unique per-type

clone

public final D clone()

Clone, without the annoying exception

Specified by:

clone in interface Freezable<D extends Iced>

Overrides:

clone in class java.lang.Object

Returns:

Returns this object cloned.

copyOver

protected void copyOver(D src)

Copy over cloned instance 'src' over 'this', field by field.

readExternal

public void readExternal(java.io.ObjectInput ois)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

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:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput oos)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException