|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.timeindexing.index.DefaultIndexHeader
The default index header implementation. It holds all the values in an index header.
| Constructor Summary | |
protected |
DefaultIndexHeader()
Create a DefaultIndexHeader object. |
|
DefaultIndexHeader(java.lang.String name)
Create a DefaultIndexHeader object. |
| 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 |
IndexProperties |
getAllOptions()
Get all the option from the header. |
int |
getAnnotationStyle()
Get the annotation style. |
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. |
java.lang.String |
getDataType(ID typeID)
Get the type name of the things in the data stream. |
Description |
getDescription()
Get the description for an index. |
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. |
Timestamp |
getFirstDataTime()
Get the data time for the first IndexItem in the Index. |
Offset |
getFirstOffset()
Get the Offset of the fisrt item. |
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 index data type. |
java.lang.String |
getIndexPathName()
Get the path of the index file. |
IndexType |
getIndexType()
Get the data style. |
java.net.URI |
getIndexURI(ID indexID)
Get the index URI of a nominated index. |
int |
getItemSize()
Get the size of the items. |
Timestamp |
getLastDataTime()
Get the data time for the last IndexItem in the Index. |
Offset |
getLastOffset()
Get the Offset of the last item. |
Timestamp |
getLastTime()
Get the time the last IndexItem was put into the Index. |
long |
getLength()
Get the length of the index. |
java.lang.String |
getName()
Get the name of the index. |
java.lang.Object |
getOption(HeaderOption option)
Get an option from the header. |
Timestamp |
getStartTime()
Get the start time of the index. |
java.net.URI |
getURI()
Get the Index specification in the form of a URI. |
java.lang.Object |
getValue(java.lang.String name)
Get a value from the header. |
int |
getVersionMajor()
Get the major version no. |
int |
getVersionMinor()
Get the minor version no. |
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 |
boolean |
hasOption(HeaderOption option)
Does an option exist in the header. |
boolean |
isFixedSizeData()
Does the index have fixed size data. |
boolean |
isInTimeOrder()
State that the index is not in time order any more. |
boolean |
isReadOnly()
Is the Index only available for read-only operations. |
boolean |
isTerminated()
Is the Index terminated. |
java.util.Set |
listOptions()
Get the set of optional header values. |
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 d)
Set the description. |
ManagedIndexHeader |
setEndTime(Timestamp end)
Set the end time |
ManagedIndexHeader |
setFirstDataTime(Timestamp first)
Set the first data time |
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 type)
Set the data type of the index. |
ManagedIndexHeader |
setIndexPathName(java.lang.String path)
Set the path of the index file |
ManagedIndexHeader |
setIndexType(IndexType type)
Set the data style. |
ManagedIndexHeader |
setInTimeOrder()
State that the index is in time order. |
ManagedIndexHeader |
setItemSize(int size)
Set the size of the index items. |
ManagedIndexHeader |
setLastDataTime(Timestamp last)
Set the last data time |
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 t)
Set the index to be terminated. |
ManagedIndexHeader |
setURI(java.net.URI uri)
Set the URI of the index. |
ManagedIndexHeader |
setVersionMajor(int maj)
Set the major version no. |
ManagedIndexHeader |
setVersionMinor(int min)
Set the minor version no. |
boolean |
syncHeader(ManagedIndexHeader indexHeader)
Syncrhronize the values in this index header from values in a specified IndexHeader object. |
java.lang.String |
toString()
A strign version of the header. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
protected DefaultIndexHeader()
public DefaultIndexHeader(java.lang.String name)
| Method Detail |
public java.lang.String getName()
getName in interface IndexHeaderpublic ManagedIndexHeader setName(java.lang.String name)
setName in interface ManagedIndexHeaderpublic ID getID()
getID in interface IndexHeaderpublic ManagedIndexHeader setID(ID id)
setID in interface ManagedIndexHeaderpublic java.net.URI getURI()
getURI in interface IndexHeaderpublic ManagedIndexHeader setURI(java.net.URI uri)
setURI in interface ManagedIndexHeaderpublic Timestamp getStartTime()
getStartTime in interface IndexHeaderpublic ManagedIndexHeader setStartTime(Timestamp start)
setStartTime in interface ManagedIndexHeaderpublic Timestamp getEndTime()
getEndTime in interface IndexHeaderpublic ManagedIndexHeader setEndTime(Timestamp end)
setEndTime in interface ManagedIndexHeaderpublic Timestamp getFirstTime()
getFirstTime in interface IndexHeaderpublic ManagedIndexHeader setFirstTime(Timestamp first)
setFirstTime in interface ManagedIndexHeaderpublic Timestamp getLastTime()
getLastTime in interface IndexHeaderpublic ManagedIndexHeader setLastTime(Timestamp last)
setLastTime in interface ManagedIndexHeaderpublic Timestamp getFirstDataTime()
getFirstDataTime in interface IndexHeaderpublic ManagedIndexHeader setFirstDataTime(Timestamp first)
setFirstDataTime in interface ManagedIndexHeaderpublic Timestamp getLastDataTime()
getLastDataTime in interface IndexHeaderpublic ManagedIndexHeader setLastDataTime(Timestamp last)
setLastDataTime in interface ManagedIndexHeaderpublic long getLength()
getLength in interface IndexHeaderpublic ManagedIndexHeader setLength(long length)
setLength in interface ManagedIndexHeaderpublic boolean isTerminated()
isTerminated in interface IndexHeaderpublic ManagedIndexHeader setTerminated(boolean t)
setTerminated in interface ManagedIndexHeaderpublic Offset getFirstOffset()
getFirstOffset in interface ExtendedIndexHeaderpublic ManagedIndexHeader setFirstOffset(Offset offset)
setFirstOffset in interface ManagedIndexHeaderpublic Offset getLastOffset()
getLastOffset in interface ExtendedIndexHeaderpublic ManagedIndexHeader setLastOffset(Offset offset)
setLastOffset in interface ManagedIndexHeaderpublic int getItemSize()
getItemSize in interface ExtendedIndexHeaderpublic ManagedIndexHeader setItemSize(int size)
setItemSize in interface ManagedIndexHeaderpublic boolean isFixedSizeData()
isFixedSizeData in interface IndexHeaderpublic long getDataSize()
getDataSize in interface ExtendedIndexHeaderpublic ManagedIndexHeader setDataSize(long size)
setDataSize in interface ManagedIndexHeaderpublic IndexType getIndexType()
getIndexType in interface IndexHeaderpublic ManagedIndexHeader setIndexType(IndexType type)
setIndexType in interface ManagedIndexHeaderpublic DataType getIndexDataType()
getIndexDataType in interface IndexHeaderpublic ManagedIndexHeader setIndexDataType(DataType type)
setIndexDataType in interface ManagedIndexHeaderpublic java.lang.String getIndexPathName()
getIndexPathName in interface IndexHeaderpublic ManagedIndexHeader setIndexPathName(java.lang.String path)
setIndexPathName in interface ManagedIndexHeaderpublic java.lang.String getDataPathName()
getDataPathName in interface IndexHeaderpublic ManagedIndexHeader setDataPathName(java.lang.String path)
setDataPathName in interface ManagedIndexHeaderpublic Description getDescription()
getDescription in interface IndexHeaderpublic ManagedIndexHeader setDescription(Description d)
setDescription in interface ManagedIndexHeaderpublic boolean isReadOnly()
isReadOnly in interface IndexHeaderpublic ManagedIndexHeader setReadOnly(boolean readonly)
setReadOnly in interface ManagedIndexHeaderpublic boolean isInTimeOrder()
isInTimeOrder in interface IndexHeaderpublic ManagedIndexHeader setInTimeOrder()
public ManagedIndexHeader notInTimeOrder()
notInTimeOrder in interface ManagedIndexHeaderpublic boolean hasAnnotations()
hasAnnotations in interface ExtendedIndexHeaderpublic int getAnnotationStyle()
getAnnotationStyle in interface ExtendedIndexHeaderpublic java.lang.String getDataType(ID typeID)
getDataType in interface ExtendedIndexHeaderpublic boolean hasDataType(java.lang.String typeName)
hasDataType in interface ExtendedIndexHeader
public boolean addDataType(ID typeID,
java.lang.String typeName)
addDataType in interface ExtendedIndexHeaderpublic java.net.URI getIndexURI(ID indexID)
getIndexURI in interface ManagedIndexHeaderpublic boolean hasIndexURI(java.net.URI URIName)
hasIndexURI in interface ManagedIndexHeader
public boolean addIndexURI(ID indexID,
java.net.URI URIName)
addIndexURI in interface ManagedIndexHeaderpublic int getVersionMajor()
public ManagedIndexHeader setVersionMajor(int maj)
public int getVersionMinor()
public ManagedIndexHeader setVersionMinor(int min)
public boolean syncHeader(ManagedIndexHeader indexHeader)
syncHeader in interface ManagedIndexHeaderpublic java.lang.Object getValue(java.lang.String name)
public java.lang.Object getOption(HeaderOption option)
getOption in interface ManagedIndexHeader
public ManagedIndexHeader setOption(HeaderOption option,
java.lang.Object object)
setOption in interface ManagedIndexHeaderpublic boolean hasOption(HeaderOption option)
hasOption in interface ManagedIndexHeaderpublic java.util.Set listOptions()
listOptions in interface ManagedIndexHeaderpublic IndexProperties getAllOptions()
getAllOptions in interface ManagedIndexHeaderpublic ManagedIndexHeader setOptions(IndexProperties someProperties)
setOptions in interface ManagedIndexHeaderpublic java.lang.String toString()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||