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

Class FlatFileNodeStoreBuilder

java.lang.Object

org.apache.jackrabbit.oak.index.indexer.document.flatfile.FlatFileNodeStoreBuilder

public class FlatFileNodeStoreBuilder
extends Object

This class is where the strategy being selected for building FlatFileStore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FlatFileNodeStoreBuilder.SortStrategyType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OAK_INDEXER_MAX_SORT_MEMORY_IN_GB	Value of this system property indicates max memory that should be used if jmx based memory monitoring is not available.
static final int	OAK_INDEXER_MAX_SORT_MEMORY_IN_GB_DEFAULT
static final String	OAK_INDEXER_SORT_STRATEGY_TYPE	System property name for sort strategy.
static final String	OAK_INDEXER_SORTED_FILE_PATH	System property to define the existing folder containing the flat file store files

Constructor Summary

Constructors

Constructor	Description
FlatFileNodeStoreBuilder(File workDir)

Method Summary

Modifier and Type	Method	Description
FlatFileNodeStoreBuilder	addExistingDataDumpDir(File existingDataDumpDir)
IndexStore	build()
IndexStore	build(IndexHelper indexHelper, List<org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition> indexDefinitions)
List<IndexStore>	buildList(IndexHelper indexHelper, IndexerSupport indexerSupport, List<org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition> indexDefinitions)
IndexStore	buildTreeStoreForIndexing(IndexHelper indexHelper, File file)
File	getFlatFileStoreDir()	Returns the flat file store dir.
FlatFileNodeStoreBuilder	withAheadOfTimeBlobDownloader(boolean aotSupportEnabled)	NOTE: This enables the support for AOT blob download, it does not turn activate it.
FlatFileNodeStoreBuilder	withBlobStore(BlobStore blobStore)
FlatFileNodeStoreBuilder	withCheckpoint(String checkpoint)
FlatFileNodeStoreBuilder	withIndexDefinitions(List<org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition> indexDefinitions)
FlatFileNodeStoreBuilder	withIndexingReporter(IndexingReporter reporter)
FlatFileNodeStoreBuilder	withMinModified(long minModified)	Use the given lower bound of the "_modified" property, when using the document node store.
FlatFileNodeStoreBuilder	withMongoClientURI(com.mongodb.MongoClientURI mongoClientURI)
FlatFileNodeStoreBuilder	withMongoDocumentStore(MongoDocumentStore mongoDocumentStore)
FlatFileNodeStoreBuilder	withNodeStateEntryTraverserFactory(NodeStateEntryTraverserFactory factory)
FlatFileNodeStoreBuilder	withNodeStore(DocumentNodeStore nodeStore)
FlatFileNodeStoreBuilder	withPathPredicate(Predicate<String> pathPredicate)
FlatFileNodeStoreBuilder	withPreferredPathElements(Set<String> preferredPathElements)
FlatFileNodeStoreBuilder	withRootRevision(RevisionVector rootRevision)
FlatFileNodeStoreBuilder	withStatisticsProvider(StatisticsProvider statisticsProvider)

Methods inherited from class java.lang.Object

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

Field Details

OAK_INDEXER_SORT_STRATEGY_TYPE

public static final String OAK_INDEXER_SORT_STRATEGY_TYPE

System property name for sort strategy. Allowed values are the values from enum FlatFileNodeStoreBuilder.SortStrategyType

See Also:

• Constant Field Values

OAK_INDEXER_SORTED_FILE_PATH

public static final String OAK_INDEXER_SORTED_FILE_PATH

System property to define the existing folder containing the flat file store files

See Also:

• Constant Field Values

OAK_INDEXER_MAX_SORT_MEMORY_IN_GB

public static final String OAK_INDEXER_MAX_SORT_MEMORY_IN_GB

Value of this system property indicates max memory that should be used if jmx based memory monitoring is not available.

See Also:

• Constant Field Values

OAK_INDEXER_MAX_SORT_MEMORY_IN_GB_DEFAULT

public static final int OAK_INDEXER_MAX_SORT_MEMORY_IN_GB_DEFAULT

See Also:

• Constant Field Values

Constructor Details

FlatFileNodeStoreBuilder

public FlatFileNodeStoreBuilder(File workDir)

Method Details

withBlobStore

public FlatFileNodeStoreBuilder withBlobStore(BlobStore blobStore)

withPreferredPathElements

public FlatFileNodeStoreBuilder withPreferredPathElements(Set<String> preferredPathElements)

addExistingDataDumpDir

public FlatFileNodeStoreBuilder addExistingDataDumpDir(File existingDataDumpDir)

withNodeStateEntryTraverserFactory

public FlatFileNodeStoreBuilder withNodeStateEntryTraverserFactory(NodeStateEntryTraverserFactory factory)

withPathPredicate

public FlatFileNodeStoreBuilder withPathPredicate(Predicate<String> pathPredicate)

withIndexDefinitions

public FlatFileNodeStoreBuilder withIndexDefinitions(List<org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition> indexDefinitions)

withRootRevision

public FlatFileNodeStoreBuilder withRootRevision(RevisionVector rootRevision)

withNodeStore

public FlatFileNodeStoreBuilder withNodeStore(DocumentNodeStore nodeStore)

withMongoDocumentStore

public FlatFileNodeStoreBuilder withMongoDocumentStore(MongoDocumentStore mongoDocumentStore)

withCheckpoint

public FlatFileNodeStoreBuilder withCheckpoint(String checkpoint)

withMinModified

public FlatFileNodeStoreBuilder withMinModified(long minModified)

Use the given lower bound of the "_modified" property, when using the document node store.

Parameters:

minModified - the minimum value of the "_modified" property

Returns:

this

withMongoClientURI

public FlatFileNodeStoreBuilder withMongoClientURI(com.mongodb.MongoClientURI mongoClientURI)

withStatisticsProvider

public FlatFileNodeStoreBuilder withStatisticsProvider(StatisticsProvider statisticsProvider)

withIndexingReporter

public FlatFileNodeStoreBuilder withIndexingReporter(IndexingReporter reporter)

withAheadOfTimeBlobDownloader

public FlatFileNodeStoreBuilder withAheadOfTimeBlobDownloader(boolean aotSupportEnabled)

NOTE: This enables the support for AOT blob download, it does not turn activate it. To activate it, set the property AheadOfTimeBlobDownloadingFlatFileStore.OAK_INDEXER_BLOB_PREFETCH_BINARY_NODES_SUFFIX to a non-empty value AND enable the support here.

Parameters:

aotSupportEnabled -

build

public IndexStore build()
                 throws IOException,
CompositeException

Throws:

IOException

CompositeException

build

public IndexStore build(IndexHelper indexHelper,
 List<org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition> indexDefinitions)
                 throws IOException,
CompositeException

Throws:

IOException

CompositeException

buildTreeStoreForIndexing

public IndexStore buildTreeStoreForIndexing(IndexHelper indexHelper,
 File file)

buildList

public List<IndexStore> buildList(IndexHelper indexHelper,
 IndexerSupport indexerSupport,
 List<org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition> indexDefinitions)
                           throws IOException,
CompositeException

Throws:

IOException

CompositeException

getFlatFileStoreDir

public File getFlatFileStoreDir()

Returns the flat file store dir. NOTE - Only works after flat file store dir has been built (i.e. after a call to build()

Returns:

flat file store dir or null if it has not been built