Package io.deephaven.kv.files

Class FilesContext

java.lang.Object

io.deephaven.kv.KeyPathContextBase

io.deephaven.kv.meta.AtomicDirectoryContext

io.deephaven.kv.files.FilesContext

All Implemented Interfaces:

Context, KeyPathContext

Direct Known Subclasses:

PersistentQueriesContext

public class FilesContext
extends AtomicDirectoryContext

A dynamic KeyPath model around a list of files. Each file in the path is modelled by a FileContext.

Models the data in FilesInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FilesContext.FileIdentifiers
class	FilesContext.Files
static interface	FilesContext.FilesListener
static interface	FilesContext.GetFileIdentifiersRequest
static interface	FilesContext.GetFilesRequest

Nested classes/interfaces inherited from class io.deephaven.kv.meta.AtomicDirectoryContext

AtomicDirectoryContext.AtomicUpdateWrt, AtomicDirectoryContext.MetaDescription

Field Summary

Fields inherited from class io.deephaven.kv.meta.AtomicDirectoryContext

META, META_PART, parent

Fields inherited from class io.deephaven.kv.KeyPathContextBase

context, description

Constructor Summary

Constructors

Constructor	Description
FilesContext(AtomicDirectoryContext parent, KeyPath context)
FilesContext(AtomicDirectoryContext parent, String part)

Method Summary

Modifier and Type	Method	Description
FilesContext.FileIdentifiers	asFileIdentifiers()
FilesContext.Files	asFiles()
AtomicDirectoryContext.AtomicUpdateWrt	atomic(UpdateInfo info, Collection<FileInfo> files, Composable onFailure)	Atomic update of files in this directory.
AtomicDirectoryContext.AtomicUpdateWrt	atomic(UpdateInfo info, Collection<FileInfo> files, Collection<String> toRemove, Composable onFailure)	Atomic update plus remove of files in this directory.
AtomicDirectoryContext.AtomicUpdateWrt	atomicDelete(@NotNull UpdateInfo info, @NotNull Collection<String> filenames)	Atomic delete of files in this directory.
static <T extends AtomicDirectoryContext> KeyPathContextDescription.Entry<FilesContext,T>	entry(String part)
Composable	getAtomicChanges(UpdateInfo info, Collection<FileInfo> files, Collection<String> toRemove)	Changes comprising atomic update plus remove of files in this directory.
FileContext	getFileContext(String name)
CompletableFuture<WatchClient.Watch>	watch(KVClient kvClient, WatchClient watchClient, FilesContext.FilesListener listener)

Methods inherited from class io.deephaven.kv.meta.AtomicDirectoryContext

asDelete, atomic, atomicDelete, atomicDeleteChildren, expectNewWrtThis, expectUpdateWrtThis, getMetaInfoContext, getMetaInfoContext, getReadPermissions, getReadWritePaths, getReadWritePermissions, isLowestLevelAtomicDirectory, isMetaPart, isNotMeta, parseDirectoryListing, parseDirectoryListingStream, parseDirectoryListingStreamToSubset, watch, watch, watch, wrtAtomicConditionIsTrueHandleUs

Methods inherited from class io.deephaven.kv.KeyPathContextBase

equals, getDescription, getPath, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.kv.KeyPathContext

resolve

Constructor Details

FilesContext

public FilesContext(AtomicDirectoryContext parent,
 String part)

FilesContext

public FilesContext(AtomicDirectoryContext parent,
 KeyPath context)

Method Details

entry

public static <T extends AtomicDirectoryContext>
KeyPathContextDescription.Entry<FilesContext,T> entry(String part)

getFileContext

public FileContext getFileContext(String name)

atomic

public AtomicDirectoryContext.AtomicUpdateWrt atomic(UpdateInfo info,
 Collection<FileInfo> files,
 Composable onFailure)

Atomic update of files in this directory.

Parameters:

info - info about the requested update

files - the files to update

onFailure - what to do if the update fails

Returns:

the AtomicUpdateWrt

atomic

public AtomicDirectoryContext.AtomicUpdateWrt atomic(UpdateInfo info,
 Collection<FileInfo> files,
 Collection<String> toRemove,
 Composable onFailure)

Atomic update plus remove of files in this directory.

Parameters:

info - info about the requested update

files - the files to update

toRemove - the files to remove

onFailure - what to do if the update fails

Returns:

the AtomicUpdateWrt

getAtomicChanges

public Composable getAtomicChanges(UpdateInfo info,
 Collection<FileInfo> files,
 Collection<String> toRemove)

Changes comprising atomic update plus remove of files in this directory.

Parameters:

info - info about the requested update

files - the files to update

toRemove - the files to remove

Returns:

the changes that will go into an AtomicUpdateWrt

atomicDelete

public AtomicDirectoryContext.AtomicUpdateWrt atomicDelete(@NotNull
 @NotNull UpdateInfo info,
 @NotNull
 @NotNull Collection<String> filenames)

Atomic delete of files in this directory.

Parameters:

info - info about the requested update

filenames - the names of files to delete

Returns:

the AtomicUpdateWrt

asFiles

public FilesContext.Files asFiles()

asFileIdentifiers

public FilesContext.FileIdentifiers asFileIdentifiers()

watch

public CompletableFuture<WatchClient.Watch> watch(KVClient kvClient,
 WatchClient watchClient,
 FilesContext.FilesListener listener)