water

Class Keyed<T extends Keyed>

java.lang.Object

water.Iced<T>

water.Keyed<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

Assembly, DecryptionTool, Job, Lockable, ModelMetrics, ModelPreprocessor, SegmentModels, SplitFrame.Frames, Tabulate, Vec, Vec.ESPC, Vec.VectorGroup

public abstract class Keyed<T extends Keyed>
extends Iced<T>

Iced, with a Key. Support for DKV removal.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Key<T>	_key Key mapping a Value which holds this object; may be null

Constructor Summary

Constructors

Constructor and Description
Keyed()
Keyed(Key<T> key)

Method Summary

Modifier and Type	Method and Description
protected long	checksum_impl() High-quality 64-bit checksum of the content of the object.
protected long	checksum_impl(boolean noCache)
long	checksum()
long	checksum(boolean noCache)
Key<T>	getKey()
java.lang.Class<? extends KeyV3>	makeSchema()
protected Keyed	readAll_impl(AutoBuffer ab, Futures fs)
static Keyed	readAll(AutoBuffer ab) Read a Keyed object, and all nested Keys.
protected Futures	remove_impl(Futures fs) Deprecated. Better override remove_impl(Futures, boolean) instead
protected Futures	remove_impl(Futures fs, boolean cascade) Override to remove subparts, but not self, of composite Keyed objects.
protected Futures	remove_self_key_impl(Futures fs) Remove my own key from DKV.
void	remove() Remove this Keyed object, and all subparts; blocking.
void	remove(boolean cascade) Remove this Keyed object, including all subparts if cascade = true; blocking.
Futures	remove(Futures fs) Remove this Keyed object, and all subparts.
Futures	remove(Futures fs, boolean cascade) Remove this Keyed object, including all subparts if cascade = true.
static boolean	remove(Key k) Removes the Keyed object associated to the key, and all subparts; blocking.
static Futures	remove(Key k, Futures fs, boolean cascade) Remove the Keyed object associated to the key, and all subparts.
static void	removeQuietly(Key k)
protected AutoBuffer	writeAll_impl(AutoBuffer ab)
AutoBuffer	writeAll(AutoBuffer ab) Write this Keyed object, and all nested Keys.

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_key

public Key<T extends Keyed> _key

Key mapping a Value which holds this object; may be null

Constructor Detail

Keyed

public Keyed()

Keyed

public Keyed(Key<T> key)

Method Detail

getKey

public Key<T> getKey()

remove

public final void remove()

Remove this Keyed object, and all subparts; blocking.

remove

public final void remove(boolean cascade)

Remove this Keyed object, including all subparts if cascade = true; blocking.

remove

public final Futures remove(Futures fs)

Remove this Keyed object, and all subparts.

remove

public final Futures remove(Futures fs,
                            boolean cascade)

Remove this Keyed object, including all subparts if cascade = true.

remove_impl

@Deprecated
protected Futures remove_impl(Futures fs)

Deprecated. Better override remove_impl(Futures, boolean) instead

remove_impl

protected Futures remove_impl(Futures fs,
                              boolean cascade)

Override to remove subparts, but not self, of composite Keyed objects. Examples include Vec (removing associated Chunk keys) and Frame (removing associated Vec keys.)

remove_self_key_impl

protected Futures remove_self_key_impl(Futures fs)

Remove my own key from DKV.

remove

public static boolean remove(Key k)

Removes the Keyed object associated to the key, and all subparts; blocking.

Returns:

true if there was anything to be removed.

removeQuietly

public static void removeQuietly(Key k)

remove

public static Futures remove(Key k,
                             Futures fs,
                             boolean cascade)

Remove the Keyed object associated to the key, and all subparts.

writeAll

public AutoBuffer writeAll(AutoBuffer ab)

Write this Keyed object, and all nested Keys.

writeAll_impl

protected AutoBuffer writeAll_impl(AutoBuffer ab)

readAll

public static Keyed readAll(AutoBuffer ab)

Read a Keyed object, and all nested Keys. Nested Keys are injected into the K/V store overwriting what was there before.

readAll_impl

protected Keyed readAll_impl(AutoBuffer ab,
                             Futures fs)

checksum_impl

protected long checksum_impl()

High-quality 64-bit checksum of the content of the object. Similar to hashcode(), but a long to reduce the chance of hash clashes. For composite objects this should be defined using the subcomponents' checksums (or hashcodes if not available). If two Keyed objects have the same checksum() there should be a 1 - 1/2^64 chance that they are the same object by value.

checksum_impl

protected long checksum_impl(boolean noCache)

checksum

public final long checksum()

checksum

public final long checksum(boolean noCache)

makeSchema

public java.lang.Class<? extends KeyV3> makeSchema()