org.bytedeco.arrow

Class FieldPath

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FieldPath

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class FieldPath
extends Pointer

\class FieldPath Represents a path to a nested field using indices of child fields. For example, given indices {5, 9, 3} the field would be retrieved with schema->field(5)->type()->field(9)->type()->field(3) Attempting to retrieve a child field using a FieldPath which is not valid for a given schema will raise an error. Invalid FieldPaths include: - an index is out of range - the path is empty (note: a default constructed FieldPath will be empty) FieldPaths provide a number of accessors for drilling down to potentially nested children. They are overloaded for convenience to support Schema (returns a field), DataType (returns a child field), Field (returns a child field of this field's type) Array (returns a child array), RecordBatch (returns a column).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldPath.Hash

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
FieldPath()
FieldPath(int[] indices)
FieldPath(IntBuffer indices)
FieldPath(IntPointer indices)
FieldPath(long size) Native array allocator.
FieldPath(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
IntPointer	begin()
boolean	empty()
IntPointer	end()
boolean	equals(FieldPath other)
int	get(long i)
FieldPath	getPointer(long i)
long	hash()
IntPointer	indices()
boolean	notEquals(FieldPath other)
FieldPath	position(long position)
String	ToString()

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

FieldPath

public FieldPath(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FieldPath

public FieldPath(long size)

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

FieldPath

public FieldPath()

FieldPath

public FieldPath(@StdVector
                 IntPointer indices)

FieldPath

public FieldPath(@StdVector
                 IntBuffer indices)

FieldPath

public FieldPath(@StdVector
                 int[] indices)

Method Detail

position

public FieldPath position(long position)

Overrides:

position in class Pointer

getPointer

public FieldPath getPointer(long i)

Overrides:

getPointer in class Pointer

ToString

@StdString
public String ToString()

hash

@Cast(value="size_t")
public long hash()

empty

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

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                        FieldPath other)

notEquals

@Cast(value="bool")
 @Name(value="operator !=")
public boolean notEquals(@Const @ByRef
                                                                           FieldPath other)

indices

@StdVector
public IntPointer indices()

get

@Name(value="operator []")
public int get(@Cast(value="size_t")
                                           long i)

begin

@ByVal
 @Cast(value="std::vector<int>::const_iterator*")
public IntPointer begin()

end

@ByVal
 @Cast(value="std::vector<int>::const_iterator*")
public IntPointer end()