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")
 @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
FileWriteOptions	DefaultWriteOptions()
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)
FileFragmentResult	MakeFragment(FileSource source, Expression partition_expression, Schema physical_schema) \brief Open a fragment
FileFragmentResult	MakeFragment(FileSource source, Schema physical_schema)
FileWriterResult	MakeWriter(OutputStream destination, Schema schema, FileWriteOptions options)
ScanTaskIteratorResult	ScanFile(ScanOptions options, ScanContext context, FileFragment file) \brief Open a FileFragment for scanning.
boolean	splittable() \brief Return true if fragments of this format can benefit from parallel 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, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, 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

FileFormat

public FileFormat(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

type_name

@StdString
public String type_name()

\brief The name identifying the kind of file format

splittable

@Cast(value="bool")
public boolean splittable()

\brief Return true if fragments of this format can benefit from parallel scanning.

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,
                                               @SharedPtr
                                               ScanContext context,
                                               FileFragment file)

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

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)

MakeFragment

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

MakeFragment

@ByVal
public FileFragmentResult MakeFragment(@ByVal
                                               FileSource source)

MakeWriter

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

DefaultWriteOptions

@SharedPtr
public FileWriteOptions DefaultWriteOptions()