org.bytedeco.arrow

Class TableWriter

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.TableWriter

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::ipc::feather")
 @NoOffset
 @Properties(inherit=arrow.class)
public class TableWriter
extends Pointer

\class TableWriter \brief Interface for writing Feather 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
TableWriter(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append(BytePointer name, Array values)
Status	Append(String name, Array values) \brief Append a column to the file
Status	Finalize() \brief Finalize the file by writing the file metadata and footer
static Status	Open(OutputStream stream, TableWriter out) \brief Create a new TableWriter that writes to an OutputStream
void	SetDescription(BytePointer desc)
void	SetDescription(String desc) \brief Set the description field in the file metadata
void	SetNumRows(long num_rows) \brief Set the number of rows in the file
Status	Write(Table table) \brief Write a table to the file

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

TableWriter

public TableWriter(Pointer p)

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

Method Detail

Open

@ByVal
public static Status Open(@SharedPtr
                                 OutputStream stream,
                                 @UniquePtr
                                 TableWriter out)

\brief Create a new TableWriter that writes to an OutputStream

Parameters:

stream - [in] an output stream

out - [out] the returned table writer

Returns:

Status

SetDescription

public void SetDescription(@StdString
                           String desc)

\brief Set the description field in the file metadata

SetDescription

public void SetDescription(@StdString
                           BytePointer desc)

SetNumRows

public void SetNumRows(@Cast(value="int64_t")
                       long num_rows)

\brief Set the number of rows in the file

Append

@ByVal
public Status Append(@StdString
                            String name,
                            @Const @ByRef
                            Array values)

\brief Append a column to the file

Parameters:

name - [in] the column name

values - [in] the column values as a contiguous arrow::Array

Returns:

Status

Append

@ByVal
public Status Append(@StdString
                            BytePointer name,
                            @Const @ByRef
                            Array values)

Write

@ByVal
public Status Write(@Const @ByRef
                           Table table)

\brief Write a table to the file

Parameters:

table - [in] the table to be written

Returns:

Status

Finalize

@ByVal
public Status Finalize()

\brief Finalize the file by writing the file metadata and footer

Returns:

Status