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:

CsvFileFormat, IpcFileFormat, ParquetFileFormat

@Namespace(value="arrow::dataset")
 @NoOffset
 @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
LongOptionalFuture	CountRows(FileFragment file, Expression predicate, ScanOptions options)
FragmentScanOptions	default_fragment_scan_options() Options affecting how this format is scanned.
FileFormat	default_fragment_scan_options(FragmentScanOptions setter)
FileWriteOptions	DefaultWriteOptions() \brief Get default write options for this format.
boolean	Equals(FileFormat other)
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.
FileFragmentResult	MakeFragment(FileSource source)
FileFragmentResult	MakeFragment(FileSource source, Expression partition_expression) \brief Create a FileFragment for a FileSource.
FileFragmentResult	MakeFragment(FileSource source, Expression partition_expression, Schema physical_schema) \brief Open a fragment
FileFragmentResult	MakeFragment(FileSource source, Schema physical_schema) \brief Create a FileFragment for a FileSource.
FileWriterResult	MakeWriter(OutputStream destination, Schema schema, FileWriteOptions options, FileLocator destination_locator) \brief Create a writer for this format.
RecordBatchGeneratorResult	ScanBatchesAsync(ScanOptions options, FileFragment file)
ScanTaskIteratorResult	ScanFile(ScanOptions options, FileFragment file) \brief Open a FileFragment 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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

FileFormat

public FileFormat(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

default_fragment_scan_options

@SharedPtr
public FragmentScanOptions default_fragment_scan_options()

Options affecting how this format is scanned. The options here can be overridden at scan time.

default_fragment_scan_options

public FileFormat default_fragment_scan_options(FragmentScanOptions setter)

type_name

@StdString
public String type_name()

\brief The name identifying the kind of file format

Equals

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

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(@SharedPtr
                                               ScanOptions options,
                                               @Const @SharedPtr @ByRef
                                               FileFragment file)

\brief Open a FileFragment for scanning. May populate lazy properties of the FileFragment.

ScanBatchesAsync

@ByVal
public RecordBatchGeneratorResult ScanBatchesAsync(@SharedPtr
                                                           ScanOptions options,
                                                           @Const @SharedPtr @ByRef
                                                           FileFragment file)

CountRows

@ByVal
public LongOptionalFuture CountRows(@Const @SharedPtr @ByRef
                                            FileFragment file,
                                            @ByVal
                                            Expression predicate,
                                            @SharedPtr
                                            ScanOptions options)

MakeFragment

@ByVal
public FileFragmentResult MakeFragment(@ByVal
                                               FileSource source,
                                               @ByVal
                                               Expression partition_expression,
                                               @SharedPtr @ByVal
                                               Schema physical_schema)

\brief Open a fragment

MakeFragment

@ByVal
public FileFragmentResult MakeFragment(@ByVal
                                               FileSource source,
                                               @ByVal
                                               Expression partition_expression)

\brief Create a FileFragment for a FileSource.

MakeFragment

@ByVal
public FileFragmentResult MakeFragment(@ByVal
                                               FileSource source,
                                               @SharedPtr @ByVal(nullValue="std::shared_ptr<arrow::Schema>(nullptr)")
                                               Schema physical_schema)

\brief Create a FileFragment for a FileSource.

MakeFragment

@ByVal
public FileFragmentResult MakeFragment(@ByVal
                                               FileSource source)

MakeWriter

@ByVal
public FileWriterResult MakeWriter(@SharedPtr
                                           OutputStream destination,
                                           @SharedPtr @ByVal
                                           Schema schema,
                                           @SharedPtr
                                           FileWriteOptions options,
                                           @ByVal
                                           FileLocator destination_locator)

\brief Create a writer for this format.

DefaultWriteOptions

@SharedPtr
public FileWriteOptions DefaultWriteOptions()

\brief Get default write options for this format.