Package org.apache.jackrabbit.oak.index.indexer.document

Class DocumentStoreIndexerBase

java.lang.Object

org.apache.jackrabbit.oak.index.indexer.document.DocumentStoreIndexerBase

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DocumentStoreIndexer

public abstract class DocumentStoreIndexerBase
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected final Closer	closer
static final String	INDEXER_METRICS_PREFIX
protected NodeStateIndexerProvider	indexerProvider
protected final IndexerSupport	indexerSupport
protected final IndexHelper	indexHelper
static final String	METRIC_FULL_INDEX_CREATION_DURATION_SECONDS
static final String	METRIC_INDEXING_DURATION_SECONDS

Constructor Summary

Constructors

Constructor	Description
DocumentStoreIndexerBase(IndexHelper indexHelper, IndexerSupport indexerSupport)

Method Summary

Modifier and Type	Method	Description
IndexStore	buildFlatFileStore()	Deprecated. replaced by buildStore()
IndexStore	buildStore()
IndexStore	buildStore(String initialCheckpoint, String finalCheckpoint)
IndexStore	buildStore(String initialCheckpoint, String finalCheckpoint, long maxDurationSeconds)
IndexStore	buildTreeStore()
void	close()
protected abstract NodeStateIndexerProvider	createProvider()
protected abstract void	preIndexOperations(List<NodeStateIndexer> indexers)
protected CompositeIndexer	prepareIndexers(NodeStore copyOnWriteStore, NodeBuilder builder, org.apache.jackrabbit.oak.plugins.index.progress.IndexingProgressReporter progressReporter)
void	reindex()
protected void	setProvider()

Methods inherited from class java.lang.Object

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

Field Details

INDEXER_METRICS_PREFIX

public static final String INDEXER_METRICS_PREFIX

See Also:

• Constant Field Values

METRIC_INDEXING_DURATION_SECONDS

public static final String METRIC_INDEXING_DURATION_SECONDS

See Also:

• Constant Field Values

METRIC_FULL_INDEX_CREATION_DURATION_SECONDS

public static final String METRIC_FULL_INDEX_CREATION_DURATION_SECONDS

See Also:

• Constant Field Values

closer

protected final Closer closer

indexHelper

protected final IndexHelper indexHelper

indexerProvider

protected NodeStateIndexerProvider indexerProvider

indexerSupport

protected final IndexerSupport indexerSupport

Constructor Details

DocumentStoreIndexerBase

public DocumentStoreIndexerBase(IndexHelper indexHelper,
 IndexerSupport indexerSupport)

Method Details

setProvider

protected void setProvider()
                    throws IOException

Throws:

IOException

buildTreeStore

public IndexStore buildTreeStore()
                          throws IOException,
CommitFailedException

Throws:

IOException

CommitFailedException

buildStore

public IndexStore buildStore()
                      throws IOException,
CommitFailedException

Throws:

IOException

CommitFailedException

buildStore

public IndexStore buildStore(String initialCheckpoint,
 String finalCheckpoint)
                      throws IOException,
CommitFailedException

Throws:

IOException

CommitFailedException

buildStore

public IndexStore buildStore(String initialCheckpoint,
 String finalCheckpoint,
 long maxDurationSeconds)
                      throws IOException,
CommitFailedException

Throws:

IOException

CommitFailedException

buildFlatFileStore

@Deprecated
public IndexStore buildFlatFileStore()
                              throws IOException,
CommitFailedException

Deprecated.

replaced by buildStore()

Returns:

an Instance of FlatFileStore, whose getFlatFileStorePath() method can be used to get the absolute path to this store.

Throws:

IOException

CommitFailedException

reindex

public void reindex()
             throws CommitFailedException,
IOException

Throws:

CommitFailedException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

prepareIndexers

protected CompositeIndexer prepareIndexers(NodeStore copyOnWriteStore,
 NodeBuilder builder,
 org.apache.jackrabbit.oak.plugins.index.progress.IndexingProgressReporter progressReporter)

createProvider

protected abstract NodeStateIndexerProvider createProvider()
                                                    throws IOException

Throws:

IOException

preIndexOperations

protected abstract void preIndexOperations(List<NodeStateIndexer> indexers)