com.timeindexing.index
Class ExternalIndex

java.lang.Object
  com.timeindexing.index.AbstractIndex
      com.timeindexing.index.FileIndex
          com.timeindexing.index.ExternalIndex

All Implemented Interfaces:

IndexEventGenerator, ExtendedIndex, ExtendedIndexHeader, Index, IndexHeader, ManagedIndex, ManagedIndexHeader, StoredIndex

Direct Known Subclasses:

ShadowIndex

public class ExternalIndex
extends FileIndex
implements ManagedIndex

An implementation of an external Index object. It represents the index header, the index stream and the data stream.

Constructor Summary

ExternalIndex()
Create an ExternalIndex

Method Summary

boolean	addIndexURI(ID indexID, java.net.URI URIName) Add a new indexID/indexURI
IndexView	addView() Add a view to this index.
IndexView	asView() Get a view onto the Index.
protected void	checkCreateProperties(java.util.Properties indexProperties) Check that all the properties needed to create are passed in.
protected void	checkOpenProperties(java.util.Properties indexProperties) Check that all the properties needed to open are passed in.
boolean	close() Close this index.
boolean	closeView(IndexView view) Close this index.
boolean	create(java.util.Properties properties) Called when an ExternalIndex needs to be created.
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 void	init() Initialize the object.
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	open(java.util.Properties properties) Called when an ExternalIndex needs to be opend.
long	removeView(IndexView view) Remove a view from 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 com.timeindexing.index.FileIndex

activate, addItem, addItem, addItem, addReference, addReference, addReference, addReference, addReference, commit, generateURI, getFirstOffset, getHeaderPathName, getItem, getLastFlushPosition, getLastFlushTime, getLastOffset, isWriteLocked, readData, reallyClose, retrieveItem, writeItem

Methods inherited from class com.timeindexing.index.AbstractIndex

addAccessEventListener, addAddEventListener, addDataType, addItem, addPrimaryEventListener, apply, binarySearch, contains, contains, eventMulticaster, filter, getAnnotationStyle, getCache, getCachePolicy, getDataPathName, getDataSize, getDataType, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getIndexType, getItem, getItem, getItem, getItemSize, getLastAccessTime, getLastDataTime, getLastTime, getLength, getLoadDataAutomatically, getName, getStartTime, getURI, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated, iterator, locate, locate, locate, locate, map, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener, select, select, select, select, setAutoCommit, setCachePolicy, setLastAccessTime, setLoadDataAutomatically, terminate, updateDescription

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, addView, closeView, getHeader, getTrackedIndex, isTrackingIndex, listTrackedIndexes, reallyClose, removeView, trackReferencedIndex

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, 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.ManagedIndexHeader

addIndexURI, getAllOptions, getIndexURI, getOption, hasIndexURI, hasOption, listOptions, notInTimeOrder, setDataPathName, setDataSize, setDescription, setEndTime, setFirstDataTime, setFirstOffset, setFirstTime, setID, setIndexDataType, setIndexPathName, setIndexType, setItemSize, setLastDataTime, setLastOffset, setLastTime, setLength, setName, setOption, setOptions, setReadOnly, setStartTime, setTerminated, setURI, syncHeader

Methods inherited from interface com.timeindexing.index.ExtendedIndexHeader

addDataType, getAnnotationStyle, getDataSize, getDataType, getItemSize, hasAnnotations, hasDataType

Methods inherited from interface com.timeindexing.index.IndexHeader

getDataPathName, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getLastDataTime, getLastTime, getLength, getName, getStartTime, getURI, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated

Methods inherited from interface com.timeindexing.event.IndexEventGenerator

addAccessEventListener, addAddEventListener, addPrimaryEventListener, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener

Constructor Detail

ExternalIndex

public ExternalIndex()
              throws IndexSpecificationException

Create an ExternalIndex

Throws:

IndexSpecificationException

Method Detail

init

protected void init()

Initialize the object.

open

public boolean open(java.util.Properties properties)
             throws IndexSpecificationException,
                    IndexOpenException

Called when an ExternalIndex needs to be opend.

Specified by:

open in interface ManagedIndex

Throws:

IndexSpecificationException

IndexOpenException

create

public boolean create(java.util.Properties properties)
               throws IndexSpecificationException,
                      IndexCreateException

Called when an ExternalIndex needs to be created.

Specified by:

create in interface ManagedIndex

Throws:

IndexSpecificationException

IndexCreateException

checkOpenProperties

protected void checkOpenProperties(java.util.Properties indexProperties)
                            throws IndexSpecificationException

Check that all the properties needed to open are passed in.

Throws:

IndexSpecificationException

checkCreateProperties

protected void checkCreateProperties(java.util.Properties indexProperties)
                              throws IndexSpecificationException

Check that all the properties needed to create are passed in.

Throws:

IndexSpecificationException

setName

public ManagedIndexHeader setName(java.lang.String name)

Set the name of the index.

Specified by:

setName in interface ManagedIndexHeader

setID

public ManagedIndexHeader setID(ID id)

Set the ID of the index.

Specified by:

setID in interface ManagedIndexHeader

setURI

public ManagedIndexHeader setURI(java.net.URI uri)

Set the URI of the index.

Specified by:

setURI in interface ManagedIndexHeader

setStartTime

public ManagedIndexHeader setStartTime(Timestamp start)

Set the start time

Specified by:

setStartTime in interface ManagedIndexHeader

setEndTime

public ManagedIndexHeader setEndTime(Timestamp end)

Set the end time

Specified by:

setEndTime in interface ManagedIndexHeader

setFirstTime

public ManagedIndexHeader setFirstTime(Timestamp first)

Set the first time

Specified by:

setFirstTime in interface ManagedIndexHeader

setLastTime

public ManagedIndexHeader setLastTime(Timestamp last)

Set the last time

Specified by:

setLastTime in interface ManagedIndexHeader

setFirstDataTime

public ManagedIndexHeader setFirstDataTime(Timestamp first)

Set the first data time

Specified by:

setFirstDataTime in interface ManagedIndexHeader

setLastDataTime

public ManagedIndexHeader setLastDataTime(Timestamp last)

Set the last data time

Specified by:

setLastDataTime in interface ManagedIndexHeader

setLength

public ManagedIndexHeader setLength(long length)

Set the no of items in the index.

Specified by:

setLength in interface ManagedIndexHeader

setTerminated

public ManagedIndexHeader setTerminated(boolean t)

Set the index to be terminated.

Specified by:

setTerminated in interface ManagedIndexHeader

setItemSize

public ManagedIndexHeader setItemSize(int size)

Set the size of the index items.

Specified by:

setItemSize in interface ManagedIndexHeader

setDataSize

public ManagedIndexHeader setDataSize(long size)

Set the size of the data items, if there is fixed size data.

Specified by:

setDataSize in interface ManagedIndexHeader

setFirstOffset

public ManagedIndexHeader setFirstOffset(Offset offset)

Set the Offset of the fisrt item.

Specified by:

setFirstOffset in interface ManagedIndexHeader

setLastOffset

public ManagedIndexHeader setLastOffset(Offset offset)

Set the Offset of the last item.

Specified by:

setLastOffset in interface ManagedIndexHeader

setIndexType

public ManagedIndexHeader setIndexType(IndexType type)

Set the type of the index. Either inline or external or shadow.

Specified by:

setIndexType in interface ManagedIndexHeader

setIndexDataType

public ManagedIndexHeader setIndexDataType(DataType type)

Set the data type of the index. Some indexes have the same type throughout, other have mixed type data.

Specified by:

setIndexDataType in interface ManagedIndexHeader

setIndexPathName

public ManagedIndexHeader setIndexPathName(java.lang.String path)

Set the path of the index file

Specified by:

setIndexPathName in interface ManagedIndexHeader

setDataPathName

public ManagedIndexHeader setDataPathName(java.lang.String path)

Set the path of the data if the index data style is external or shadow.

Specified by:

setDataPathName in interface ManagedIndexHeader

setDescription

public ManagedIndexHeader setDescription(Description d)

Set the description. This is one of the few attributes of an index that can be set directly.

Specified by:

setDescription in interface ManagedIndexHeader

setReadOnly

public ManagedIndexHeader setReadOnly(boolean readonly)

Set the read only status.

Specified by:

setReadOnly in interface ManagedIndexHeader

notInTimeOrder

public ManagedIndexHeader notInTimeOrder()

State that the index is not in time order any more.

Specified by:

notInTimeOrder in interface ManagedIndexHeader

getIndexURI

public java.net.URI getIndexURI(ID indexID)

Get the index URI of a nominated index.

Specified by:

getIndexURI in interface ExtendedIndexHeader

Specified by:

getIndexURI in interface ManagedIndexHeader

hasIndexURI

public boolean hasIndexURI(java.net.URI URIName)

Does this index have the URI of some other index

Specified by:

hasIndexURI in interface ExtendedIndexHeader

Specified by:

hasIndexURI in interface ManagedIndexHeader

addIndexURI

public boolean addIndexURI(ID indexID,
                           java.net.URI URIName)

Add a new indexID/indexURI

Specified by:

addIndexURI in interface ExtendedIndexHeader

Specified by:

addIndexURI in interface ManagedIndexHeader

Returns:

true, if a new index URI was added; false, if the index had this ID/URI pair already

getOption

public java.lang.Object getOption(HeaderOption option)

Get an option from the header.

Specified by:

getOption in interface ManagedIndexHeader

setOption

public ManagedIndexHeader setOption(HeaderOption option,
                                    java.lang.Object object)

Set an option in the header.

Specified by:

setOption in interface ManagedIndexHeader

hasOption

public boolean hasOption(HeaderOption option)

Does an option exist in the header.

Specified by:

hasOption in interface ManagedIndexHeader

listOptions

public java.util.Set listOptions()

Get the set of optional header values.

Specified by:

listOptions in interface ManagedIndexHeader

getAllOptions

public IndexProperties getAllOptions()

Get all the option from the header.

Specified by:

getAllOptions in interface ManagedIndexHeader

setOptions

public ManagedIndexHeader setOptions(IndexProperties someProperties)

Set options in the header based on the passed IndexProperties.

Specified by:

setOptions in interface ManagedIndexHeader

trackReferencedIndex

public int trackReferencedIndex(Index index)

Track a Referenced Index.

Specified by:

trackReferencedIndex in interface ManagedIndex

Returns:

the number of tracked indexes

isTrackingIndex

public boolean isTrackingIndex(ID indexID)

Is an Index being tracked

Specified by:

isTrackingIndex in interface ManagedIndex

getTrackedIndex

public Index getTrackedIndex(ID indexID)

Get an Index being tracked

Specified by:

getTrackedIndex in interface ManagedIndex

listTrackedIndexes

public java.util.Collection listTrackedIndexes()

List all the Referenced Indexes.

Specified by:

listTrackedIndexes in interface ManagedIndex

getHeader

public ManagedIndexHeader getHeader()

Get the headerfor the index.

Specified by:

getHeader in interface ManagedIndex

syncHeader

public boolean syncHeader(ManagedIndexHeader indexHeader)

Syncrhronize the values in this index header from values in a specified IndexHeader object.

Specified by:

syncHeader in interface ManagedIndexHeader

close

public boolean close()
              throws IndexCloseException

Close this index.

Specified by:

close in interface Index

Returns:

true if the index is really closed by calling this

Throws:

IndexCloseException

closeView

public boolean closeView(IndexView view)
                  throws IndexCloseException

Close this index.

Specified by:

closeView in interface ManagedIndex

Returns:

true if the index is really closed by calling this

Throws:

IndexCloseException

isOpen

protected boolean isOpen(java.lang.String name)

Try and determine if this index is alreay open

asView

public IndexView asView()

Get a view onto the Index.

Specified by:

asView in interface Index

addView

public IndexView addView()

Add a view to this index.

Specified by:

addView in interface ManagedIndex

Returns:

the IndexView itself

removeView

public long removeView(IndexView view)

Remove a view from this index.

Specified by:

removeView in interface ManagedIndex

Returns:

How many views are still left on the Index