com.timeindexing.index
Class IndexItemView

java.lang.Object
  extended bycom.timeindexing.index.IndexItemView
All Implemented Interfaces:
IndexItem

public class IndexItemView
extends java.lang.Object
implements IndexItem

A view onto an IndexItem.


Constructor Summary
IndexItemView(IndexItem anItem)
          Construct a View onto an IndexItem.
 
Method Summary
 IndexItem follow()
          Follow the reference, if this IndexItem holds an IndexReference.
 ID getAnnotations()
          The ID of annotations associated with this IndexItem.
 java.nio.ByteBuffer getData()
          A reference to the Data being indexed.
 Size getDataSize()
          The size of the data item being referenced.
 Timestamp getDataTimestamp()
          The timestamp in the data of the current IndexItem.
 DataType getDataType()
          The type of the data item being referenced.
 Index getIndex()
          Get the index this IndexItem is in.
 Timestamp getIndexTimestamp()
          The timestamp of the current IndexItem.
 ID getItemID()
          The index ID.
 Timestamp getLastAccessTime()
          Get the last time this object was accessed.
 AbsolutePosition getPosition()
          Get the index position this IndexItem is in.
 boolean isReference()
          Is the data held by the IndexItem, actually an IndexReference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexItemView

public IndexItemView(IndexItem anItem)
Construct a View onto an IndexItem.

Method Detail

getDataTimestamp

public Timestamp getDataTimestamp()
The timestamp in the data of the current IndexItem. The Data timestamp is the same as the Sender timestamp.

Specified by:
getDataTimestamp in interface IndexItem

getIndexTimestamp

public Timestamp getIndexTimestamp()
The timestamp of the current IndexItem. The Index timestamp is the same as the Receiver timestamp.

Specified by:
getIndexTimestamp in interface IndexItem

getData

public java.nio.ByteBuffer getData()
A reference to the Data being indexed.

Specified by:
getData in interface IndexItem

getDataSize

public Size getDataSize()
The size of the data item being referenced.

Specified by:
getDataSize in interface IndexItem

getDataType

public DataType getDataType()
The type of the data item being referenced.

Specified by:
getDataType in interface IndexItem

getItemID

public ID getItemID()
The index ID.

Specified by:
getItemID in interface IndexItem

getAnnotations

public ID getAnnotations()
The ID of annotations associated with this IndexItem.

Specified by:
getAnnotations in interface IndexItem

getPosition

public AbsolutePosition getPosition()
Get the index position this IndexItem is in.

Specified by:
getPosition in interface IndexItem

getIndex

public Index getIndex()
Get the index this IndexItem is in.

Specified by:
getIndex in interface IndexItem

getLastAccessTime

public Timestamp getLastAccessTime()
Get the last time this object was accessed.

Specified by:
getLastAccessTime in interface IndexItem

isReference

public boolean isReference()
Is the data held by the IndexItem, actually an IndexReference.

Specified by:
isReference in interface IndexItem

follow

public IndexItem follow()
                 throws GetItemException
Follow the reference, if this IndexItem holds an IndexReference.

Specified by:
follow in interface IndexItem
Throws:
GetItemException