com.timeindexing.index
Interface IndexItem

All Known Subinterfaces:
ManagedFileIndexItem, ManagedIndexItem
All Known Implementing Classes:
FileIndexItem, IncoreIndexItem, IndexItemView

public interface IndexItem

Values that an index item must return.


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.
 

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.


getIndexTimestamp

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


getData

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


getDataSize

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


getDataType

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


getItemID

public ID getItemID()
The index ID.


getAnnotations

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


getPosition

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


getIndex

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


getLastAccessTime

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


isReference

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


follow

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

Throws:
GetItemException