Package org.apache.jackrabbit.oak.index
Class OutOfBandIndexerBase
- java.lang.Object
-
- org.apache.jackrabbit.oak.index.OutOfBandIndexerBase
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,IndexUpdateCallback
,NodeTraversalCallback
- Direct Known Subclasses:
OutOfBandIndexer
public abstract class OutOfBandIndexerBase extends java.lang.Object implements java.io.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 org.apache.jackrabbit.guava.common.io.Closer
closer
static java.lang.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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
close()
protected abstract IndexEditorProvider
createIndexEditorProvider()
protected java.io.File
getLocalIndexDir()
void
indexUpdate()
Invoked by theIndexEditor
for every NodeState indexed it.protected void
preformIndexUpdate(NodeState baseState)
void
reindex()
void
traversedNode(NodeTraversalCallback.PathSource pathSource)
-
-
-
Field Detail
-
closer
protected final org.apache.jackrabbit.guava.common.io.Closer closer
-
LOCAL_INDEX_ROOT_DIR
public static final java.lang.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, java.io.IOException
- Throws:
CommitFailedException
java.io.IOException
-
getLocalIndexDir
protected java.io.File getLocalIndexDir() throws java.io.IOException
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Throws:
java.io.IOException
-
indexUpdate
public void indexUpdate() throws CommitFailedException
Description copied from interface:IndexUpdateCallback
Invoked by theIndexEditor
for every NodeState indexed it.- Specified by:
indexUpdate
in interfaceIndexUpdateCallback
- Throws:
CommitFailedException
-
traversedNode
public void traversedNode(NodeTraversalCallback.PathSource pathSource) throws CommitFailedException
- Specified by:
traversedNode
in interfaceNodeTraversalCallback
- Throws:
CommitFailedException
-
preformIndexUpdate
protected void preformIndexUpdate(NodeState baseState) throws java.io.IOException, CommitFailedException
- Throws:
java.io.IOException
CommitFailedException
-
createIndexEditorProvider
protected abstract IndexEditorProvider createIndexEditorProvider() throws java.io.IOException
- Throws:
java.io.IOException
-
-