|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.timeindexing.index.TimeIndex
This is the generic object that applications interact with. It is a view onto an index.
Field Summary | |
boolean |
isTerminated
|
Constructor Summary | |
protected |
TimeIndex(Index impl)
Construct a Time Index using the nominated Index object. |
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 specific Data Timestamp |
long |
addReference(IndexItem otherItem,
Index otherIndex)
Add a Referemnce to an IndexItem in a Index. |
long |
addReference(IndexItem otherItem,
Index otherIndex,
Timestamp dataTS)
Add a Referemnce to an IndexItem in a Index. |
IndexView |
asView()
Get a view onto the Index. |
IndexView |
backward()
Sets the current navigation position into the IndexView to be one backward. |
java.lang.Object |
clone()
Clone me |
boolean |
close()
Close the index. |
boolean |
contains(Timestamp t,
IndexTimestampSelector sel)
Does a timestamp fall within the bounds of the Index. |
IndexView |
exchange()
Exchanges the mark into the IndexView, with the current navigation position. |
protected void |
finalize()
The finalize behviour is to call close(). |
boolean |
flush()
Flush this index. |
IndexView |
forward()
Sets the current navigation position into the IndexView to be one forward. |
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. |
Position |
getEndPosition()
Get the end position, in the index, of this IndexView. |
Timestamp |
getEndTime()
Get the end time of the index. |
Timestamp |
getFirstDataTime()
Get the data time for the first IndexItem in the Index. |
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 type of an index. |
IndexItem |
getItem()
Get the Index Item from the Index at position position(). |
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. |
IndexItem |
getItemAtMark()
Get the Index Item from the Index at position mark(). |
int |
getItemSize()
Get the size of the index items. |
Timestamp |
getLastAccessTime()
Get the last time an IndexItem was accessed from the index. |
Timestamp |
getLastDataTime()
Get the data time for the last IndexItem in the Index. |
Timestamp |
getLastTime()
Get the time the last IndexItem was put into the Index. |
long |
getLength()
Get the no of items in the index. |
java.lang.String |
getName()
The name of the index. |
IndexView |
getSelectionIndexView()
Return the IndexView used to get a selection. |
Interval |
getSelectionInterval()
Return the Interval used to get a selection. |
Position |
getStartPosition()
Get the start position, in the index, of this IndexView. |
Timestamp |
getStartTime()
Get the start time of the index. |
java.net.URI |
getURI()
Get the Index specification in the form of a URI. |
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 |
isFixedSizeData()
Does the index have fixed size data. |
boolean |
isInTimeOrder()
Is the index still in time order. |
boolean |
isReadOnly()
Is the Index only available for read-only operations. |
boolean |
isSelection()
Is this a selection. |
boolean |
isTerminated()
Is the Index terminated. |
boolean |
isWriteLocked()
Has the Index been write-locked. |
java.util.Iterator |
iterator()
Get an iterator over the IndexItems in the Index. |
TimestampMapping |
locate(Timestamp t,
IndexTimestampSelector sel,
Lifetime lifetime)
Try and determine the position associated with the speicifed data Timestamp. |
IndexView |
mark()
Sets the mark into the IndexView, using the current navigation position as the mark value. |
Position |
position()
Gets the current navigation position into the IndexView. |
IndexView |
position(long n)
Sets the current navigation position into the IndexView. |
IndexView |
position(Position p)
Sets the current navigation position into the IndexView specified as a Position. |
IndexView |
position(Timestamp t,
IndexTimestampSelector selector,
Lifetime lifetime)
Sets the current navigation position into the IndexView specified as a Timestamp. |
Interval |
region()
What is the region covered by position and mark. |
IndexView |
select(Interval interval,
IndexTimestampSelector selector,
Overlap overlap,
Lifetime lifetime)
Select an Interval. |
Index |
terminate()
Make the Index finalized. |
Index |
updateDescription(Description description)
Set the description. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public boolean isTerminated
Constructor Detail |
protected TimeIndex(Index impl)
Method Detail |
public java.lang.String getName()
getName
in interface IndexHeader
public ID getID()
getID
in interface IndexHeader
public java.net.URI getURI()
getURI
in interface IndexHeader
public IndexType getIndexType()
getIndexType
in interface IndexHeader
public DataType getIndexDataType()
getIndexDataType
in interface IndexHeader
public Timestamp getStartTime()
getStartTime
in interface IndexHeader
public Timestamp getEndTime()
getEndTime
in interface IndexHeader
public Timestamp getFirstTime()
getFirstTime
in interface IndexHeader
public Timestamp getLastTime()
getLastTime
in interface IndexHeader
public Timestamp getFirstDataTime()
getFirstDataTime
in interface IndexHeader
public Timestamp getLastDataTime()
getLastDataTime
in interface IndexHeader
public int getItemSize()
getItemSize
in interface Index
public boolean isFixedSizeData()
isFixedSizeData
in interface IndexHeader
public long getDataSize()
getDataSize
in interface IndexHeader
public java.lang.String getDataType(ID typeID)
getDataType
in interface Index
public boolean hasDataType(java.lang.String typeName)
hasDataType
in interface Index
public boolean addDataType(ID typeID, java.lang.String typeName)
addDataType
in interface Index
public boolean hasAnnotations()
hasAnnotations
in interface Index
public int getAnnotationStyle()
getAnnotationStyle
in interface Index
public long addItem(DataItem item) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
addItem
in interface Index
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long addItem(DataItem item, Timestamp datatime) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
addItem
in interface Index
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long addReference(IndexItem otherItem, Index otherIndex) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
addReference
in interface Index
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long addReference(IndexItem otherItem, Index otherIndex, Timestamp dataTS) throws IndexTerminatedException, IndexClosedException, IndexActivationException, AddItemException
addReference
in interface Index
IndexTerminatedException
IndexClosedException
IndexActivationException
AddItemException
public long getLength()
getLength
in interface IndexHeader
public IndexItem getItem(long n) throws GetItemException
getItem
in interface Index
GetItemException
public IndexItem getItem(Position p) throws GetItemException
getItem
in interface Index
GetItemException
public IndexItem getItem(Timestamp t, IndexTimestampSelector sel, Lifetime lifetime) throws GetItemException
getItem
in interface Index
GetItemException
public Timestamp getLastAccessTime()
getLastAccessTime
in interface Index
public java.lang.String getIndexPathName()
getIndexPathName
in interface IndexHeader
public java.lang.String getDataPathName()
getDataPathName
in interface IndexHeader
public Description getDescription()
getDescription
in interface IndexHeader
public Index updateDescription(Description description)
updateDescription
in interface Index
public boolean contains(Timestamp t, IndexTimestampSelector sel)
contains
in interface Index
public TimestampMapping locate(Timestamp t, IndexTimestampSelector sel, Lifetime lifetime)
locate
in interface Index
public IndexView select(Interval interval, IndexTimestampSelector selector, Overlap overlap, Lifetime lifetime)
select
in interface IndexView
public Interval getSelectionInterval()
getSelectionInterval
in interface IndexView
public IndexView getSelectionIndexView()
getSelectionIndexView
in interface IndexView
public boolean isSelection()
isSelection
in interface IndexView
public boolean isActivated()
isActivated
in interface Index
public Index activate() throws IndexReadOnlyException, IndexWriteLockedException
activate
in interface Index
IndexReadOnlyException
IndexWriteLockedException
public boolean isTerminated()
isTerminated
in interface IndexHeader
public Index terminate()
terminate
in interface Index
public boolean isInTimeOrder()
isInTimeOrder
in interface IndexHeader
public boolean flush() throws IndexFlushException
flush
in interface Index
IndexFlushException
public boolean isClosed()
isClosed
in interface Index
public boolean close() throws IndexCloseException
close
in interface Index
IndexCloseException
public boolean isChanged()
isChanged
in interface Index
public boolean isReadOnly()
isReadOnly
in interface IndexHeader
public boolean isWriteLocked()
isWriteLocked
in interface Index
public IndexView asView()
asView
in interface Index
public java.util.Iterator iterator()
iterator
in interface Index
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
public Position position()
position
in interface IndexView
public IndexView position(Position p)
position
in interface IndexView
public IndexView position(long n)
position
in interface IndexView
public IndexView position(Timestamp t, IndexTimestampSelector selector, Lifetime lifetime)
position
in interface IndexView
public Position getStartPosition()
getStartPosition
in interface IndexView
public Position getEndPosition()
getEndPosition
in interface IndexView
public IndexView mark()
mark
in interface IndexView
public IndexView forward()
forward
in interface IndexView
public IndexView backward()
backward
in interface IndexView
public IndexItem getItem() throws GetItemException
getItem
in interface IndexView
GetItemException
public IndexItem getItemAtMark() throws GetItemException
getItemAtMark
in interface IndexView
GetItemException
public Interval region()
region
in interface IndexView
public IndexView exchange()
exchange
in interface IndexView
protected void finalize() throws java.lang.Throwable
java.lang.Throwable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |