MutableDirectoryPageData (Blazegraph Database Platform 2.1.5 API)

java.lang.Object
- com.bigdata.htree.MutableDirectoryPageData

All Implemented Interfaces:

IAbstractNodeData, IChildData, ITreeNodeData, IDirectoryData, IDataRecordAccess
```
public class MutableDirectoryPageData
extends Object
implements IDirectoryData
```
Implementation maintains Java objects corresponding to the persistent data and defines methods for a variety of mutations on the IDirectoryData record which operate by direct manipulation of the Java objects.
Note: package private fields are used so that they may be directly accessed by the DirectoryPage class.

Version:

$Id: MutableNodeData.java 2265 2009-10-26 12:51:06Z thompsonbry $ FIXME Unit tests for this class, including constructors.

Author:

Bryan Thompson

Constructor Summary

Constructors
Constructor and Description
`MutableDirectoryPageData(byte[] overflowKey, int addressBits, boolean hasVersionTimestamps)` Create an empty mutable data record.
`MutableDirectoryPageData(byte[] overflowKey, long[] childAddr, boolean hasVersionTimestamps, long minimumVersionTimestamp, long maximumVersionTimestamp)` Ctor based on just the "data" -- used by unit tests.
`MutableDirectoryPageData(int addressBits, IDirectoryData src)` Makes a mutable copy of the source data record.

Method Summary

Methods
Modifier and Type	Method and Description
`AbstractFixedByteArrayBuffer`	`data()` The coded (aka compressed) data.
`long`	`getChildAddr(int index)` Return the persistent addresses of the specified child node.
`int`	`getChildCount()` The #of children of this node.
`long`	`getMaximumVersionTimestamp()` The most recent tuple revision timestamp associated with any tuple spanned by this node or leaf.
`long`	`getMinimumVersionTimestamp()` The earliest tuple revision timestamp associated with any tuple spanned by this node or leaf.
`byte[]`	`getOverflowKey()` If this is an overflow directory, then there is a single key for which the directory will reference multiple BucketPages storing the associated values.
`boolean`	`hasVersionTimestamps()` Return `true` iff the leaves maintain tuple revision timestamps.
`boolean`	`isCoded()` No.
`boolean`	`isLeaf()` True iff this is a leaf node.
`boolean`	`isOverflowDirectory()` `true` iff this is an overflow directory page.
`boolean`	`isReadOnly()` No - this is a mutable data record.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MutableDirectoryPageData
```
public MutableDirectoryPageData(byte[] overflowKey,
                        int addressBits,
                        boolean hasVersionTimestamps)
```
    Create an empty mutable data record.
    
    Parameters:
    addressBits - The #of address bits.
    hasVersionTimestamps - true iff the HTree is maintaining per tuple version timestamps.
  - MutableDirectoryPageData
```
public MutableDirectoryPageData(int addressBits,
                        IDirectoryData src)
```
    Makes a mutable copy of the source data record.
    
    Parameters:
    addressBits - The #of address bits owning HTree. This is used to initialize the various arrays to the correct capacity.
    src - The source data record.
  - MutableDirectoryPageData
```
public MutableDirectoryPageData(byte[] overflowKey,
                        long[] childAddr,
                        boolean hasVersionTimestamps,
                        long minimumVersionTimestamp,
                        long maximumVersionTimestamp)
```
    Ctor based on just the "data" -- used by unit tests.
    
    Parameters:
    nentries -
    keys -
    childAddr -
    childEntryCounts -
- Method Detail
  - isReadOnly
```
public final boolean isReadOnly()
```
    No - this is a mutable data record.
    
    Specified by:
    
    isReadOnly in interface IAbstractNodeData
  - isCoded
```
public final boolean isCoded()
```
    No.
    
    Specified by:
    
    isCoded in interface IAbstractNodeData
  - data
```
public final AbstractFixedByteArrayBuffer data()
```
    Description copied from interface: IAbstractNodeData
    
    The coded (aka compressed) data.
    
    Specified by:
    
    data in interface IAbstractNodeData
    
    Specified by:
    
    data in interface IDataRecordAccess
  - getChildAddr
```
public final long getChildAddr(int index)
```
    Description copied from interface: IChildData
    
    Return the persistent addresses of the specified child node.
    
    Specified by:
    
    getChildAddr in interface IChildData
    
    Parameters:
    index - The index of the child in [0:nkeys].
    
    Returns:
    The persistent child address -or- zero(0L) if the child is not persistent.
  - getChildCount
```
public final int getChildCount()
```
    The #of children of this node. Either all children will be nodes or all children will be leaves. The #of children of a node MUST be IAbstractNodeData#getKeyCount()+1
    Overridden to report the size of the address space.
    
    Specified by:
    
    getChildCount in interface IChildData
    
    Returns:
    The #of children of this node.
  - isOverflowDirectory
```
public final boolean isOverflowDirectory()
```
    Description copied from interface: IDirectoryData
    
    true iff this is an overflow directory page. An overflow directory page is created when a bucket page overflows as the parent of that bucket page. The children of the overflow directory page may be other overflow directory pages or bucket pages. All bucket pages below an overflow directory page will have the same key. That key is recorded once in each overflow bucket page.
    
    Specified by:
    
    isOverflowDirectory in interface IDirectoryData
  - isLeaf
```
public final boolean isLeaf()
```
    Description copied from interface: IAbstractNodeData
    
    True iff this is a leaf node.
    
    Specified by:
    
    isLeaf in interface IAbstractNodeData
  - hasVersionTimestamps
```
public final boolean hasVersionTimestamps()
```
    Description copied from interface: IAbstractNodeData
    
    Return true iff the leaves maintain tuple revision timestamps. When true, the minimum and maximum tuple revision timestamp for a node or leaf are available from IAbstractNodeData.getMinimumVersionTimestamp() and IAbstractNodeData.getMaximumVersionTimestamp().
    
    Specified by:
    
    hasVersionTimestamps in interface IAbstractNodeData
  - getMaximumVersionTimestamp
```
public final long getMaximumVersionTimestamp()
```
    Description copied from interface: IAbstractNodeData
    
    The most recent tuple revision timestamp associated with any tuple spanned by this node or leaf. If there are NO tuples for the leaf, then this MUST return Long.MIN_VALUE since the initial value of the maximum version timestamp is always the smallest possible long integer.
    
    Specified by:
    
    getMaximumVersionTimestamp in interface IAbstractNodeData
  - getMinimumVersionTimestamp
```
public final long getMinimumVersionTimestamp()
```
    Description copied from interface: IAbstractNodeData
    
    The earliest tuple revision timestamp associated with any tuple spanned by this node or leaf. If there are NO tuples for the leaf, then this MUST return Long.MAX_VALUE since the initial value of the minimum version timestamp is always the largest possible long integer.
    
    Specified by:
    
    getMinimumVersionTimestamp in interface IAbstractNodeData
  - getOverflowKey
```
public byte[] getOverflowKey()
```
    Description copied from interface: IDirectoryData
    
    If this is an overflow directory, then there is a single key for which the directory will reference multiple BucketPages storing the associated values. The key is used to constrain insertions to the Directory, adding extra levels to discriminate as necessary.
    
    Specified by:
    
    getOverflowKey in interface IDirectoryData

Class MutableDirectoryPageData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MutableDirectoryPageData

MutableDirectoryPageData

MutableDirectoryPageData

Method Detail

isReadOnly

isCoded

data

getChildAddr

getChildCount

isOverflowDirectory

isLeaf

hasVersionTimestamps

getMaximumVersionTimestamp

getMinimumVersionTimestamp

getOverflowKey