SubRangeRaba (Blazegraph Database Platform 2.1.5 API)

java.lang.Object
- com.bigdata.btree.raba.SubRangeRaba

All Implemented Interfaces:

IRaba, Iterable<byte[]>
```
public class SubRangeRaba
extends Object
implements IRaba
```
A read-only IRaba that exposes a limited sub-range of a backing IRaba.

Author:

bryan

See Also:
(Schedule more IOs when loading data)

Constructor Summary

Constructors
Constructor and Description

SubRangeRaba(IRaba delegate, int fromIndex, int toIndex)

Constructors
Constructor and Description
`SubRangeRaba(IRaba delegate, int fromIndex, int toIndex)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`add(byte[] a)` Append a byte[] value to the end of the logical byte[][] (optional operation).
`int`	`add(byte[] value, int off, int len)` Append a byte[] value to the end of the logical byte[][] (optional operation).
`int`	`add(DataInput in, int len)` Append a byte[] value to the end of the logical byte[][] (optional operation).
`int`	`capacity()` The capacity of the logical byte[][].
`int`	`copy(int index, OutputStream os)` Copy the value at the specified index onto the output stream.
`byte[]`	`get(int index)` Return the byte[] at the specified index.
`boolean`	`isEmpty()` True iff the logical byte[][] is empty.
`boolean`	`isFull()` True iff the logical byte[][] is full.
`boolean`	`isKeys()` When `true` the `IRaba` supports search and elements are interpreted as `unsigned byte[]`s (B+Tree keys).
`boolean`	`isNull(int index)` Return `true` iff the byte[] at that index is `null`.
`boolean`	`isReadOnly()` Return `true` if this implementation is read-only.
`Iterator<byte[]>`	`iterator()` Iterator visits the byte[] elements in the view order.
`int`	`length(int index)` The length of the byte[] at that index.
`int`	`search(byte[] searchKey)` Search for the given searchKey in the key buffer (optional operation).
`void`	`set(int index, byte[] a)` Set the byte[] value at the specified index (optional operation).
`int`	`size()` The #of entries in the logical byte[][].
`String`	`toString()`

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

- Constructor Detail
  - SubRangeRaba
```
public SubRangeRaba(IRaba delegate,
            int fromIndex,
            int toIndex)
```
    Parameters:
    delegate - The delegate
    fromIndex - The inclusive lower bound in the delegate.
    toIndex - The exclusive upper bound in the delegate.
    
    Throws:
    
    IllegalArgumentException - if the delegate is null.
    
    IllegalArgumentException - if the fromIndex is LT ZERO (0).
    
    IllegalArgumentException - if the toIndex is GT the delegate IRaba.size().
    
    IllegalArgumentException - if the fromIndex is GTE to toIndex.
- Method Detail
  - isReadOnly
```
public final boolean isReadOnly()
```
    Description copied from interface: IRaba
    
    Return true if this implementation is read-only.
    
    Specified by:
    
    isReadOnly in interface IRaba
  - isKeys
```
public boolean isKeys()
```
    Description copied from interface: IRaba
    
    When true the IRaba supports search and elements are interpreted as unsigned byte[]s (B+Tree keys). For this case the application MUST ensure that the elements are maintained in unsigned byte[] order and that duplicates byte[]s are not stored.
    When false, the IRaba allows nulls and the elements are interpreted as signed byte[] (B+Tree values).
    
    Specified by:
    
    isKeys in interface IRaba
    
    Returns:
    true if the IRaba represents B+Tree keys and false if it represents B+Tree values.
  - capacity
```
public int capacity()
```
    Description copied from interface: IRaba
    
    The capacity of the logical byte[][].
    
    Specified by:
    
    capacity in interface IRaba
  - size
```
public int size()
```
    Description copied from interface: IRaba
    
    The #of entries in the logical byte[][].
    
    Specified by:
    
    size in interface IRaba
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: IRaba
    
    True iff the logical byte[][] is empty.
    
    Specified by:
    
    isEmpty in interface IRaba
  - isFull
```
public boolean isFull()
```
    True iff the logical byte[][] is full.
    It is assumed that the delegate is full and this view does not allow mutation, so this always returns false.
    
    Specified by:
    
    isFull in interface IRaba
  - isNull
```
public boolean isNull(int index)
```
    Description copied from interface: IRaba
    
    Return true iff the byte[] at that index is null. If IRaba.isKeys() would return true then this method MUST return false since nulls are not permitted for B+Tree keys.
    
    Specified by:
    
    isNull in interface IRaba
    
    Parameters:
    index - The index in [0:IRaba.size()-1].
  - length
```
public int length(int index)
```
    Description copied from interface: IRaba
    
    The length of the byte[] at that index.
    
    Specified by:
    
    length in interface IRaba
    
    Parameters:
    index - The index in [0:IRaba.size()-1].
    
    Returns:
    The length of the byte[] at that index.
  - get
```
public byte[] get(int index)
```
    Description copied from interface: IRaba
    
    Return the byte[] at the specified index. For greater efficiency, implementations MAY return a reference to an internal the byte[].
    
    Specified by:
    
    get in interface IRaba
    
    Parameters:
    index - The index in [0:IRaba.size()-1].
    
    Returns:
    The byte[] value at that index and null if a null value was stored at that index.
  - copy
```
public int copy(int index,
       OutputStream os)
```
    Description copied from interface: IRaba
    
    Copy the value at the specified index onto the output stream. This is often used with an ByteArrayBuffer so that the same backing byte[] can be overwritten by each visited key.
    
    Specified by:
    
    copy in interface IRaba
    
    Parameters:
    index - The index in [0:IRaba.size()-1].
    
    Returns:
    The #of bytes copied.
  - iterator
```
public Iterator<byte[]> iterator()
```
    Description copied from interface: IRaba
    
    Iterator visits the byte[] elements in the view order. If an element is null, then the iterator will report a null for that element.
    
    Specified by:
    
    iterator in interface IRaba
    
    Specified by:
    
    iterator in interface Iterable<byte[]>
  - set
```
public void set(int index,
       byte[] a)
```
    Description copied from interface: IRaba
    
    Set the byte[] value at the specified index (optional operation).
    
    Specified by:
    
    set in interface IRaba
    
    Parameters:
    index - The index in [0:IRaba.size()-1].
    a - The byte[] value.
  - add
```
public int add(byte[] a)
```
    Description copied from interface: IRaba
    
    Append a byte[] value to the end of the logical byte[][] (optional operation).
    
    Specified by:
    
    add in interface IRaba
    
    Parameters:
    a - A value.
    
    Returns:
    The #of values in the logical byte[][] (postcondition).
  - add
```
public int add(byte[] value,
      int off,
      int len)
```
    Description copied from interface: IRaba
    
    Append a byte[] value to the end of the logical byte[][] (optional operation).
    
    Specified by:
    
    add in interface IRaba
    
    Parameters:
    value - A value
    off - The offset of the first byte to be copied.
    len - The #of bytes to be copied.
    
    Returns:
    The #of values in the logical byte[][] (postcondition).
  - add
```
public int add(DataInput in,
      int len)
        throws IOException
```
    Description copied from interface: IRaba
    
    Append a byte[] value to the end of the logical byte[][] (optional operation).
    
    Specified by:
    
    add in interface IRaba
    
    Parameters:
    in - The input stream from which the byte[] will be read.
    len - The #of bytes to be read.
    
    Returns:
    The #of values in the logical byte[][] (postcondition).
    
    Throws:
    
    IOException
  - search
```
public int search(byte[] searchKey)
```
    Search for the given searchKey in the key buffer (optional operation). Whether or not search is supported depends on whether the logical byte[][] is ordered. However, the efficiency of search, where supported, depends on the implementation. Some implementations support binary search of the coded byte[] values. Others may require a mixture of binary and linear search, etc.
```
 entryIndex = -entryIndex - 1
 
```
    or just
```
 entryIndex = -entryIndex
 
```
    if you are looking for the first key after the searchKey.
    Specified by:
    
    search in interface IRaba
    
    Parameters:
    searchKey - The search key.
    
    Returns:
    index of the search key, if it is found; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted. Note that this guarantees that the return value will be >= 0 if and only if the key is found.
    
    Throws:
    
    UnsupportedOperationException - always. TODO I am not sure about the semantics of search() for a sub-range so it is just disallowed for now. The issue is the meaning of a key probe that is LT the key at fromIndex in the delegate or GTE the key at toIndex in the delegate. Search in fact can generally report positions before the start of an ordered array of keys or after their end. But in this case we can't see any keys before fromIndex or GTE toIndex. This leads to some ambiguity about how to respond to key probes that really below in a different SubRangeRaba.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SubRangeRaba

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubRangeRaba

Method Detail

isReadOnly

isKeys

capacity

size

isEmpty

isFull

isNull

length

get

copy

iterator

set

add

add

add

search

toString