water.api

Class FramesHandler<I extends FramesHandler.Frames,S extends SchemaV3<I,S>>

java.lang.Object

jsr166y.ForkJoinTask<java.lang.Void>

jsr166y.CountedCompleter

water.H2O.H2OCountedCompleter<Handler>

water.api.Handler

water.api.FramesHandler<I,S>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.concurrent.Future<java.lang.Void>, Freezable<Handler>

public class FramesHandler<I extends FramesHandler.Frames,S extends SchemaV3<I,S>>
extends Handler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FramesHandler.Frames Class which contains the internal representation of the frames list and params.

Constructor Summary

Constructors

Constructor and Description
FramesHandler()

Method Summary

Modifier and Type	Method and Description
FramesV3	column(int version, FramesV3 s) Return a single column from the frame.
FramesV3	columnDomain(int version, FramesV3 s)
FramesV3	columns(int version, FramesV3 s)
FramesV3	columnSummary(int version, FramesV3 s)
FramesV3	delete(int version, FramesV3 frames) Remove an unlocked frame.
FramesV3	deleteAll(int version, FramesV3 frames) Remove ALL an unlocked frames.
FramesV3	export(int version, FramesV3 s) Export a single frame to the specified path.
FramesV3	fetch(int version, FramesV3 s) Return a single frame.
FramesV3	fetchLight(int version, FramesV3 s)
static Frame	getFromDKV(java.lang.String param_name, Key key)
static Frame	getFromDKV(java.lang.String param_name, java.lang.String key_str)
FramesListV3	list(int version, FramesListV3 s) Return all the frames.
FramesV3	summary(int version, FramesV3 s)

Methods inherited from class water.api.Handler

getFromDKV, getFromDKV, getHandlerMethodInputSchema, getHandlerMethodOutputSchema, handle, markdown

Methods inherited from class water.H2O.H2OCountedCompleter

asBytes, clone, compute, compute1, compute2, currThrPriority, frozenType, icer, priority, read, readJSON, reloadFromBytes, write, writeJSON

Methods inherited from class jsr166y.CountedCompleter

__tryComplete, addToPendingCount, compareAndSetPendingCount, complete, exec, getCompleter, getPendingCount, getRawResult, onCompletion, onExceptionalCompletion, setCompleter, setPendingCount, setRawResult, tryComplete

Methods inherited from class jsr166y.ForkJoinTask

adapt, adapt, adapt, cancel, compareAndSetForkJoinTaskTag, completeExceptionally, fork, get, get, getException, getForkJoinTaskTag, getPool, getQueuedTaskCount, getSurplusQueuedTaskCount, helpQuiesce, inForkJoinPool, invoke, invokeAll, invokeAll, invokeAll, isCancelled, isCompletedAbnormally, isCompletedNormally, isDone, join, peekNextLocalTask, pollNextLocalTask, pollTask, quietlyComplete, quietlyInvoke, quietlyJoin, reinitialize, setForkJoinTaskTag, tryUnfork

Methods inherited from class java.lang.Object

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

Constructor Detail

FramesHandler

public FramesHandler()

Method Detail

list

public FramesListV3 list(int version,
                         FramesListV3 s)

Return all the frames. The Frames list will be instances of FrameSynopsisV3, which only contains a few fields, for performance reasons.

See Also:

FrameSynopsisV3

columns

public FramesV3 columns(int version,
                        FramesV3 s)

getFromDKV

public static Frame getFromDKV(java.lang.String param_name,
                               java.lang.String key_str)

getFromDKV

public static Frame getFromDKV(java.lang.String param_name,
                               Key key)

column

public FramesV3 column(int version,
                       FramesV3 s)

Return a single column from the frame.

columnDomain

public FramesV3 columnDomain(int version,
                             FramesV3 s)

columnSummary

public FramesV3 columnSummary(int version,
                              FramesV3 s)

fetch

public FramesV3 fetch(int version,
                      FramesV3 s)

Return a single frame.

fetchLight

public FramesV3 fetchLight(int version,
                           FramesV3 s)

export

public FramesV3 export(int version,
                       FramesV3 s)

Export a single frame to the specified path.

summary

public FramesV3 summary(int version,
                        FramesV3 s)

delete

public FramesV3 delete(int version,
                       FramesV3 frames)

Remove an unlocked frame. Fails if frame is in-use.

deleteAll

public FramesV3 deleteAll(int version,
                          FramesV3 frames)

Remove ALL an unlocked frames. Throws IAE for all deletes that failed (perhaps because the Frames were locked & in-use).