com.timeindexing.index
Interface StoredIndex

All Superinterfaces:
ExtendedIndex, ExtendedIndexHeader, Index, IndexEventGenerator, IndexHeader, ManagedIndex, ManagedIndexHeader
All Known Implementing Classes:
FileIndex, 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(DataReference dataReference)
          Read data for an index item given a DataReference.
 long retrieveItem(IndexItem item, long position)
          Retrieve an Index Item into the Index.
 
Methods inherited from interface com.timeindexing.index.ManagedIndex
addReference, create, getHeader, getTrackedIndex, isTrackingIndex, listTrackedIndexes, open, reallyClose, 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, addReference, addReference, asView, close, commit, contains, getAnnotationStyle, getDataType, getItem, getItem, getItem, getItemSize, getLastAccessTime, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isWriteLocked, iterator, locate, locate, setAutoCommit, setCachePolicy, terminate, updateDescription
 
Methods inherited from interface com.timeindexing.index.IndexHeader
getDataPathName, getDataSize, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getLastDataTime, getLastTime, getLength, getName, getStartTime, getURI, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated
 
Methods inherited from interface com.timeindexing.index.ExtendedIndexHeader
addDataType, addIndexURI, getAnnotationStyle, getDataSize, getDataType, getIndexURI, getItemSize, hasAnnotations, hasDataType, hasIndexURI
 
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.event.IndexEventGenerator
addAccessEventListener, addAddEventListener, addPrimaryEventListener, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener
 

Method Detail

retrieveItem

public long retrieveItem(IndexItem item,
                         long position)
Retrieve an Index Item into the Index.

Parameters:
item - the IndexItem to add
position - the position to add the item at
Returns:
the no of items in the cache

readData

public DataHolderObject readData(DataReference dataReference)
Read data for an index item given a DataReference.