|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public ManagedIndexHeader setName(java.lang.String name)
public ManagedIndexHeader setID(ID id)
public ManagedIndexHeader setURI(java.net.URI uri)
public ManagedIndexHeader setStartTime(Timestamp start)
public ManagedIndexHeader setEndTime(Timestamp end)
public ManagedIndexHeader setFirstTime(Timestamp first)
public ManagedIndexHeader setLastTime(Timestamp last)
public ManagedIndexHeader setFirstDataTime(Timestamp first)
public ManagedIndexHeader setLastDataTime(Timestamp last)
public ManagedIndexHeader setLength(long length)
public ManagedIndexHeader setTerminated(boolean terminated)
public ManagedIndexHeader setItemSize(int size)
public ManagedIndexHeader setDataSize(long size)
public ManagedIndexHeader setFirstOffset(Offset offset)
public ManagedIndexHeader setLastOffset(Offset offset)
public ManagedIndexHeader setIndexType(IndexType type)
public ManagedIndexHeader setIndexDataType(DataType dataType)
public ManagedIndexHeader setIndexPathName(java.lang.String path)
public ManagedIndexHeader setDataPathName(java.lang.String path)
public ManagedIndexHeader setDescription(Description description)
public ManagedIndexHeader setReadOnly(boolean readonly)
public ManagedIndexHeader notInTimeOrder()
public java.net.URI getIndexURI(ID indexID)
getIndexURI
in interface ExtendedIndexHeader
public boolean hasIndexURI(java.net.URI URIName)
hasIndexURI
in interface ExtendedIndexHeader
public boolean addIndexURI(ID indexID, java.net.URI URIName)
addIndexURI
in interface ExtendedIndexHeader
public java.lang.Object getOption(HeaderOption option)
public boolean hasOption(HeaderOption option)
public java.util.Set listOptions()
public IndexProperties getAllOptions()
public ManagedIndexHeader setOption(HeaderOption option, java.lang.Object object)
public ManagedIndexHeader setOptions(IndexProperties someProperties)
public boolean syncHeader(ManagedIndexHeader indexHeader)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |