Package io.tiledb.java.api

Class TileDBObject

  • public class TileDBObject
extends java.lang.Object
    Represents a TileDB object: array, group, key-value, or none (invalid).

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        TileDBObject​(Context ctx, java.lang.String uri)
      Constructs an object that contains the type along with the URI.
      protected TileDBObject​(Context ctx, java.lang.String uri, TileDBObjectType type)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TileDBObjectType getType()
      Returns the object type.
      java.lang.String getUri()
      Returns the object Uri String.
      static void move​(Context ctx, java.lang.String old_uri, java.lang.String new_uri)
      Moves/renames a tiledb object.
      static void remove​(Context ctx, java.lang.String uri)
      Deletes a TileDB object.
      java.lang.String toString()
      Returns a string representation of the object, including its type and URI.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TileDBObject

        public TileDBObject​(Context ctx,
                    java.lang.String uri)
             throws TileDBError
        Constructs an object that contains the type along with the URI.
        Parameters:
        ctx - The TileDB context
        uri - The path to the object.
        Throws:
        TileDBError - A TileDB exception

    • Method Detail

      • remove

        public static void remove​(Context ctx,
                          java.lang.String uri)
                   throws TileDBError
        Deletes a TileDB object.
        Parameters:
        ctx - The TileDB context
        uri - The path to the object to be deleted.
        Throws:
        TileDBError - A TileDB exception

      • move

        public static void move​(Context ctx,
                        java.lang.String old_uri,
                        java.lang.String new_uri)
                 throws TileDBError
        Moves/renames a tiledb object.
        Parameters:
        ctx - The TileDB context.
        old_uri - The path to the old object.
        new_uri - The path to the new object.
        Throws:
        TileDBError - A TileDB exception

      • toString

        public java.lang.String toString()
        Returns a string representation of the object, including its type and URI.
        Overrides:
        toString in class java.lang.Object

      • getType

        public TileDBObjectType getType()
        Returns the object type.
        Returns:
        a tiledb object type enum

      • getUri

        public java.lang.String getUri()
        Returns the object Uri String.
        Returns:
        uri String