org.bytedeco.arrow

Class SubTreeFileSystem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileSystem

org.bytedeco.arrow.SubTreeFileSystem

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::fs")
 @NoOffset
 @Properties(inherit=arrow.class)
public class SubTreeFileSystem
extends FileSystem

\brief A FileSystem implementation that delegates to another implementation after prepending a fixed base path. This is useful to expose a logical view of a subtree of a filesystem, for example a directory in a LocalFileSystem. This works on abstract paths, i.e. paths using forward slashes and and a single root "/". Windows paths are not guaranteed to work. This makes no security guarantee. For example, symlinks may allow to "escape" the subtree and access other parts of the underlying filesystem.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
SubTreeFileSystem(BytePointer base_path, FileSystem base_fs)
SubTreeFileSystem(Pointer p) Pointer cast constructor.
SubTreeFileSystem(String base_path, FileSystem base_fs)

Method Summary

Modifier and Type	Method and Description
FileSystem	base_fs()
String	base_path()
Status	CopyFile(BytePointer src, BytePointer dest)
Status	CopyFile(String src, String dest) Copy a file.
Status	CreateDir(BytePointer path)
Status	CreateDir(BytePointer path, boolean recursive)
Status	CreateDir(String path)
Status	CreateDir(String path, boolean recursive) Create a directory and subdirectories.
Status	DeleteDir(BytePointer path)
Status	DeleteDir(String path) Delete a directory and its contents, recursively.
Status	DeleteDirContents(BytePointer path)
Status	DeleteDirContents(String path) Delete a directory's contents, recursively.
Status	DeleteFile(BytePointer path)
Status	DeleteFile(String path) Delete a file.
Status	DeleteRootDirContents() EXPERIMENTAL: Delete the root directory's contents, recursively.
boolean	Equals(FileSystem other)
FileInfoResult	GetFileInfo(BytePointer path)
FileInfoVectorResult	GetFileInfo(FileSelector select) Same, according to a selector.
FileInfoResult	GetFileInfo(String path) \endcond
Pointer	GetFileInfoGenerator(FileSelector select) Streaming async version of GetFileInfo The returned generator is not async-reentrant, i.e.
Status	Move(BytePointer src, BytePointer dest)
Status	Move(String src, String dest) Move / rename a file or directory.
StringResult	NormalizePath(BytePointer path)
StringResult	NormalizePath(String path) Normalize path for the given filesystem The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).
OutputStreamResult	OpenAppendStream(BytePointer path)
OutputStreamResult	OpenAppendStream(BytePointer path, KeyValueMetadata metadata)
OutputStreamResult	OpenAppendStream(String path)
OutputStreamResult	OpenAppendStream(String path, KeyValueMetadata metadata) Open an output stream for appending.
RandomAccessFileResult	OpenInputFile(BytePointer path)
RandomAccessFileResult	OpenInputFile(FileInfo info) Open an input file for random access reading.
RandomAccessFileResult	OpenInputFile(String path) Open an input file for random access reading.
RandomAccessFileFuture	OpenInputFileAsync(BytePointer path)
RandomAccessFileFuture	OpenInputFileAsync(FileInfo info) Async version of OpenInputFile
RandomAccessFileFuture	OpenInputFileAsync(String path) Async version of OpenInputFile
InputStreamResult	OpenInputStream(BytePointer path)
InputStreamResult	OpenInputStream(FileInfo info) Open an input stream for sequential reading.
InputStreamResult	OpenInputStream(String path) Open an input stream for sequential reading.
InputStreamFuture	OpenInputStreamAsync(BytePointer path)
InputStreamFuture	OpenInputStreamAsync(FileInfo info) Async version of OpenInputStream
InputStreamFuture	OpenInputStreamAsync(String path) Async version of OpenInputStream
OutputStreamResult	OpenOutputStream(BytePointer path)
OutputStreamResult	OpenOutputStream(BytePointer path, KeyValueMetadata metadata)
OutputStreamResult	OpenOutputStream(String path)
OutputStreamResult	OpenOutputStream(String path, KeyValueMetadata metadata) Open an output stream for sequential writing.
String	type_name()

Methods inherited from class org.bytedeco.arrow.FileSystem

DeleteFiles, GetFileInfo, GetFileInfoAsync, io_context

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

SubTreeFileSystem

public SubTreeFileSystem(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

SubTreeFileSystem

public SubTreeFileSystem(@StdString
                         String base_path,
                         @SharedPtr
                         FileSystem base_fs)

SubTreeFileSystem

public SubTreeFileSystem(@StdString
                         BytePointer base_path,
                         @SharedPtr
                         FileSystem base_fs)

Method Detail

type_name

@StdString
public String type_name()

Overrides:

type_name in class FileSystem

base_path

@StdString
public String base_path()

base_fs

@SharedPtr
public FileSystem base_fs()

NormalizePath

@ByVal
public StringResult NormalizePath(@StdString
                                          String path)

Description copied from class: FileSystem

Normalize path for the given filesystem The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).

Overrides:

NormalizePath in class FileSystem

NormalizePath

@ByVal
public StringResult NormalizePath(@StdString
                                          BytePointer path)

Overrides:

NormalizePath in class FileSystem

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           FileSystem other)

Overrides:

Equals in class FileSystem

GetFileInfo

@ByVal
public FileInfoResult GetFileInfo(@StdString
                                          String path)

\endcond

Overrides:

GetFileInfo in class FileSystem

GetFileInfo

@ByVal
public FileInfoResult GetFileInfo(@StdString
                                          BytePointer path)

Overrides:

GetFileInfo in class FileSystem

GetFileInfo

@ByVal
public FileInfoVectorResult GetFileInfo(@Const @ByRef
                                                FileSelector select)

Description copied from class: FileSystem

Same, according to a selector. The selector's base directory will not be part of the results, even if it exists. If it doesn't exist, see FileSelector::allow_not_found.

Overrides:

GetFileInfo in class FileSystem

GetFileInfoGenerator

@ByVal
 @Cast(value="arrow::fs::FileInfoGenerator*")
public Pointer GetFileInfoGenerator(@Const @ByRef
                                                                                           FileSelector select)

Description copied from class: FileSystem

Streaming async version of GetFileInfo The returned generator is not async-reentrant, i.e. you need to wait for the returned future to complete before calling the generator again.

Overrides:

GetFileInfoGenerator in class FileSystem

CreateDir

@ByVal
public Status CreateDir(@StdString
                                String path,
                                @Cast(value="bool")
                                boolean recursive)

Description copied from class: FileSystem

Create a directory and subdirectories. This function succeeds if the directory already exists.

Overrides:

CreateDir in class FileSystem

CreateDir

@ByVal
public Status CreateDir(@StdString
                                String path)

Overrides:

CreateDir in class FileSystem

CreateDir

@ByVal
public Status CreateDir(@StdString
                                BytePointer path,
                                @Cast(value="bool")
                                boolean recursive)

Overrides:

CreateDir in class FileSystem

CreateDir

@ByVal
public Status CreateDir(@StdString
                                BytePointer path)

Overrides:

CreateDir in class FileSystem

DeleteDir

@ByVal
public Status DeleteDir(@StdString
                                String path)

Description copied from class: FileSystem

Delete a directory and its contents, recursively.

Overrides:

DeleteDir in class FileSystem

DeleteDir

@ByVal
public Status DeleteDir(@StdString
                                BytePointer path)

Overrides:

DeleteDir in class FileSystem

DeleteDirContents

@ByVal
public Status DeleteDirContents(@StdString
                                        String path)

Description copied from class: FileSystem

Delete a directory's contents, recursively. Like DeleteDir, but doesn't delete the directory itself. Passing an empty path ("" or "/") is disallowed, see DeleteRootDirContents.

Overrides:

DeleteDirContents in class FileSystem

DeleteDirContents

@ByVal
public Status DeleteDirContents(@StdString
                                        BytePointer path)

Overrides:

DeleteDirContents in class FileSystem

DeleteRootDirContents

@ByVal
public Status DeleteRootDirContents()

Description copied from class: FileSystem

EXPERIMENTAL: Delete the root directory's contents, recursively. Implementations may decide to raise an error if this operation is too dangerous.

Overrides:

DeleteRootDirContents in class FileSystem

DeleteFile

@ByVal
public Status DeleteFile(@StdString
                                 String path)

Description copied from class: FileSystem

Delete a file.

Overrides:

DeleteFile in class FileSystem

DeleteFile

@ByVal
public Status DeleteFile(@StdString
                                 BytePointer path)

Overrides:

DeleteFile in class FileSystem

Move

@ByVal
public Status Move(@StdString
                           String src,
                           @StdString
                           String dest)

Description copied from class: FileSystem

Move / rename a file or directory. If the destination exists: - if it is a non-empty directory, an error is returned - otherwise, if it has the same type as the source, it is replaced - otherwise, behavior is unspecified (implementation-dependent).

Overrides:

Move in class FileSystem

Move

@ByVal
public Status Move(@StdString
                           BytePointer src,
                           @StdString
                           BytePointer dest)

Overrides:

Move in class FileSystem

CopyFile

@ByVal
public Status CopyFile(@StdString
                               String src,
                               @StdString
                               String dest)

Description copied from class: FileSystem

Copy a file. If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

Overrides:

CopyFile in class FileSystem

CopyFile

@ByVal
public Status CopyFile(@StdString
                               BytePointer src,
                               @StdString
                               BytePointer dest)

Overrides:

CopyFile in class FileSystem

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@StdString
                                                 String path)

Description copied from class: FileSystem

Open an input stream for sequential reading.

Overrides:

OpenInputStream in class FileSystem

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@StdString
                                                 BytePointer path)

Overrides:

OpenInputStream in class FileSystem

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@Const @ByRef
                                                 FileInfo info)

Description copied from class: FileSystem

Open an input stream for sequential reading. This override assumes the given FileInfo validly represents the file's characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

Overrides:

OpenInputStream in class FileSystem

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@StdString
                                                    String path)

Description copied from class: FileSystem

Open an input file for random access reading.

Overrides:

OpenInputFile in class FileSystem

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@StdString
                                                    BytePointer path)

Overrides:

OpenInputFile in class FileSystem

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@Const @ByRef
                                                    FileInfo info)

Description copied from class: FileSystem

Open an input file for random access reading. This override assumes the given FileInfo validly represents the file's characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

Overrides:

OpenInputFile in class FileSystem

OpenInputStreamAsync

@ByVal
public InputStreamFuture OpenInputStreamAsync(@StdString
                                                      String path)

Description copied from class: FileSystem

Async version of OpenInputStream

Overrides:

OpenInputStreamAsync in class FileSystem

OpenInputStreamAsync

@ByVal
public InputStreamFuture OpenInputStreamAsync(@StdString
                                                      BytePointer path)

Overrides:

OpenInputStreamAsync in class FileSystem

OpenInputStreamAsync

@ByVal
public InputStreamFuture OpenInputStreamAsync(@Const @ByRef
                                                      FileInfo info)

Description copied from class: FileSystem

Async version of OpenInputStream

Overrides:

OpenInputStreamAsync in class FileSystem

OpenInputFileAsync

@ByVal
public RandomAccessFileFuture OpenInputFileAsync(@StdString
                                                         String path)

Description copied from class: FileSystem

Async version of OpenInputFile

Overrides:

OpenInputFileAsync in class FileSystem

OpenInputFileAsync

@ByVal
public RandomAccessFileFuture OpenInputFileAsync(@StdString
                                                         BytePointer path)

Overrides:

OpenInputFileAsync in class FileSystem

OpenInputFileAsync

@ByVal
public RandomAccessFileFuture OpenInputFileAsync(@Const @ByRef
                                                         FileInfo info)

Description copied from class: FileSystem

Async version of OpenInputFile

Overrides:

OpenInputFileAsync in class FileSystem

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   String path,
                                                   @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                   KeyValueMetadata metadata)

Description copied from class: FileSystem

Open an output stream for sequential writing. If the target already exists, existing data is truncated.

Overrides:

OpenOutputStream in class FileSystem

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   String path)

Overrides:

OpenOutputStream in class FileSystem

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   BytePointer path,
                                                   @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                   KeyValueMetadata metadata)

Overrides:

OpenOutputStream in class FileSystem

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   BytePointer path)

Overrides:

OpenOutputStream in class FileSystem

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   String path,
                                                   @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                   KeyValueMetadata metadata)

Description copied from class: FileSystem

Open an output stream for appending. If the target doesn't exist, a new empty file is created.

Overrides:

OpenAppendStream in class FileSystem

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   String path)

Overrides:

OpenAppendStream in class FileSystem

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   BytePointer path,
                                                   @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                   KeyValueMetadata metadata)

Overrides:

OpenAppendStream in class FileSystem

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   BytePointer path)

Overrides:

OpenAppendStream in class FileSystem