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.
long	getAnnotationMetaData() The meta data of annotations associated with this IndexItem.
java.nio.ByteBuffer	getData() A reference to the Data being indexed.
DataItem	getDataItem() Get the data of this IndexItem as a DataItem.
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

Timestamp getDataTimestamp()

The timestamp in the data of the current IndexItem. The Data timestamp is the same as the Sender timestamp.

getIndexTimestamp

Timestamp getIndexTimestamp()

The timestamp of the current IndexItem. The Index timestamp is the same as the Receiver timestamp.

getData

java.nio.ByteBuffer getData()

A reference to the Data being indexed.

getDataSize

Size getDataSize()

The size of the data item being referenced.

getDataType

DataType getDataType()

The type of the data item being referenced.

getDataItem

DataItem getDataItem()

Get the data of this IndexItem as a DataItem.

getItemID

ID getItemID()

The index ID.

getAnnotationMetaData

long getAnnotationMetaData()

The meta data of annotations associated with this IndexItem. The application is free to process this in any way.

getPosition

AbsolutePosition getPosition()

Get the index position this IndexItem is in.

getIndex

Index getIndex()

Get the index this IndexItem is in.

getLastAccessTime

Timestamp getLastAccessTime()

Get the last time this object was accessed.

isReference

boolean isReference()

Is the data held by the IndexItem, actually an IndexReference.

follow

IndexItem follow()
                 throws GetItemException,
                        IndexClosedException

Follow the reference, if this IndexItem holds an IndexReference.

Throws:

GetItemException

IndexClosedException