|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.timeindexing.index.TimeIndexFactory
This is the TimeIndexFactory which returns different implementations of a TimeIndex, depending on the arguments to create() or retrieve().
The factory listens to events from Indexes, and will pass them on to any of its listeners.
Constructor Summary | |
TimeIndexFactory()
Create a TimeIndexFactory. |
Method Summary | |
void |
addAccessEventListener(IndexAccessEventListener l)
Add a IndexAccessEventListener. |
void |
addAddEventListener(IndexAddEventListener l)
Add a IndexAddEventListener. |
void |
addPrimaryEventListener(IndexPrimaryEventListener l)
Add a IndexPrimaryEventListener. |
IndexView |
append(java.io.File indexFile)
Append to an index. |
IndexView |
append(java.util.Properties indexProperties)
Append to an index. |
IndexView |
append(java.net.URI uri)
Append to an index. |
boolean |
close(Index index)
Close an index |
void |
closed(IndexPrimaryEvent ipe)
A notification that an Index has been closed. |
void |
committed(IndexPrimaryEvent ipe)
A notification that an Index has been committed. |
IndexView |
create(IndexType kind,
java.io.File indexFile)
Create a new Time Index object given an IndexType. |
IndexView |
create(IndexType kind,
java.util.Properties indexProperties)
Create a new Time Index object given an IndexType. |
IndexView |
create(IndexType kind,
java.net.URI uri)
Create a new Time Index object given an IndexType. |
void |
created(IndexPrimaryEvent ipe)
A notification that an Index has been created. |
IndexEventMulticaster |
eventMulticaster()
Get the event listener. |
IndexView |
find(ID indexID)
Try and find an Index, given its ID. |
void |
itemAccessed(IndexAccessEvent iae)
A notification that an IndexItem has been accessed in an Index. |
void |
itemAdded(IndexAddEvent iae)
A notification that an IndexItem has been added to an Index. |
IndexView |
open(java.io.File indexFile)
Retrieve a TimeIndex object by file name. |
IndexView |
open(java.util.Properties indexProperties)
Retrieve a TimeIndex object by file name. |
IndexView |
open(java.net.URI indexURI)
Retrieve a TimeIndex object by URI. |
void |
opened(IndexPrimaryEvent ipe)
A notification that an Index has been opened. |
void |
removeAccessEventListener(IndexAccessEventListener l)
Remove a IndexAccessEventListener. |
void |
removeAddEventListener(IndexAddEventListener l)
Remove a IndexAddEventListener. |
void |
removePrimaryEventListener(IndexPrimaryEventListener l)
Remove a IndexPrimaryEventListener. |
IndexView |
save(Index index,
IndexType kind,
java.util.Properties indexProperties)
Create a new Index object from an existing Index object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TimeIndexFactory()
Method Detail |
public IndexView create(IndexType kind, java.io.File indexFile) throws TimeIndexFactoryException, IndexSpecificationException, IndexCreateException
kind
- One of IndexType.INLINE, IndexType.EXTERNAL, IndexType.SHADOW, IndexType.INCORE.indexFile
- the file spec of the index
TimeIndexFactoryException
IndexSpecificationException
IndexCreateException
public IndexView create(IndexType kind, java.net.URI uri) throws TimeIndexFactoryException, IndexSpecificationException, IndexCreateException
kind
- One of IndexType.INLINE, IndexType.EXTERNAL, IndexType.SHADOW, IndexType.INCORE.uri
- the uri spec of the index
TimeIndexFactoryException
IndexSpecificationException
IndexCreateException
public IndexView create(IndexType kind, java.util.Properties indexProperties) throws TimeIndexFactoryException, IndexSpecificationException, IndexCreateException
kind
- One of IndexType.INLINE, IndexType.EXTERNAL, IndexType.SHADOW, IndexType.INCORE.indexProperties
- properties of the index needed at creat time, such as its name.
TimeIndexFactoryException
IndexSpecificationException
IndexCreateException
public IndexView open(java.io.File indexFile) throws TimeIndexFactoryException, IndexSpecificationException, IndexOpenException
indexFile
- the file of the index
TimeIndexFactoryException
IndexSpecificationException
IndexOpenException
public IndexView open(java.net.URI indexURI) throws TimeIndexFactoryException, IndexSpecificationException, IndexOpenException
indexURI
- the URI of the index
TimeIndexFactoryException
IndexSpecificationException
IndexOpenException
public IndexView open(java.util.Properties indexProperties) throws TimeIndexFactoryException, IndexSpecificationException, IndexOpenException
TimeIndexFactoryException
IndexSpecificationException
IndexOpenException
public IndexView save(Index index, IndexType kind, java.util.Properties indexProperties) throws TimeIndexFactoryException, IndexSpecificationException, IndexCreateException, TimeIndexException
index
- the original index to convertkind
- One of IndexType.INLINE, IndexType.EXTERNAL, IndexType.INCORE.indexProperties
- properties of the index needed at creat time, such as its name.
TimeIndexFactoryException
IndexSpecificationException
IndexCreateException
TimeIndexException
public IndexView append(java.io.File indexFile) throws TimeIndexFactoryException, IndexSpecificationException, IndexOpenException
indexFile
- the file of the index
TimeIndexFactoryException
IndexSpecificationException
IndexOpenException
public IndexView append(java.net.URI uri) throws TimeIndexFactoryException, IndexSpecificationException, IndexOpenException
uri
- the URI of the index
TimeIndexFactoryException
IndexSpecificationException
IndexOpenException
public IndexView append(java.util.Properties indexProperties) throws TimeIndexFactoryException, IndexSpecificationException, IndexOpenException
indexProperties
- a Properties spec of the index
TimeIndexFactoryException
IndexSpecificationException
IndexOpenException
public IndexView find(ID indexID)
public boolean close(Index index) throws IndexCommitException, IndexCloseException
IndexCommitException
IndexCloseException
public IndexEventMulticaster eventMulticaster()
public void addPrimaryEventListener(IndexPrimaryEventListener l)
addPrimaryEventListener
in interface IndexEventGenerator
public void removePrimaryEventListener(IndexPrimaryEventListener l)
removePrimaryEventListener
in interface IndexEventGenerator
public void addAddEventListener(IndexAddEventListener l)
addAddEventListener
in interface IndexEventGenerator
public void removeAddEventListener(IndexAddEventListener l)
removeAddEventListener
in interface IndexEventGenerator
public void addAccessEventListener(IndexAccessEventListener l)
addAccessEventListener
in interface IndexEventGenerator
public void removeAccessEventListener(IndexAccessEventListener l)
removeAccessEventListener
in interface IndexEventGenerator
public void created(IndexPrimaryEvent ipe)
created
in interface IndexPrimaryEventListener
public void opened(IndexPrimaryEvent ipe)
opened
in interface IndexPrimaryEventListener
public void closed(IndexPrimaryEvent ipe)
closed
in interface IndexPrimaryEventListener
public void committed(IndexPrimaryEvent ipe)
committed
in interface IndexPrimaryEventListener
public void itemAdded(IndexAddEvent iae)
itemAdded
in interface IndexAddEventListener
public void itemAccessed(IndexAccessEvent iae)
itemAccessed
in interface IndexAccessEventListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |