org.bytedeco.arrow_dataset

Class FileSource

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.FileSource

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::dataset")
 @NoOffset
 @Properties(inherit=arrow_dataset.class)
public class FileSource
extends Pointer

\defgroup dataset-file-formats File formats for reading and writing datasets \defgroup dataset-filesystem File system datasets \{

\brief The path and filesystem where an actual file is located or a buffer which can be read like a file

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
FileSource()
FileSource(arrow_dataset.CustomOpenWithCompression open)
FileSource(ArrowBuffer buffer)
FileSource(ArrowBuffer buffer, Compression.type compression)
FileSource(ArrowBuffer buffer, int compression)
FileSource(BytePointer path, FileSystem filesystem)
FileSource(BytePointer path, FileSystem filesystem, int compression)
FileSource(FileInfo info, FileSystem filesystem)
FileSource(FileInfo info, FileSystem filesystem, Compression.type compression)
FileSource(FileInfo info, FileSystem filesystem, int compression)
FileSource(long size) Native array allocator.
FileSource(Pointer open_with_compression)
FileSource(Pointer open_with_compression, Compression.type compression)
FileSource(Pointer open_with_compression, int compression)
FileSource(RandomAccessFile file)
FileSource(RandomAccessFile file, Compression.type compression)
FileSource(RandomAccessFile file, int compression)
FileSource(String path, FileSystem filesystem)
FileSource(String path, FileSystem filesystem, Compression.type compression)

Method Summary

Modifier and Type	Method and Description
ArrowBuffer	buffer() \brief Return the buffer containing the file, if any.
Compression.type	compression() \brief Return the type of raw compression on the file, if any.
FileSystem	filesystem() \brief Return the filesystem, if any.
static FileSource	FromPaths(FileSystem fs, StringVector paths)
FileSource	getPointer(long i)
RandomAccessFileResult	Open() \brief Get a RandomAccessFile which views this file source
InputStreamResult	OpenCompressed()
InputStreamResult	OpenCompressed(CompressionTypeOptional compression) \brief Get an InputStream which views this file source (and decompresses if needed)
String	path() \brief Return the file path, if any.
FileSource	position(long position)

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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

FileSource

public FileSource(long size)

Native array allocator. Access with Pointer.position(long).

FileSource

public FileSource(@StdString
                  String path,
                  @SharedPtr
                  FileSystem filesystem,
                  Compression.type compression)

FileSource

public FileSource(@StdString
                  String path,
                  @SharedPtr
                  FileSystem filesystem)

FileSource

public FileSource(@StdString
                  BytePointer path,
                  @SharedPtr
                  FileSystem filesystem,
                  @Cast(value="arrow::Compression::type")
                  int compression)

FileSource

public FileSource(@StdString
                  BytePointer path,
                  @SharedPtr
                  FileSystem filesystem)

FileSource

public FileSource(@ByVal
                  FileInfo info,
                  @SharedPtr
                  FileSystem filesystem,
                  Compression.type compression)

FileSource

public FileSource(@ByVal
                  FileInfo info,
                  @SharedPtr
                  FileSystem filesystem)

FileSource

public FileSource(@ByVal
                  FileInfo info,
                  @SharedPtr
                  FileSystem filesystem,
                  @Cast(value="arrow::Compression::type")
                  int compression)

FileSource

public FileSource(@SharedPtr
                  ArrowBuffer buffer,
                  Compression.type compression)

FileSource

public FileSource(@SharedPtr
                  ArrowBuffer buffer)

FileSource

public FileSource(@SharedPtr
                  ArrowBuffer buffer,
                  @Cast(value="arrow::Compression::type")
                  int compression)

FileSource

public FileSource(@ByVal @Cast(value="arrow::dataset::FileSource::CustomOpen*")
                  arrow_dataset.CustomOpenWithCompression open)

FileSource

public FileSource(@ByVal @Cast(value="arrow::dataset::FileSource::CustomOpenWithCompression*")
                  Pointer open_with_compression,
                  Compression.type compression)

FileSource

public FileSource(@ByVal @Cast(value="arrow::dataset::FileSource::CustomOpenWithCompression*")
                  Pointer open_with_compression)

FileSource

public FileSource(@ByVal @Cast(value="arrow::dataset::FileSource::CustomOpenWithCompression*")
                  Pointer open_with_compression,
                  @Cast(value="arrow::Compression::type")
                  int compression)

FileSource

public FileSource(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::io::RandomAccessFile>"})
                  RandomAccessFile file,
                  Compression.type compression)

FileSource

public FileSource(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::io::RandomAccessFile>"})
                  RandomAccessFile file)

FileSource

public FileSource(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::io::RandomAccessFile>"})
                  RandomAccessFile file,
                  @Cast(value="arrow::Compression::type")
                  int compression)

FileSource

public FileSource()

Method Detail

position

public FileSource position(long position)

Overrides:

position in class Pointer

getPointer

public FileSource getPointer(long i)

Overrides:

getPointer in class Pointer

FromPaths

@StdVector
public static FileSource FromPaths(@SharedPtr
                                               FileSystem fs,
                                               @ByVal
                                               StringVector paths)

compression

public Compression.type compression()

\brief Return the type of raw compression on the file, if any.

path

@StdString
public String path()

\brief Return the file path, if any. Only valid when file source wraps a path.

filesystem

@SharedPtr
public FileSystem filesystem()

\brief Return the filesystem, if any. Otherwise returns nullptr

buffer

@SharedPtr
public ArrowBuffer buffer()

\brief Return the buffer containing the file, if any. Otherwise returns nullptr

Open

@ByVal
public RandomAccessFileResult Open()

\brief Get a RandomAccessFile which views this file source

OpenCompressed

@ByVal
public InputStreamResult OpenCompressed(@ByVal(nullValue="arrow::util::optional<arrow::Compression::type>(util::nullopt)")
                                                CompressionTypeOptional compression)

\brief Get an InputStream which views this file source (and decompresses if needed)

Parameters:

compression - [in] If nullopt, guess the compression scheme from the filename, else decompress with the given codec

OpenCompressed

@ByVal
public InputStreamResult OpenCompressed()