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

Class DocumentStoreIndexerBase

java.lang.Object

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DocumentStoreIndexer

public abstract class DocumentStoreIndexerBase
extends java.lang.Object
implements java.io.Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.jackrabbit.guava.common.io.Closer	closer
static java.lang.String	INDEXER_METRICS_PREFIX
protected java.util.List<NodeStateIndexerProvider>	indexerProviders
protected IndexerSupport	indexerSupport
protected IndexHelper	indexHelper
static java.lang.String	METRIC_FULL_INDEX_CREATION_DURATION_SECONDS
static java.lang.String	METRIC_INDEXING_DURATION_SECONDS
static java.lang.String	METRIC_MERGE_NODE_STORE_DURATION_SECONDS

Constructor Summary

Constructors

Constructor	Description
DocumentStoreIndexerBase(IndexHelper indexHelper, IndexerSupport indexerSupport)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

INDEXER_METRICS_PREFIX

public static final java.lang.String INDEXER_METRICS_PREFIX

See Also:

Constant Field Values

METRIC_INDEXING_DURATION_SECONDS

public static final java.lang.String METRIC_INDEXING_DURATION_SECONDS

See Also:

Constant Field Values

METRIC_MERGE_NODE_STORE_DURATION_SECONDS

public static final java.lang.String METRIC_MERGE_NODE_STORE_DURATION_SECONDS

See Also:

Constant Field Values

METRIC_FULL_INDEX_CREATION_DURATION_SECONDS

public static final java.lang.String METRIC_FULL_INDEX_CREATION_DURATION_SECONDS

See Also:

Constant Field Values

closer

protected final org.apache.jackrabbit.guava.common.io.Closer closer

indexHelper

protected final IndexHelper indexHelper

indexerProviders

protected java.util.List<NodeStateIndexerProvider> indexerProviders

indexerSupport

protected final IndexerSupport indexerSupport

Constructor Detail

DocumentStoreIndexerBase

public DocumentStoreIndexerBase(IndexHelper indexHelper,
                                IndexerSupport indexerSupport)

Method Detail

setProviders

protected void setProviders()
                     throws java.io.IOException

Throws:

java.io.IOException

buildStore

public IndexStore buildStore()
                      throws java.io.IOException,
                             CommitFailedException

Throws:

java.io.IOException

CommitFailedException

buildStore

public IndexStore buildStore(java.lang.String initialCheckpoint,
                             java.lang.String finalCheckpoint)
                      throws java.io.IOException,
                             CommitFailedException

Throws:

java.io.IOException

CommitFailedException

buildFlatFileStore

@Deprecated
public FlatFileStore buildFlatFileStore()
                                 throws java.io.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:

java.io.IOException

CommitFailedException

reindex

public void reindex()
             throws CommitFailedException,
                    java.io.IOException

Throws:

CommitFailedException

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

prepareIndexers

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

createProviders

protected abstract java.util.List<NodeStateIndexerProvider> createProviders()
                                                                     throws java.io.IOException

Throws:

java.io.IOException

preIndexOperations

protected abstract void preIndexOperations(java.util.List<NodeStateIndexer> indexers)