com.timeindexing.index
Interface ManagedIndexHeader

All Superinterfaces:
ExtendedIndexHeader, IndexHeader
All Known Subinterfaces:
ManagedIndex, StoredIndex
All Known Implementing Classes:
AbstractManagedIndex, DefaultIndexHeader, ExternalIndex, FileIndex, IncoreIndex, IncoreIndexHeader, IndexDecoder, InlineIndex, ShadowIndex, SQLIndex

public interface ManagedIndexHeader
extends ExtendedIndexHeader

A managed extended index header. This is the interface to an index header whic has extra attributes that can be set.


Method Summary
 boolean addIndexURI(ID indexID, java.net.URI URIName)
          Add a new indexID/indexURI
 IndexProperties getAllOptions()
          Get all the option from the header.
 java.net.URI getIndexURI(ID indexID)
          Get the index URI of a nominated index.
 java.lang.Object getOption(HeaderOption option)
          Get an option from the header.
 boolean hasIndexURI(java.net.URI URIName)
          Does this index have the URI of some other index
 boolean hasOption(HeaderOption option)
          Does an option exist in the header.
 java.util.Set listOptions()
          Get the set of optional header values used in this header.
 ManagedIndexHeader notInTimeOrder()
          State that the index is not in time order any more.
 ManagedIndexHeader setDataPathName(java.lang.String path)
          Set the path of the data if the index data style is external or shadow.
 ManagedIndexHeader setDataSize(long size)
          Set the size of the data items, if there is fixed size data.
 ManagedIndexHeader setDescription(Description description)
          Set the description.
 ManagedIndexHeader setEndTime(Timestamp end)
          Set the end time
 ManagedIndexHeader setFirstDataTime(Timestamp first)
          Set the data time of the first item
 ManagedIndexHeader setFirstOffset(Offset offset)
          Set the Offset of the fisrt item.
 ManagedIndexHeader setFirstTime(Timestamp first)
          Set the first time
 ManagedIndexHeader setID(ID id)
          Set the ID of the index.
 ManagedIndexHeader setIndexDataType(DataType dataType)
          Set the data type of the index.
 ManagedIndexHeader setIndexPathName(java.lang.String path)
          Set the path of the index file.
 ManagedIndexHeader setIndexType(IndexType type)
          Get the data style.
 ManagedIndexHeader setItemSize(int size)
          Set the size of the index items.
 ManagedIndexHeader setLastDataTime(Timestamp last)
          Set the data time of the last item
 ManagedIndexHeader setLastOffset(Offset offset)
          Set the Offset of the last item.
 ManagedIndexHeader setLastTime(Timestamp last)
          Set the last time
 ManagedIndexHeader setLength(long length)
          Set the no of items in the index.
 ManagedIndexHeader setName(java.lang.String name)
          Set the name of the index.
 ManagedIndexHeader setOption(HeaderOption option, java.lang.Object object)
          Set an option in the header.
 ManagedIndexHeader setOptions(IndexProperties someProperties)
          Set options in the header based on the passed IndexProperties.
 ManagedIndexHeader setReadOnly(boolean readonly)
          Set the read only status.
 ManagedIndexHeader setStartTime(Timestamp start)
          Set the start time
 ManagedIndexHeader setTerminated(boolean terminated)
          Set the index to be terminated.
 ManagedIndexHeader setURI(java.net.URI uri)
          Set the URI of the index.
 boolean syncHeader(ManagedIndexHeader indexHeader)
          Syncrhronize the values in this index header from values in a specified IndexHeader object.
 
Methods inherited from interface com.timeindexing.index.ExtendedIndexHeader
addDataType, getAnnotationStyle, getDataSize, getDataType, getFirstOffset, getItemSize, getLastOffset, hasAnnotations, hasDataType
 
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

setName

public ManagedIndexHeader setName(java.lang.String name)
Set the name of the index.


setID

public ManagedIndexHeader setID(ID id)
Set the ID of the index.


setURI

public ManagedIndexHeader setURI(java.net.URI uri)
Set the URI of the index.


setStartTime

public ManagedIndexHeader setStartTime(Timestamp start)
Set the start time


setEndTime

public ManagedIndexHeader setEndTime(Timestamp end)
Set the end time


setFirstTime

public ManagedIndexHeader setFirstTime(Timestamp first)
Set the first time


setLastTime

public ManagedIndexHeader setLastTime(Timestamp last)
Set the last time


setFirstDataTime

public ManagedIndexHeader setFirstDataTime(Timestamp first)
Set the data time of the first item


setLastDataTime

public ManagedIndexHeader setLastDataTime(Timestamp last)
Set the data time of the last item


setLength

public ManagedIndexHeader setLength(long length)
Set the no of items in the index.


setTerminated

public ManagedIndexHeader setTerminated(boolean terminated)
Set the index to be terminated.


setItemSize

public ManagedIndexHeader setItemSize(int size)
Set the size of the index items.


setDataSize

public ManagedIndexHeader setDataSize(long size)
Set the size of the data items, if there is fixed size data.


setFirstOffset

public ManagedIndexHeader setFirstOffset(Offset offset)
Set the Offset of the fisrt item.


setLastOffset

public ManagedIndexHeader setLastOffset(Offset offset)
Set the Offset of the last item.


setIndexType

public ManagedIndexHeader setIndexType(IndexType type)
Get the data style. Either inline or external or shadow.


setIndexDataType

public ManagedIndexHeader setIndexDataType(DataType dataType)
Set the data type of the index. Some indexes have the same type throughout, other have mixed type data.


setIndexPathName

public ManagedIndexHeader setIndexPathName(java.lang.String path)
Set the path of the index file.


setDataPathName

public ManagedIndexHeader setDataPathName(java.lang.String path)
Set the path of the data if the index data style is external or shadow.


setDescription

public ManagedIndexHeader setDescription(Description description)
Set the description. This is one of the few attributes of an index that can be set directly.


setReadOnly

public ManagedIndexHeader setReadOnly(boolean readonly)
Set the read only status.


notInTimeOrder

public ManagedIndexHeader notInTimeOrder()
State that the index is not in time order any more.


getIndexURI

public java.net.URI getIndexURI(ID indexID)
Get the index URI of a nominated index.

Specified by:
getIndexURI in interface ExtendedIndexHeader

hasIndexURI

public boolean hasIndexURI(java.net.URI URIName)
Does this index have the URI of some other index

Specified by:
hasIndexURI in interface ExtendedIndexHeader

addIndexURI

public boolean addIndexURI(ID indexID,
                           java.net.URI URIName)
Add a new indexID/indexURI

Specified by:
addIndexURI in interface ExtendedIndexHeader
Returns:
true, if a new index URI was added; false, if the index had this ID/URI pair already

getOption

public java.lang.Object getOption(HeaderOption option)
Get an option from the header.


hasOption

public boolean hasOption(HeaderOption option)
Does an option exist in the header.


listOptions

public java.util.Set listOptions()
Get the set of optional header values used in this header.


getAllOptions

public IndexProperties getAllOptions()
Get all the option from the header.


setOption

public ManagedIndexHeader setOption(HeaderOption option,
                                    java.lang.Object object)
Set an option in the header.


setOptions

public ManagedIndexHeader setOptions(IndexProperties someProperties)
Set options in the header based on the passed IndexProperties.


syncHeader

public boolean syncHeader(ManagedIndexHeader indexHeader)
Syncrhronize the values in this index header from values in a specified IndexHeader object.