|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.timeindexing.index.AbstractIndex
com.timeindexing.index.AbstractManagedIndex
An abstract index that has the managed facilities needed by the core of the system, but not accessible to the application layer. This is to be extended by classes that are implementations of indexes.
| Constructor Summary | |
AbstractManagedIndex()
|
|
| Method Summary | |
boolean |
addIndexURI(ID indexID,
java.net.URI URIName)
Add a new indexID/indexURI |
IndexView |
asView()
Get a view onto the Index. |
boolean |
close()
Close this index. |
IndexProperties |
getAllOptions()
Get all the option from the header. |
ManagedIndexHeader |
getHeader()
Get the headerfor the index. |
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. |
Index |
getTrackedIndex(ID indexID)
Get an Index being tracked |
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. |
protected boolean |
isOpen(java.lang.String name)
Try and determine if this index is alreay open |
boolean |
isTrackingIndex(ID indexID)
Is an Index being tracked |
java.util.Set |
listOptions()
Get the set of optional header values. |
java.util.Collection |
listTrackedIndexes()
List all the Referenced Indexes. |
ManagedIndexHeader |
notInTimeOrder()
State that the index is not in time order any more. |
boolean |
reallyClose()
Really close this index. |
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 type of the index. |
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. |
boolean |
syncHeader(ManagedIndexHeader indexHeader)
Syncrhronize the values in this index header from values in a specified IndexHeader object. |
int |
trackReferencedIndex(Index index)
Track a Referenced Index. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.timeindexing.index.ManagedIndex |
addReference, create, open |
| Methods inherited from interface com.timeindexing.index.ExtendedIndex |
getFirstOffset, getIndexType, getLastFlushPosition, getLastFlushTime, getLastOffset |
| Methods inherited from interface com.timeindexing.index.Index |
activate, addDataType, addItem, addItem, addReference, addReference, commit, contains, getAnnotationStyle, getDataType, getItem, getItem, getItem, getItemSize, getLastAccessTime, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isWriteLocked, iterator, locate, locate, setAutoCommit, setCachePolicy, terminate, updateDescription |
| Methods inherited from interface com.timeindexing.index.IndexHeader |
getDataPathName, getDataSize, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getLastDataTime, getLastTime, getLength, getName, getStartTime, getURI, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated |
| Methods inherited from interface com.timeindexing.index.ExtendedIndexHeader |
addDataType, getAnnotationStyle, getDataSize, getDataType, getItemSize, hasAnnotations, hasDataType |
| Methods inherited from interface com.timeindexing.event.IndexEventGenerator |
addAccessEventListener, addAddEventListener, addPrimaryEventListener, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener |
| Constructor Detail |
public AbstractManagedIndex()
| Method Detail |
public ManagedIndexHeader setName(java.lang.String name)
setName in interface ManagedIndexHeaderpublic ManagedIndexHeader setID(ID id)
setID in interface ManagedIndexHeaderpublic ManagedIndexHeader setURI(java.net.URI uri)
setURI in interface ManagedIndexHeaderpublic ManagedIndexHeader setStartTime(Timestamp start)
setStartTime in interface ManagedIndexHeaderpublic ManagedIndexHeader setEndTime(Timestamp end)
setEndTime in interface ManagedIndexHeaderpublic ManagedIndexHeader setFirstTime(Timestamp first)
setFirstTime in interface ManagedIndexHeaderpublic ManagedIndexHeader setLastTime(Timestamp last)
setLastTime in interface ManagedIndexHeaderpublic ManagedIndexHeader setFirstDataTime(Timestamp first)
setFirstDataTime in interface ManagedIndexHeaderpublic ManagedIndexHeader setLastDataTime(Timestamp last)
setLastDataTime in interface ManagedIndexHeaderpublic ManagedIndexHeader setLength(long length)
setLength in interface ManagedIndexHeaderpublic ManagedIndexHeader setTerminated(boolean t)
setTerminated in interface ManagedIndexHeaderpublic ManagedIndexHeader setItemSize(int size)
setItemSize in interface ManagedIndexHeaderpublic ManagedIndexHeader setDataSize(long size)
setDataSize in interface ManagedIndexHeaderpublic ManagedIndexHeader setFirstOffset(Offset offset)
setFirstOffset in interface ManagedIndexHeaderpublic ManagedIndexHeader setLastOffset(Offset offset)
setLastOffset in interface ManagedIndexHeaderpublic ManagedIndexHeader setIndexType(IndexType type)
setIndexType in interface ManagedIndexHeaderpublic ManagedIndexHeader setIndexDataType(DataType type)
setIndexDataType in interface ManagedIndexHeaderpublic ManagedIndexHeader setIndexPathName(java.lang.String path)
setIndexPathName in interface ManagedIndexHeaderpublic ManagedIndexHeader setDataPathName(java.lang.String path)
setDataPathName in interface ManagedIndexHeaderpublic ManagedIndexHeader setDescription(Description d)
setDescription in interface ManagedIndexHeaderpublic ManagedIndexHeader setReadOnly(boolean readonly)
setReadOnly in interface ManagedIndexHeaderpublic ManagedIndexHeader notInTimeOrder()
notInTimeOrder in interface ManagedIndexHeaderpublic java.net.URI getIndexURI(ID indexID)
getIndexURI in interface ExtendedIndexHeaderpublic boolean hasIndexURI(java.net.URI URIName)
hasIndexURI in interface ExtendedIndexHeader
public boolean addIndexURI(ID indexID,
java.net.URI URIName)
addIndexURI in interface ExtendedIndexHeaderpublic 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 int trackReferencedIndex(Index index)
trackReferencedIndex in interface ManagedIndexpublic boolean isTrackingIndex(ID indexID)
isTrackingIndex in interface ManagedIndexpublic Index getTrackedIndex(ID indexID)
getTrackedIndex in interface ManagedIndexpublic java.util.Collection listTrackedIndexes()
listTrackedIndexes in interface ManagedIndexpublic ManagedIndexHeader getHeader()
getHeader in interface ManagedIndexpublic boolean syncHeader(ManagedIndexHeader indexHeader)
syncHeader in interface ManagedIndexHeader
public boolean close()
throws IndexCloseException
close in interface IndexIndexCloseException
public boolean reallyClose()
throws IndexCloseException
reallyClose in interface ManagedIndexIndexCloseExceptionprotected boolean isOpen(java.lang.String name)
public IndexView asView()
asView in interface Index
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||