com.timeindexing.index
Interface ExtendedIndex

All Superinterfaces:
ExtendedIndexHeader, Index, IndexHeader
All Known Subinterfaces:
ManagedIndex, StoredIndex
All Known Implementing Classes:
AbstractIndex, AbstractManagedIndex, ExternalIndex, FileIndex, IncoreIndex, InlineIndex, ShadowIndex, SQLIndex

public interface ExtendedIndex
extends Index, ExtendedIndexHeader

An interface for classes that need extended Indexes. It has the methods needed to access extra values of an index, but are not generally needed by the application layer.


Method Summary
 Offset getFirstOffset()
          Get the Offset of the fisrt item.
 IndexType getIndexType()
          Get the type of the index.
 Position getLastFlushPosition()
          Get the IndexItem Position when the index was last flushed.
 Timestamp getLastFlushTime()
          Get the last time the index was flushed.
 Offset getLastOffset()
          Get the Offset of the last item.
 
Methods inherited from interface com.timeindexing.index.Index
activate, addDataType, addItem, addItem, addReference, addReference, asView, close, contains, flush, getAnnotationStyle, getDataType, getItem, getItem, getItem, getItemSize, getLastAccessTime, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isWriteLocked, iterator, locate, 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
 

Method Detail

getIndexType

public IndexType getIndexType()
Get the type of the index.

Specified by:
getIndexType in interface IndexHeader

getLastFlushTime

public Timestamp getLastFlushTime()
Get the last time the index was flushed.


getLastFlushPosition

public Position getLastFlushPosition()
Get the IndexItem Position when the index was last flushed.


getFirstOffset

public Offset getFirstOffset()
Get the Offset of the fisrt item.

Specified by:
getFirstOffset in interface ExtendedIndexHeader

getLastOffset

public Offset getLastOffset()
Get the Offset of the last item.

Specified by:
getLastOffset in interface ExtendedIndexHeader