Package io.tiledb.java.api

Class ConsolidationPlan

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public class ConsolidationPlan
extends java.lang.Object
implements java.lang.AutoCloseable

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      java.lang.String dumpJSONString()
      Dumps the consolidation plan in JSON format in a String.
      java.lang.String getFragmentURI​(java.math.BigInteger nodeIndex, java.math.BigInteger fragmentIndex)
      Get the number of fragments for a specific node of a consolidation plan object
      long getNumFragments​(java.math.BigInteger nodeIndex)
      Get the number of fragments for a specific node of a consolidation plan object
      long getNumNodes()
      Get the number of nodes of a consolidation plan object

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ConsolidationPlan

        public ConsolidationPlan​(Context ctx,
                         java.math.BigInteger fragmentSize,
                         java.lang.String arrayURI)
                  throws TileDBError
        Constructor
        Parameters:
        fragmentSize - The desired fragment size
        ctx - TileDB context
        arrayURI - The array to create the plan for
        Throws:
        TileDBError

      • ConsolidationPlan

        public ConsolidationPlan​(Context ctx,
                         java.math.BigInteger fragmentSize,
                         Array array)
                  throws TileDBError
        Constructor
        Parameters:
        fragmentSize - The desired fragment size
        ctx - TileDB context
        array - The array to create the plan for
        Throws:
        TileDBError

    • Method Detail

      • getNumFragments

        public long getNumFragments​(java.math.BigInteger nodeIndex)
                     throws TileDBError
        Get the number of fragments for a specific node of a consolidation plan object
        Parameters:
        nodeIndex - The node index
        Returns:
        The number of fragments to be retrieved
        Throws:
        TileDBError

      • getFragmentURI

        public java.lang.String getFragmentURI​(java.math.BigInteger nodeIndex,
                                       java.math.BigInteger fragmentIndex)
                                throws TileDBError
        Get the number of fragments for a specific node of a consolidation plan object
        Parameters:
        nodeIndex - The node index
        fragmentIndex - The fragment index
        Returns:
        The fragment uri to be retrieved
        Throws:
        TileDBError

      • dumpJSONString

        public java.lang.String dumpJSONString()
                                throws TileDBError
        Dumps the consolidation plan in JSON format in a String.
        Returns:
        The output string
        Throws:
        TileDBError

      • getNumNodes

        public long getNumNodes()
                 throws TileDBError
        Get the number of nodes of a consolidation plan object
        Returns:
        The number of nodes to be retrieved
        Throws:
        TileDBError

      • close

        public void close()
           throws java.lang.Exception
        Specified by:
        close in interface java.lang.AutoCloseable
        Throws:
        java.lang.Exception