com.timeindexing.index
Interface StoredIndex

All Superinterfaces:

ExtendedIndex, ExtendedIndexHeader, Index, IndexEventGenerator, IndexHeader, ManagedIndex, ManagedIndexHeader

All Known Implementing Classes:

ExternalIndex, FileIndex, InlineIndex, ShadowIndex, SQLIndex

public interface StoredIndex
extends ManagedIndex

An interface for classes that need to process Indexes that are saved in stores. This is to be used by classes that store index data, rather than have data incore.

Method Summary

DataHolderObject	readData(long pos, DataReference dataReference) Read data for an index item given an index position and a DataReference.
long	retrieveItem(IndexItem item, long position) Retrieve an Index Item into the Index.

Methods inherited from interface com.timeindexing.index.ManagedIndex

addReference, addView, closeView, create, getHeader, getTrackedIndex, isTrackingIndex, listTrackedIndexes, open, reallyClose, removeView, trackReferencedIndex

Methods inherited from interface com.timeindexing.index.ExtendedIndex

getFirstOffset, getIndexType, getLastFlushPosition, getLastFlushTime, getLastOffset

Methods inherited from interface com.timeindexing.index.Index

activate, addDataType, addItem, addItem, addItem, addReference, addReference, addReference, apply, asView, close, commit, contains, contains, filter, getAnnotationStyle, getCachePolicy, getDataType, getItem, getItem, getItem, getItem, getItemSize, getLastAccessTime, getLoadDataAutomatically, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isWriteLocked, iterator, locate, locate, locate, locate, map, select, select, select, select, setAutoCommit, setCachePolicy, setLoadDataAutomatically, terminate, updateDescription

Methods inherited from interface com.timeindexing.index.ManagedIndexHeader

addIndexURI, getAllOptions, getIndexURI, getOption, hasIndexURI, hasOption, listOptions, notInTimeOrder, setDataPathName, setDataSize, setDescription, setEndTime, setFirstDataTime, setFirstOffset, setFirstTime, setID, setIndexDataType, setIndexPathName, setIndexType, setItemSize, setLastDataTime, setLastOffset, setLastTime, setLength, setName, setOption, setOptions, setReadOnly, setStartTime, setTerminated, setURI, syncHeader

Methods inherited from interface com.timeindexing.index.ExtendedIndexHeader

addDataType, getAnnotationStyle, getDataSize, getDataType, getItemSize, hasAnnotations, hasDataType

Methods inherited from interface com.timeindexing.index.IndexHeader

getDataPathName, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getLastDataTime, getLastTime, getLength, getName, getStartTime, getURI, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated

Methods inherited from interface com.timeindexing.event.IndexEventGenerator

addAccessEventListener, addAddEventListener, addPrimaryEventListener, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener

Method Detail

retrieveItem

long retrieveItem(IndexItem item,
                  long position)

Retrieve an Index Item into the Index. This is a callback for the IOInteractor.

Parameters:

item - the IndexItem to add

position - the position to add the item at

Returns:

the no of items in the cache

readData

DataHolderObject readData(long pos,
                          DataReference dataReference)

Read data for an index item given an index position and a DataReference.