com.timeindexing.index
Interface IndexView

All Superinterfaces:

Index, IndexHeader

All Known Implementing Classes:

TimeIndex

public interface IndexView
extends Index

An index view has the moethods needed for view on an Index.

Method Summary

IndexView	backward() Sets the current navigation position into the IndexView to be one backward.
IndexView	exchange() Exchanges the mark into the IndexView, with the current navigation position.
IndexView	forward() Sets the current navigation position into the IndexView to be one forward.
Position	getEndPosition() Get the end position, in the index, of this IndexView.
IndexItem	getItem() Get the Index Item from the Index at position position().
IndexItem	getItemAtMark() Get the Index Item from the Index at position mark().
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.
boolean	isSelection() Is the IndexView a selection.
IndexView	mark() Sets the mark into the IndexView, using the current navigation position as the mark value.
IndexView	move(TimeSpecifier ts) Move the current navigation position in the IndexView using the TimeSpecifier.
IndexView	move(TimeSpecifier ts, IndexTimestampSelector selector, Lifetime lifetime) Move the current navigation position in the IndexView using the TimeSpecifier.
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) Sets the current navigation position into the IndexView specified as a Timestamp.
IndexView	position(Timestamp t, IndexTimestampSelector selector, Lifetime lifetime) Sets the current navigation position into the IndexView.
Interval	region() What is the region covered by position and mark.

Methods inherited from interface com.timeindexing.index.Index

activate, addDataType, addItem, addItem, addItem, addReference, addReference, addReference, apply, asView, close, commit, contains, contains, filter, getAnnotationStyle, getCachePolicy, getDataType, getItem, getItem, getItem, getItem, getItemSize, getLastAccessTime, getLoadDataAutomatically, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isWriteLocked, iterator, locate, locate, locate, locate, map, select, select, select, select, setAutoCommit, setCachePolicy, setLoadDataAutomatically, terminate, updateDescription

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

getSelectionInterval

Interval getSelectionInterval()

Return the Interval used to get a selection.

Returns:

null if the view is not a selection.

getSelectionIndexView

IndexView getSelectionIndexView()

Return the IndexView used to get a selection.

Returns:

null if the view is not a selection.

isSelection

boolean isSelection()

Is the IndexView a selection.

position

Position position()

Gets the current navigation position into the IndexView.

position

IndexView position(Position p)

Sets the current navigation position into the IndexView specified as a Position.

position

IndexView position(long n)

Sets the current navigation position into the IndexView. specified as a long.

position

IndexView position(Timestamp t)

Sets the current navigation position into the IndexView specified as a Timestamp. Uses IndexTimestampSelector.DATA and Lifetime.CONTINUOUS as defaults.

position

IndexView position(Timestamp t,
                   IndexTimestampSelector selector,
                   Lifetime lifetime)

Sets the current navigation position into the IndexView. specified as a Timestamp.

getStartPosition

Position getStartPosition()

Get the start position, in the index, of this IndexView.

getEndPosition

Position getEndPosition()

Get the end position, in the index, of this IndexView.

move

IndexView move(TimeSpecifier ts)

Move the current navigation position in the IndexView using the TimeSpecifier. e.g. index.move(new Minutes(10, FORWARD)); Uses IndexTimestampSelector.DATA and Lifetime.CONTINUOUS as defaults.

move

IndexView move(TimeSpecifier ts,
               IndexTimestampSelector selector,
               Lifetime lifetime)

Move the current navigation position in the IndexView using the TimeSpecifier. e.g. index.move(new Minutes(10, FORWARD), IndexTimestampSelector.DATA, Lifetime.CONTINUOUS);

mark

IndexView mark()

Sets the mark into the IndexView, using the current navigation position as the mark value.

forward

IndexView forward()

Sets the current navigation position into the IndexView to be one forward.

backward

IndexView backward()

Sets the current navigation position into the IndexView to be one backward.

getItem

IndexItem getItem()
                  throws GetItemException,
                         IndexClosedException

Get the Index Item from the Index at position position().

Throws:

GetItemException

IndexClosedException

getItemAtMark

IndexItem getItemAtMark()
                        throws GetItemException,
                               IndexClosedException

Get the Index Item from the Index at position mark().

Throws:

GetItemException

IndexClosedException

region

Interval region()

What is the region covered by position and mark. Returned value is an Interval.

exchange

IndexView exchange()

Exchanges the mark into the IndexView, with the current navigation position.