|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An index. This is the generic interface to an index. It has all the methods for the header and for all the data requests.
Method Summary | |
Index |
activate()
Make the Index activated. |
boolean |
addDataType(ID typeID,
java.lang.String typeName)
Add a new data type |
long |
addItem(DataItem item)
Add a Data Item to the Index. |
long |
addItem(DataItem item,
Timestamp dataTime)
Add a Data Item to the Index with a speicifed Data Timestamp |
long |
addReference(IndexItem item,
Index other)
Add a Reference to an IndexItem in a Index. |
long |
addReference(IndexItem item,
Index other,
Timestamp dataTime)
Add a Reference to an IndexItem in a Index. |
IndexView |
asView()
Get a view onto the Index. |
boolean |
close()
Close the index. |
boolean |
commit()
Commit all changes to the index. |
boolean |
contains(Timestamp t,
IndexTimestampSelector sel)
Does a timestamp fall within the bounds of the Index. |
int |
getAnnotationStyle()
Get the annotation style. |
java.lang.String |
getDataType(ID typeID)
Get the type name of the things in the data stream. |
IndexItem |
getItem(long n)
Get an Index Item from the Index. |
IndexItem |
getItem(Position p)
Get an Index Item from the Index. |
IndexItem |
getItem(Timestamp t,
IndexTimestampSelector sel,
Lifetime lifetime)
Get an Index Item from the Index. |
int |
getItemSize()
Get the size of the index items. |
Timestamp |
getLastAccessTime()
Get the last time an IndexItem was accessed from the index. |
boolean |
hasAnnotations()
Does this index have annotations. |
boolean |
hasDataType(java.lang.String typeName)
Does this index have a typed name. |
boolean |
isActivated()
Is the Index activated. |
boolean |
isChanged()
Has the index changed in any way. |
boolean |
isClosed()
Is the Index closed. |
boolean |
isWriteLocked()
Has the Index been write-locked. |
java.util.Iterator |
iterator()
Get an iterator over the IndexItems in the Index. |
TimestampMapping |
locate(Position p,
IndexTimestampSelector sel,
Lifetime lifetime)
Try and determine the Timestamp associated with the speicifed Position. |
TimestampMapping |
locate(Timestamp t,
IndexTimestampSelector sel,
Lifetime lifetime)
Try and determine the position associated with the speicifed Timestamp. |
boolean |
setAutoCommit(boolean commit)
Set auto commit to be true or false. |
boolean |
setCachePolicy(CachePolicy policy)
Set a CachePolicy in order to manage the cache. |
Index |
terminate()
Make the Index finalized. |
Index |
updateDescription(Description description)
Update the description of this index. |
Methods inherited from interface com.timeindexing.index.IndexHeader |
getDataPathName, getDataSize, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getIndexType, getLastDataTime, getLastTime, getLength, getName, getStartTime, getURI, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated |
Method Detail |
public int getItemSize()
public java.lang.String getDataType(ID typeID)
public boolean hasDataType(java.lang.String typeName)
public boolean addDataType(ID typeID, java.lang.String typeName)
public boolean hasAnnotations()
public int getAnnotationStyle()
public Index updateDescription(Description description)
public long addItem(DataItem item) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long addItem(DataItem item, Timestamp dataTime) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long addReference(IndexItem item, Index other) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long addReference(IndexItem item, Index other, Timestamp dataTime) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public IndexItem getItem(long n) throws GetItemException
GetItemException
public IndexItem getItem(Position p) throws GetItemException
GetItemException
public IndexItem getItem(Timestamp t, IndexTimestampSelector sel, Lifetime lifetime) throws GetItemException
GetItemException
public boolean contains(Timestamp t, IndexTimestampSelector sel)
public TimestampMapping locate(Timestamp t, IndexTimestampSelector sel, Lifetime lifetime)
public TimestampMapping locate(Position p, IndexTimestampSelector sel, Lifetime lifetime)
public Timestamp getLastAccessTime()
public boolean isActivated()
public Index activate() throws IndexReadOnlyException, IndexWriteLockedException
IndexReadOnlyException
IndexWriteLockedException
public Index terminate()
public boolean commit() throws IndexCommitException
IndexCommitException
public boolean setAutoCommit(boolean commit)
public boolean isClosed()
public boolean close() throws IndexCloseException
IndexCloseException
public boolean isChanged()
public boolean isWriteLocked()
public java.util.Iterator iterator()
public IndexView asView()
public boolean setCachePolicy(CachePolicy policy)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |