Package org.apache.jackrabbit.oak.index

Class OutOfBandIndexerBase

java.lang.Object

org.apache.jackrabbit.oak.index.OutOfBandIndexerBase

All Implemented Interfaces:

Closeable, AutoCloseable, IndexUpdateCallback, NodeTraversalCallback

Direct Known Subclasses:

OutOfBandIndexer

public abstract class OutOfBandIndexerBase
extends Object
implements Closeable, IndexUpdateCallback, NodeTraversalCallback

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.plugins.index.NodeTraversalCallback

NodeTraversalCallback.PathSource

Field Summary

Fields

Modifier and Type	Field	Description
protected Closer	closer
static String	LOCAL_INDEX_ROOT_DIR	Directory name in output directory under which indexes are stored

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.IndexUpdateCallback

NOOP

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.NodeTraversalCallback

NOOP

Constructor Summary

Constructors

Constructor	Description
OutOfBandIndexerBase(IndexHelper indexHelper, IndexerSupport indexerSupport)

Method Summary

Modifier and Type	Method	Description
void	close()
protected abstract IndexEditorProvider	createIndexEditorProvider()
protected File	getLocalIndexDir()
void	indexUpdate()	Invoked by the IndexEditor for every NodeState indexed it.
void	reindex()
void	traversedNode(NodeTraversalCallback.PathSource pathSource)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

closer

protected final Closer closer

LOCAL_INDEX_ROOT_DIR

public static final String LOCAL_INDEX_ROOT_DIR

Directory name in output directory under which indexes are stored

See Also:

Constant Field Values

Constructor Detail

OutOfBandIndexerBase

public OutOfBandIndexerBase(IndexHelper indexHelper,
                            IndexerSupport indexerSupport)

Method Detail

reindex

public void reindex()
             throws CommitFailedException,
                    IOException

Throws:

CommitFailedException

IOException

getLocalIndexDir

protected File getLocalIndexDir()
                         throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

indexUpdate

public void indexUpdate()

Description copied from interface: IndexUpdateCallback

Invoked by the IndexEditor for every NodeState indexed it.

Specified by:

indexUpdate in interface IndexUpdateCallback

traversedNode

public void traversedNode(NodeTraversalCallback.PathSource pathSource)

Specified by:

traversedNode in interface NodeTraversalCallback

createIndexEditorProvider

protected abstract IndexEditorProvider createIndexEditorProvider()
                                                          throws IOException

Throws:

IOException