org.bytedeco.arrow_dataset

Class FileFormat

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.FileFormat

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

IpcFileFormat, ParquetFileFormat

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

\brief Base class for file format implementation

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
FileFormat(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
SchemaResult	Inspect(FileSource source) \brief Return the schema of the file if possible.
BoolResult	IsSupported(FileSource source) \brief Indicate if the FileSource is supported/readable by this format.
FragmentResult	MakeFragment(FileSource location, ScanOptions options) \brief Open a fragment
ScanTaskIteratorResult	ScanFile(FileSource source, ScanOptions options, ScanContext context) \brief Open a file for scanning
String	type_name() \brief The name identifying the kind of file format

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFormat

public FileFormat(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

type_name

@StdString
public String type_name()

\brief The name identifying the kind of file format

IsSupported

@ByVal
public BoolResult IsSupported(@Const @ByRef
                                     FileSource source)

\brief Indicate if the FileSource is supported/readable by this format.

Inspect

@ByVal
public SchemaResult Inspect(@Const @ByRef
                                   FileSource source)

\brief Return the schema of the file if possible.

ScanFile

@ByVal
public ScanTaskIteratorResult ScanFile(@Const @ByRef
                                              FileSource source,
                                              @SharedPtr
                                              ScanOptions options,
                                              @SharedPtr
                                              ScanContext context)

\brief Open a file for scanning

MakeFragment

@ByVal
public FragmentResult MakeFragment(@Const @ByRef
                                          FileSource location,
                                          @SharedPtr
                                          ScanOptions options)

\brief Open a fragment