Package io.tiledb.java.api

Class Enumeration

java.lang.Object

io.tiledb.java.api.Enumeration

All Implemented Interfaces:

java.lang.AutoCloseable

public class Enumeration
extends java.lang.Object
implements java.lang.AutoCloseable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Enumeration(Context ctx, SWIGTYPE_p_p_tiledb_enumeration_t enumerationpp)
protected	Enumeration(Context ctx, java.lang.String name, long cellValNum, Datatype datatype, boolean ordered, NativeArray data, java.math.BigInteger dataSize, NativeArray offsets, java.math.BigInteger offsetsSize)

Method Summary

Modifier and Type	Method	Description
void	close()	Releases resources
Enumeration	extend(NativeArray data, java.math.BigInteger dataSize, NativeArray offsets, java.math.BigInteger offsetsSize)	Extend an Enumeration.
long	getCellValNum()	Return the cell value number of the enumeration values
java.lang.Object	getData()	Return an Object of the enumerations underlying value data
SWIGTYPE_p_tiledb_enumeration_t	getEnumerationp()	Returns the enumeration object pointer
java.lang.String	getName()	Return the name of the enumeration values
java.lang.Object	getOffsets()	Return an Object of the enumerations underlying value offsets
boolean	getOrdered()	Return whether the enumeration values should be considered ordered
Datatype	getType()	Return the datatype of the enumeration values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Enumeration

protected Enumeration(Context ctx,
                      SWIGTYPE_p_p_tiledb_enumeration_t enumerationpp)

Enumeration

protected Enumeration(Context ctx,
                      java.lang.String name,
                      long cellValNum,
                      Datatype datatype,
                      boolean ordered,
                      NativeArray data,
                      java.math.BigInteger dataSize,
                      NativeArray offsets,
                      java.math.BigInteger offsetsSize)
               throws TileDBError

Throws:

TileDBError

Method Detail

getEnumerationp

public SWIGTYPE_p_tiledb_enumeration_t getEnumerationp()

Returns the enumeration object pointer

Returns:

the enumeration object object pointer

getCellValNum

public long getCellValNum()
                   throws TileDBError

Return the cell value number of the enumeration values

Returns:

The cell value number of the enumeration values

Throws:

TileDBError

getOrdered

public boolean getOrdered()
                   throws TileDBError

Return whether the enumeration values should be considered ordered

Returns:

Whether the enumeration values should be considered ordered

Throws:

TileDBError

extend

public Enumeration extend(NativeArray data,
                          java.math.BigInteger dataSize,
                          NativeArray offsets,
                          java.math.BigInteger offsetsSize)

Extend an Enumeration.

Parameters:

data - A pointer to the enumeration value data to add.

dataSize - The length of the data buffer provided.

offsets - A pointer to the offsets buffer if enumeration is var sized.

offsetsSize - The length of the offsets buffer, zero if no offsets.

getType

public Datatype getType()
                 throws TileDBError

Return the datatype of the enumeration values

Returns:

The datatype of the enumeration values

Throws:

TileDBError

getName

public java.lang.String getName()
                         throws TileDBError

Return the name of the enumeration values

Returns:

The name of the enumeration values

Throws:

TileDBError

getData

public java.lang.Object getData()
                         throws TileDBError

Return an Object of the enumerations underlying value data

Returns:

The enumeration data

Throws:

TileDBError

getOffsets

public java.lang.Object getOffsets()
                            throws TileDBError

Return an Object of the enumerations underlying value offsets

Returns:

The enumeration offsets

Throws:

TileDBError

close

public void close()

Releases resources

Specified by:

close in interface java.lang.AutoCloseable