Package io.tiledb.java.api

Class DimensionLabel

java.lang.Object

io.tiledb.java.api.DimensionLabel

All Implemented Interfaces:

java.lang.AutoCloseable

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	DimensionLabel(Context ctx, long dimIndex, java.lang.String name, tiledb_data_order_t labelOrder, tiledb_datatype_t labelType)	Constructor
protected	DimensionLabel(Context ctx, SWIGTYPE_p_p_tiledb_dimension_label_handle_t dimlabelpp)	Constructor

Method Summary

Modifier and Type	Method	Description
void	close()
protected Context	getCtx()
long	getDimensionIndex()	Returns the index of the dimension the DimensionLabel provides labels for
protected SWIGTYPE_p_tiledb_dimension_label_handle_t	getDimLabelp()
java.lang.String	getLabelAttrName()	Returns the name of the attribute the label data is stored on
long	getLabelCellValNum()	Returns the number of values per cell for the labels on the dimension label For variable-sized labels the result is TILEDB_VAR_NUM
tiledb_data_order_t	getLabelOrder()	Returns the order of the labels on the dimension label
Datatype	getLabelType()	Returns the type of the labels on the dimension label
java.lang.String	getName()	Returns the name of the DimensionLabel
java.lang.String	getURI()	Returns the URI of the dimension label array

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionLabel

public DimensionLabel(Context ctx,
                      long dimIndex,
                      java.lang.String name,
                      tiledb_data_order_t labelOrder,
                      tiledb_datatype_t labelType)

Constructor

DimensionLabel

protected DimensionLabel(Context ctx,
                         SWIGTYPE_p_p_tiledb_dimension_label_handle_t dimlabelpp)

Constructor

Method Detail

getDimLabelp

protected SWIGTYPE_p_tiledb_dimension_label_handle_t getDimLabelp()

getCtx

protected Context getCtx()

getDimensionIndex

public long getDimensionIndex()
                       throws TileDBError

Returns the index of the dimension the DimensionLabel provides labels for

Returns:

The dimension index

Throws:

TileDBError

getName

public java.lang.String getName()
                         throws TileDBError

Returns the name of the DimensionLabel

Returns:

The name of the DimensionLabel

Throws:

TileDBError

getLabelAttrName

public java.lang.String getLabelAttrName()
                                  throws TileDBError

Returns the name of the attribute the label data is stored on

Returns:

The name of the attribute

Throws:

TileDBError

getLabelCellValNum

public long getLabelCellValNum()
                        throws TileDBError

Returns the number of values per cell for the labels on the dimension label For variable-sized labels the result is TILEDB_VAR_NUM

Returns:

The number of values per cell

Throws:

TileDBError

getURI

public java.lang.String getURI()
                        throws TileDBError

Returns the URI of the dimension label array

Returns:

The URI

Throws:

TileDBError

getLabelOrder

public tiledb_data_order_t getLabelOrder()
                                  throws TileDBError

Returns the order of the labels on the dimension label

Returns:

The label order

Throws:

TileDBError

getLabelType

public Datatype getLabelType()
                      throws TileDBError

Returns the type of the labels on the dimension label

Returns:

The label type

Throws:

TileDBError

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable