com.timeindexing.index
Interface IndexHeader

All Known Subinterfaces:
ExtendedIndex, ExtendedIndexHeader, Index, IndexView, ManagedIndex, ManagedIndexHeader, StoredIndex
All Known Implementing Classes:
AbstractIndex, AbstractManagedIndex, DefaultIndexHeader, ExternalIndex, FileIndex, IncoreIndex, IncoreIndexHeader, IndexDecoder, IndexHeaderIO, InlineIndex, ShadowIndex, SQLIndex, TimeIndex

public interface IndexHeader

An index header. This is the generic interface to an index header.


Method Summary
 java.lang.String getDataPathName()
          Get the path of the data if the index data style is external or shadow.
 long getDataSize()
          Get the size of the data items, if there is fixed size data.
 Description getDescription()
          Get the description for an index.
 Timestamp getEndTime()
          Get the end time of the index.
 Timestamp getFirstDataTime()
          Get the data time for the first IndexItem in the Index.
 Timestamp getFirstTime()
          Get the time the first IndexItem was put into the Index.
 ID getID()
          Get an ID of an index.
 DataType getIndexDataType()
          Get the data type of the index.
 java.lang.String getIndexPathName()
          Get the path of the index.
 IndexType getIndexType()
          Get the style of the index.
 Timestamp getLastDataTime()
          Get the data time for the last IndexItem in the Index.
 Timestamp getLastTime()
          Get the time the last IndexItem was put into the Index.
 long getLength()
          Get the no of items in the index.
 java.lang.String getName()
          The name of the index.
 Timestamp getStartTime()
          Get the start time of the index.
 java.net.URI getURI()
          Get the Index specification in the form of a URI.
 boolean isFixedSizeData()
          Does the index have fixed size data.
 boolean isInTimeOrder()
          Is the index still in time order.
 boolean isReadOnly()
          Is the Index only available for read-only operations.
 boolean isTerminated()
          Is the Index terminated.
 

Method Detail

getName

public java.lang.String getName()
The name of the index.


getID

public ID getID()
Get an ID of an index.


getURI

public java.net.URI getURI()
Get the Index specification in the form of a URI.


getStartTime

public Timestamp getStartTime()
Get the start time of the index. This is when the index was created not necessarliy when the first item was added to the index.


getEndTime

public Timestamp getEndTime()
Get the end time of the index. This is the time the last item was closed, not necessarliy when the last item was added to the index.


getFirstTime

public Timestamp getFirstTime()
Get the time the first IndexItem was put into the Index.

Returns:
ZeroTimestamp if there is no first item, usually when there are no items in the index

getLastTime

public Timestamp getLastTime()
Get the time the last IndexItem was put into the Index.

Returns:
ZeroTimestamp if there is no last item, usually when there are no items in the index

getFirstDataTime

public Timestamp getFirstDataTime()
Get the data time for the first IndexItem in the Index.

Returns:
ZeroTimestamp if there is no first item, usually when there are no items in the index

getLastDataTime

public Timestamp getLastDataTime()
Get the data time for the last IndexItem in the Index.

Returns:
ZeroTimestamp if there is no last item, usually when there are no items in the index

isFixedSizeData

public boolean isFixedSizeData()
Does the index have fixed size data.


getDataSize

public long getDataSize()
Get the size of the data items, if there is fixed size data. The value -1 means variable sized data.


getLength

public long getLength()
Get the no of items in the index.


getIndexType

public IndexType getIndexType()
Get the style of the index. Either inline or external or shadow or incore.


getIndexDataType

public DataType getIndexDataType()
Get the data type of the index. Some indexes have the same type throughout, other have mixed type data.


getIndexPathName

public java.lang.String getIndexPathName()
Get the path of the index.

Returns:
null if there is no index path

getDataPathName

public java.lang.String getDataPathName()
Get the path of the data if the index data style is external or shadow.

Returns:
null if there is no data path

getDescription

public Description getDescription()
Get the description for an index.

Returns:
null if there is no description

isReadOnly

public boolean isReadOnly()
Is the Index only available for read-only operations.


isTerminated

public boolean isTerminated()
Is the Index terminated.


isInTimeOrder

public boolean isInTimeOrder()
Is the index still in time order.