com.timeindexing.index
Class InlineIndex

java.lang.Object
  extended bycom.timeindexing.index.AbstractIndex
      extended bycom.timeindexing.index.AbstractManagedIndex
          extended bycom.timeindexing.index.FileIndex
              extended bycom.timeindexing.index.InlineIndex
All Implemented Interfaces:
ExtendedIndex, ExtendedIndexHeader, Index, IndexEventGenerator, IndexHeader, ManagedIndex, ManagedIndexHeader, StoredIndex

public class InlineIndex
extends FileIndex
implements ManagedIndex

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


Constructor Summary
InlineIndex()
          Create an InlineIndex
InlineIndex(java.lang.String name, java.lang.String indexPath)
          Create an InlineIndex
 
Method Summary
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 create(java.util.Properties properties)
          Called when an InlineIndex needs to be created.
protected  void init()
          Initialize the object.
 boolean open(java.util.Properties properties)
          Called when an InlineIndex needs to be opend.
 
Methods inherited from class com.timeindexing.index.FileIndex
activate, addItem, addItem, addReference, addReference, addReference, flush, generateURI, getFirstOffset, getHeaderPathName, getItem, getLastFlushPosition, getLastFlushTime, getLastOffset, isWriteLocked, readData, reallyClose, retrieveItem, writeItem
 
Methods inherited from class com.timeindexing.index.AbstractManagedIndex
addIndexURI, asView, close, getAllOptions, getHeader, getIndexURI, getOption, getTrackedIndex, hasIndexURI, hasOption, isOpen, isTrackingIndex, listOptions, listTrackedIndexes, 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, trackReferencedIndex
 
Methods inherited from class com.timeindexing.index.AbstractIndex
addAccessEventListener, addAddEventListener, addDataType, addItem, addPrimaryEventListener, binarySearch, contains, eventMulticaster, getAnnotationStyle, getDataPathName, getDataSize, getDataType, getDescription, getEndTime, getFirstDataTime, getFirstTime, getID, getIndexDataType, getIndexPathName, getIndexType, getItem, getItem, getItemSize, getLastAccessTime, getLastDataTime, getLastTime, getLength, getName, getStartTime, getURI, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isFixedSizeData, isInTimeOrder, isReadOnly, isTerminated, iterator, locate, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener, setLastAccessTime, 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, getHeader, getTrackedIndex, isTrackingIndex, listTrackedIndexes, reallyClose, 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, addReference, addReference, asView, close, contains, flush, getAnnotationStyle, getDataType, getItem, getItem, getItem, getItemSize, getLastAccessTime, hasAnnotations, hasDataType, isActivated, isChanged, isClosed, isWriteLocked, iterator, locate, 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, addIndexURI, getAnnotationStyle, getDataSize, getDataType, getIndexURI, getItemSize, hasAnnotations, hasDataType, hasIndexURI
 
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.event.IndexEventGenerator
addAccessEventListener, addAddEventListener, addPrimaryEventListener, removeAccessEventListener, removeAddEventListener, removePrimaryEventListener
 

Constructor Detail

InlineIndex

public InlineIndex()
Create an InlineIndex


InlineIndex

public InlineIndex(java.lang.String name,
                   java.lang.String indexPath)
Create an InlineIndex

Method Detail

init

protected void init()
Initialize the object.


open

public boolean open(java.util.Properties properties)
             throws IndexSpecificationException,
                    IndexOpenException
Called when an InlineIndex 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 InlineIndex 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