com.timeindexing.index
Interface ExtendedIndexHeader

All Superinterfaces:

IndexHeader

All Known Subinterfaces:

ExtendedIndex, ManagedIndex, ManagedIndexHeader, StoredIndex

All Known Implementing Classes:

AbstractIndex, DefaultIndexHeader, ExternalIndex, FileIndex, IncoreIndex, IncoreIndexHeader, IndexDecoder, IndexHeaderIO, InlineIndex, ShadowIndex, SQLIndex

public interface ExtendedIndexHeader
extends IndexHeader

An extendedindex header. This is the interface to an index header whic has extra attributes.

Method Summary

boolean	addDataType(ID typeID, java.lang.String typeName) Add a new data type
boolean	addIndexURI(ID indexID, java.net.URI URIName) Add a new indexID/indexURI
int	getAnnotationStyle() Get the annotation style.
long	getDataSize() Get the size of the data items, if there is fixed size data.
java.lang.String	getDataType(ID typeID) Get the type name of the things in the data stream.
Offset	getFirstOffset() Get the Offset of the fisrt item.
java.net.URI	getIndexURI(ID indexID) Get the index URI of a nominated index.
int	getItemSize() Get the size of the index items.
Offset	getLastOffset() Get the Offset of the last item.
boolean	hasAnnotations() Does this index have annotations.
boolean	hasDataType(java.lang.String typeName) Does this index have a typed name.
boolean	hasIndexURI(java.net.URI URIName) Does this index have the URI of some other index

Methods inherited from interface com.timeindexing.index.IndexHeader

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

Method Detail

getItemSize

int getItemSize()

Get the size of the index items.

getDataSize

long getDataSize()

Get the size of the data items, if there is fixed size data.

Specified by:

getDataSize in interface IndexHeader

getDataType

java.lang.String getDataType(ID typeID)

Get the type name of the things in the data stream.

hasDataType

boolean hasDataType(java.lang.String typeName)

Does this index have a typed name.

addDataType

boolean addDataType(ID typeID,
                    java.lang.String typeName)

Add a new data type

Returns:

true, if a new type was added; false, if the index had this ID/typeName pair already

hasAnnotations

boolean hasAnnotations()

Does this index have annotations.

getAnnotationStyle

int getAnnotationStyle()

Get the annotation style. Either inline or external.

getIndexURI

java.net.URI getIndexURI(ID indexID)

Get the index URI of a nominated index.

hasIndexURI

boolean hasIndexURI(java.net.URI URIName)

Does this index have the URI of some other index

addIndexURI

boolean addIndexURI(ID indexID,
                    java.net.URI URIName)

Add a new indexID/indexURI

Returns:

true, if a new index URI was added; false, if the index had this ID/URI pair already

getFirstOffset

Offset getFirstOffset()

Get the Offset of the fisrt item.

getLastOffset

Offset getLastOffset()

Get the Offset of the last item.