org.bytedeco.arrow_dataset

Class IpcFileFormat

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_dataset.FileFormat

org.bytedeco.arrow_dataset.IpcFileFormat

All Implemented Interfaces:

AutoCloseable

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

\brief A FileFormat implementation that reads from and writes to Ipc files

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
IpcFileFormat() Default native constructor.
IpcFileFormat(long size) Native array allocator.
IpcFileFormat(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FileWriteOptions	DefaultWriteOptions()
boolean	Equals(FileFormat other)
IpcFileFormat	getPointer(long i)
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.
FileWriterResult	MakeWriter(OutputStream destination, Schema schema, FileWriteOptions options)
IpcFileFormat	position(long position)
ScanTaskIteratorResult	ScanFile(ScanOptions options, ScanContext context, FileFragment fragment) \brief Open a file 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.arrow_dataset.FileFormat

MakeFragment, MakeFragment, MakeFragment, MakeFragment

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

IpcFileFormat

public IpcFileFormat()

Default native constructor.

IpcFileFormat

public IpcFileFormat(long size)

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

IpcFileFormat

public IpcFileFormat(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public IpcFileFormat position(long position)

Overrides:

position in class Pointer

getPointer

public IpcFileFormat getPointer(long i)

Overrides:

getPointer in class Pointer

type_name

@StdString
public String type_name()

Description copied from class: FileFormat

\brief The name identifying the kind of file format

Overrides:

type_name in class FileFormat

Equals

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

Overrides:

Equals in class FileFormat

splittable

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

Description copied from class: FileFormat

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

Overrides:

splittable in class FileFormat

IsSupported

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

Description copied from class: FileFormat

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

Overrides:

IsSupported in class FileFormat

Inspect

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

\brief Return the schema of the file if possible.

Overrides:

Inspect in class FileFormat

ScanFile

@ByVal
public ScanTaskIteratorResult ScanFile(@SharedPtr
                                               ScanOptions options,
                                               @SharedPtr
                                               ScanContext context,
                                               FileFragment fragment)

\brief Open a file for scanning

Overrides:

ScanFile in class FileFormat

MakeWriter

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

Overrides:

MakeWriter in class FileFormat

DefaultWriteOptions

@SharedPtr
public FileWriteOptions DefaultWriteOptions()

Overrides:

DefaultWriteOptions in class FileFormat