Class HeapController

java.lang.Object
org.apache.derby.impl.store.access.conglomerate.GenericController
org.apache.derby.impl.store.access.conglomerate.GenericConglomerateController
org.apache.derby.impl.store.access.heap.HeapController
All Implemented Interfaces:
ConglomerateController, ConglomPropertyQueryable
public class HeapController extends GenericConglomerateController implements ConglomerateController

  • Constructor Details

    • HeapController

      public HeapController()

  • Method Details

    • getRowPositionFromRowLocation

      protected final void getRowPositionFromRowLocation(RowLocation row_loc, RowPosition pos) throws StandardException
      Protected concrete impl of abstract methods of GenericConglomerateController class:
      Overrides:
      getRowPositionFromRowLocation in class GenericController
      Throws:
      StandardException

    • queueDeletePostCommitWork

      protected void queueDeletePostCommitWork(RowPosition pos) throws StandardException
      Overrides:
      queueDeletePostCommitWork in class GenericController
      Throws:
      StandardException

    • purgeCommittedDeletes

      protected final boolean purgeCommittedDeletes(Page page) throws StandardException
      Check and purge committed deleted rows on a page.

      Parameters:
      page - A non-null, latched page must be passed in. If all rows on page are purged, then page will be removed and latch released.
      Returns:
      true, if no purging has been done on page, and thus latch can be released before end transaction. Otherwise the latch on the page can not be released before commit.
      Throws:
      StandardException - Standard exception policy.

    • doInsert

      private RecordHandle doInsert(DataValueDescriptor[] row) throws StandardException
      Insert a new row into the heap.

      Overflow policy: The current heap access method implements an algorithm that optimizes for fetch efficiency vs. space efficiency. A row will not be over flowed unless it is bigger than a page. If it is bigger than a page then it's initial part will be placed on a page and then subsequent parts will be overflowed to other pages.

      Parameters:
      row - The row to insert.
      Returns:
      The record handle of the inserted row.
      Throws:
      StandardException - Standard exception policy.

    • load

      protected long load(TransactionManager xact_manager, Heap heap, boolean createConglom, RowLocationRetRowSource rowSource) throws StandardException
      Throws:
      StandardException

    • lockRow

      protected boolean lockRow(RecordHandle rh, int lock_oper, boolean wait, int lock_duration) throws StandardException
      Throws:
      StandardException

    • getUserPageNoWait

      protected Page getUserPageNoWait(long pageno) throws StandardException
      Throws:
      StandardException

    • getUserPageWait

      protected Page getUserPageWait(long pageno) throws StandardException
      Throws:
      StandardException

    • lockRowAtSlotNoWaitExclusive

      protected boolean lockRowAtSlotNoWaitExclusive(RecordHandle rh) throws StandardException
      Throws:
      StandardException

    • removePage

      protected void removePage(Page page) throws StandardException
      Throws:
      StandardException

    • insert

      public int insert(DataValueDescriptor[] row) throws StandardException
      Public Methods of This class:
      Specified by:
      insert in interface ConglomerateController
      Parameters:
      row - The row to insert into the conglomerate. The stored representations of the row's columns are copied into a new row somewhere in the conglomerate.
      Returns:
      Returns 0 if insert succeeded. Returns ConglomerateController.ROWISDUPLICATE if conglomerate supports uniqueness checks and has been created to disallow duplicates, and the row inserted had key columns which were duplicate of a row already in the table. Other insert failures will raise StandardException's.
      Throws:
      StandardException - Standard exception policy.
      See Also:

    • insertAndFetchLocation

      public void insertAndFetchLocation(DataValueDescriptor[] row, RowLocation templateRowLocation) throws StandardException
      Description copied from interface: ConglomerateController
      insert row and fetch it's row location in one operation.

      Insert a row into the conglomerate, and store its location in the provided destination row location. The row location must be of the correct type for this conglomerate (a new row location of the correct type can be obtained from newRowLocationTemplate()).

      Specified by:
      insertAndFetchLocation in interface ConglomerateController
      Parameters:
      row - The row to insert into the conglomerate. The stored representations of the row's columns are copied into a new row somewhere in the conglomerate.
      templateRowLocation - The rowlocation to read the inserted row location into.
      Throws:
      StandardException - Standard exception policy.
      See Also:

    • lockRow

      public boolean lockRow(RowLocation loc, int lock_operation, boolean wait, int lock_duration) throws StandardException
      Lock the given row location.

      Should only be called by access.

      This call can be made on a ConglomerateController that was opened for locking only.

      RESOLVE (mikem) - move this call to ConglomerateManager so it is obvious that non-access clients should not call this.

      Specified by:
      lockRow in interface ConglomerateController
      Parameters:
      loc - The "RowLocation" which describes the exact row to lock.
      lock_operation - For what operation are we requesting the lock, this should be one of the following 4 options: LOCK_READ [read lock], (LOCK_INS | LOCK_UPD) [ lock for insert], (LOCK_INSERT_PREVKEY | LOCK_UPD) [lock for previous key to insert], (LOCK_UPD) [lock for delete or replace] (LOCK_UPD | LOCK_UPDATE_LOCKS) [lock scan for update, will upgrade lock later if actual update is take place]
      wait - Should the lock call wait to be granted?
      lock_duration - If set to TransactionManager.LOCK_INSTANT_DURATION, then lock will be released immediately after being granted.
      Returns:
      true if lock was granted, only can be false if wait was false.
      Throws:
      StandardException - Standard exception policy.

    • unlockRowAfterRead

      public void unlockRowAfterRead(RowLocation loc, boolean forUpdate, boolean row_qualified) throws StandardException
      UnLock the given row location.

      Should only be called by access.

      This call can be made on a ConglomerateController that was opened for locking only.

      RESOLVE (mikem) - move this call to ConglomerateManager so it is obvious that non-access clients should not call this.

      Specified by:
      unlockRowAfterRead in interface ConglomerateController
      Parameters:
      loc - The "RowLocation" which describes the row to unlock.
      forUpdate - Row was previously Locked the record for read or update.
      row_qualified - Row was qualified and returned to the user.
      Throws:
      StandardException - Standard exception policy.

    • lockRow

      public boolean lockRow(long page_num, int record_id, int lock_operation, boolean wait, int lock_duration) throws StandardException
      Lock the given record id/page num pair.

      Should only be called by access, to lock "special" locks formed from the Recordhandle.* reserved constants for page specific locks.

      This call can be made on a ConglomerateController that was opened for locking only.

      RESOLVE (mikem) - move this call to ConglomerateManager so it is obvious that non-access clients should not call this.

      Specified by:
      lockRow in interface ConglomerateController
      Parameters:
      page_num - Page number of row to lock.
      record_id - Record id of row on page_num to lock.
      lock_operation - Desc of what to lock for, ie. update, insert ...
      wait - Should the lock call wait to be granted?
      lock_duration - If set to TransactionManager.LOCK_INSTANT_DURATION, then lock will be released immediately after being granted.
      Returns:
      true if lock was granted, only can be false if wait was false.
      Throws:
      StandardException - Standard exception policy.

    • newRowLocationTemplate

      public RowLocation newRowLocationTemplate() throws StandardException
      Description copied from interface: ConglomerateController
      Return a row location object of the correct type to be used in calls to insertAndFetchLocation.
      Specified by:
      newRowLocationTemplate in interface ConglomerateController
      Overrides:
      newRowLocationTemplate in class GenericController
      Throws:
      StandardException - Standard exception policy.

    • getOpenConglomerate

      public OpenConglomerate getOpenConglomerate()
      Public Methods of XXXX class: