RawStoreDelegate (Blazegraph Database Platform 2.1.5 API)

java.lang.Object
- com.bigdata.rawstore.RawStoreDelegate

All Implemented Interfaces:

ICounterSetAccess, IAddressManager, IRawStore, IStreamStore
```
public class RawStoreDelegate
extends Object
implements IRawStore
```
Simple delegation pattern.

Author:

Bryan Thompson

Field Summary

Fields
Modifier and Type Field and Description

protected IRawStore delegate
- Fields inherited from interface com.bigdata.rawstore.IAddressManager
  NULL

Fields
Modifier and Type	Field and Description
`protected IRawStore`	`delegate`

Constructor Summary

Constructors
Constructor and Description

RawStoreDelegate(IRawStore delegate)

Constructors
Constructor and Description
`RawStoreDelegate(IRawStore delegate)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close the store immediately.
`void`	`delete(long addr)` Delete the data (unisolated).
`void`	`deleteResources()` Deletes the backing file(s) (if any).
`void`	`destroy()` Closes the store immediately (if open) and deletes its persistent resources.
`void`	`force(boolean metadata)` Force the data to stable storage.
`int`	`getByteCount(long addr)` The length of the datum in bytes.
`CounterSet`	`getCounters()` Return performance counters.
`File`	`getFile()` The backing file -or- `null` if there is no backing file for the store.
`InputStream`	`getInputStream(long addr)` Return an input stream from which a previously written stream may be read back.
`long`	`getOffset(long addr)` The offset on the store at which the datum is stored.
`IPSOutputStream`	`getOutputStream()` Return an output stream which can be used to write on the backing store.
`long`	`getPhysicalAddress(long addr)` Determine the unencoded physical address
`IResourceMetadata`	`getResourceMetadata()` A description of this store in support of the scale-out architecture.
`UUID`	`getUUID()` Return the `UUID` which identifies this `IRawStore`.
`boolean`	`isFullyBuffered()` True iff the store is fully buffered (all reads are against memory).
`boolean`	`isOpen()` `true` iff the store is open.
`boolean`	`isReadOnly()` `true` iff the store does not allow writes.
`boolean`	`isStable()` True iff backed by stable storage.
`ByteBuffer`	`read(long addr)` Read the data (unisolated).
`long`	`size()` The #of application data bytes written on the store (does not count any headers or root blocks that may exist for the store).
`long`	`toAddr(int nbytes, long offset)` Converts a byte count and offset into a long integer.
`String`	`toString(long addr)` A human readable representation of the address.
`long`	`write(ByteBuffer data)` Write the data (unisolated).

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

- Field Detail
  - delegate
```
protected final IRawStore delegate
```
- Constructor Detail
  - RawStoreDelegate
```
public RawStoreDelegate(IRawStore delegate)
```
- Method Detail
  - close
```
public void close()
```
    Description copied from interface: IRawStore
    
    Close the store immediately.
    
    Specified by:
    
    close in interface IRawStore
  - delete
```
public void delete(long addr)
```
    Description copied from interface: IRawStore
    
    Delete the data (unisolated).
    After this operation subsequent reads on the address MAY fail and the caller MUST NOT depend on the ability to read at that address.
    
    Specified by:
    
    delete in interface IRawStore
    
    Parameters:
    addr - A long integer formed using Addr that encodes both the offset at which the data was written and the #of bytes that were written.
  - deleteResources
```
public void deleteResources()
```
    Description copied from interface: IRawStore
    
    Deletes the backing file(s) (if any).
    
    Specified by:
    
    deleteResources in interface IRawStore
  - destroy
```
public void destroy()
```
    Description copied from interface: IRawStore
    
    Closes the store immediately (if open) and deletes its persistent resources. Does NOT throw an IllegalStateException if the store is already closed, but still deletes the backing resources.
    
    Specified by:
    
    destroy in interface IRawStore
    
    See Also:
    IRawStore.deleteResources()
  - force
```
public void force(boolean metadata)
```
    Description copied from interface: IRawStore
    
    Force the data to stable storage. While this is NOT sufficient to guarantee an atomic commit, the data must be forced to disk as part of an atomic commit protocol.
    
    Specified by:
    
    force in interface IRawStore
    
    Parameters:
    metadata - If true, then force both the file contents and the file metadata to disk.
  - getByteCount
```
public int getByteCount(long addr)
```
    Description copied from interface: IAddressManager
    
    The length of the datum in bytes. This must be the actual length of the record on the disk, not the length of the caller's byte[]. This is necessary in order to support transparent checksums and/or compression for records in the IRawStore.
    
    Specified by:
    
    getByteCount in interface IAddressManager
    
    Parameters:
    addr - The opaque identifier that is the within store locator for some datum.
    
    Returns:
    The offset of that datum.
  - getCounters
```
public CounterSet getCounters()
```
    Description copied from interface: ICounterSetAccess
    
    Return performance counters.
    
    Specified by:
    
    getCounters in interface ICounterSetAccess
  - getFile
```
public File getFile()
```
    Description copied from interface: IRawStore
    
    The backing file -or- null if there is no backing file for the store.
    
    Specified by:
    
    getFile in interface IRawStore
  - getOffset
```
public long getOffset(long addr)
```
    Description copied from interface: IAddressManager
    
    The offset on the store at which the datum is stored. While this is often the offset of a byte into a file on disk, implementations MAY assign offsets using other strategies.
    
    Specified by:
    
    getOffset in interface IAddressManager
    
    Parameters:
    addr - The opaque identifier that is the within store locator for some datum.
    
    Returns:
    The offset of that datum.
  - getPhysicalAddress
```
public long getPhysicalAddress(long addr)
```
    Description copied from interface: IAddressManager
    
    Determine the unencoded physical address
    
    Specified by:
    
    getPhysicalAddress in interface IAddressManager
    
    Parameters:
    addr - The encoded address
    
    Returns:
    an unencoded address offset
  - getResourceMetadata
```
public IResourceMetadata getResourceMetadata()
```
    Description copied from interface: IRawStore
    
    A description of this store in support of the scale-out architecture.
    
    Specified by:
    
    getResourceMetadata in interface IRawStore
  - getUUID
```
public UUID getUUID()
```
    Description copied from interface: IRawStore
    
    Return the UUID which identifies this IRawStore. This supports IRawStore.getResourceMetadata().
    
    Specified by:
    
    getUUID in interface IRawStore
  - isFullyBuffered
```
public boolean isFullyBuffered()
```
    Description copied from interface: IRawStore
    
    True iff the store is fully buffered (all reads are against memory). Implementations MAY change the value returned by this method over the life cycle of the store, e.g., to conserve memory a store may drop or decrease its buffer if it is backed by disk.
    Note: This does not guarantee that the OS will not swap the buffer onto disk.
    
    Specified by:
    
    isFullyBuffered in interface IRawStore
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: IRawStore
    
    true iff the store is open.
    
    Specified by:
    
    isOpen in interface IRawStore
    
    Returns:
    true iff the store is open.
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: IRawStore
    
    true iff the store does not allow writes.
    
    Specified by:
    
    isReadOnly in interface IRawStore
  - isStable
```
public boolean isStable()
```
    Description copied from interface: IRawStore
    
    True iff backed by stable storage.
    
    Specified by:
    
    isStable in interface IRawStore
  - read
```
public ByteBuffer read(long addr)
```
    Description copied from interface: IRawStore
    
    Read the data (unisolated).
    
    Specified by:
    
    read in interface IRawStore
    
    Parameters:
    addr - A long integer that encodes both the offset from which the data will be read and the #of bytes to be read. See IAddressManager.toAddr(int, long).
    
    Returns:
    The data read. The buffer will be flipped to prepare for reading (the position will be zero and the limit will be the #of bytes read).
  - size
```
public long size()
```
    Description copied from interface: IRawStore
    
    The #of application data bytes written on the store (does not count any headers or root blocks that may exist for the store).
    
    Specified by:
    
    size in interface IRawStore
  - toAddr
```
public long toAddr(int nbytes,
          long offset)
```
    Description copied from interface: IAddressManager
    
    Converts a byte count and offset into a long integer.
    
    Specified by:
    
    toAddr in interface IAddressManager
    
    Parameters:
    nbytes - The byte count.
    offset - The byte offset.
    
    Returns:
    The long integer.
  - toString
```
public String toString(long addr)
```
    Description copied from interface: IAddressManager
    
    A human readable representation of the address.
    
    Specified by:
    
    toString in interface IAddressManager
    
    Parameters:
    addr - The opaque identifier that is the within store locator for some datum.
    
    Returns:
    A human readable representation.
  - write
```
public long write(ByteBuffer data)
```
    Description copied from interface: IRawStore
    
    Write the data (unisolated).
    
    Specified by:
    
    write in interface IRawStore
    
    Parameters:
    data - The data. The bytes from the current Buffer.position() to the Buffer.limit() will be written and the Buffer.position() will be advanced to the Buffer.limit() . The caller may subsequently modify the contents of the buffer without changing the state of the store (i.e., the data are copied into the store).
    
    Returns:
    A long integer formed that encodes both the offset from which the data may be read and the #of bytes to be read. See IAddressManager.
  - getOutputStream
```
public IPSOutputStream getOutputStream()
```
    Description copied from interface: IStreamStore
    
    Return an output stream which can be used to write on the backing store. You can recover the address used to read back the data from the IPSOutputStream.
    
    Specified by:
    
    getOutputStream in interface IStreamStore
    
    Returns:
    The output stream.
  - getInputStream
```
public InputStream getInputStream(long addr)
```
    Description copied from interface: IStreamStore
    
    Return an input stream from which a previously written stream may be read back.
    
    Specified by:
    
    getInputStream in interface IStreamStore
    
    Parameters:
    addr - The address at which the stream was written.
    
    Returns:
    an input stream for the data for provided address

Class RawStoreDelegate

Field Summary

Fields inherited from interface com.bigdata.rawstore.IAddressManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

delegate

Constructor Detail

RawStoreDelegate

Method Detail

close

delete

deleteResources

destroy

force

getByteCount

getCounters

getFile

getOffset

getPhysicalAddress

getResourceMetadata

getUUID

isFullyBuffered

isOpen

isReadOnly

isStable

read

size

toAddr

toString

write

getOutputStream

getInputStream