org.infinispan.lucene.impl

Class DirectoryBuilderImpl

java.lang.Object

org.infinispan.lucene.impl.DirectoryBuilderImpl

All Implemented Interfaces:

BuildContext

public class DirectoryBuilderImpl
extends Object
implements BuildContext

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE Used as default chunk size: each Lucene index segment is split into smaller parts having a default size in bytes as defined here

Constructor Summary

Constructors

Constructor and Description
DirectoryBuilderImpl(Cache<?,?> metadataCache, Cache<?,?> chunksCache, Cache<?,?> distLocksCache, String indexName)

Method Summary

Modifier and Type	Method and Description
BuildContext	affinityLocationIntoSegment(int segmentId) When set to a positive integer, this will force a specific data distribution: the hashing function will resolve all keys used to store the various entries for the resulting index to be owned by the specified segment id.
BuildContext	chunkSize(int bytes) Sets the chunkSize option for the Directory being created.
org.apache.lucene.store.Directory	create() Creates a Directory instance
BuildContext	deleteOperationsExecutor(Executor executor) Provides an Executor to handle delete operations in a background thread
BuildContext	overrideSegmentReadLocker(SegmentReadLocker srl) Overrides the default SegmentReadLocker.
BuildContext	overrideWriteLocker(org.apache.lucene.store.LockFactory lockFactory) Overrides the IndexWriter LockFactory
BuildContext	writeFileListAsynchronously(boolean writeFileListAsync) When set to true, the list of files of the Directory is propagated to other nodes asynchronously.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

Used as default chunk size: each Lucene index segment is split into smaller parts having a default size in bytes as defined here

See Also:

Constant Field Values

Constructor Detail

DirectoryBuilderImpl

public DirectoryBuilderImpl(Cache<?,?> metadataCache,
                            Cache<?,?> chunksCache,
                            Cache<?,?> distLocksCache,
                            String indexName)

Method Detail

create

public org.apache.lucene.store.Directory create()

Description copied from interface: BuildContext

Creates a Directory instance

Specified by:

create in interface BuildContext

Returns:

the new Directory

See Also:

Directory

chunkSize

public BuildContext chunkSize(int bytes)

Description copied from interface: BuildContext

Sets the chunkSize option for the Directory being created.

Specified by:

chunkSize in interface BuildContext

Parameters:

bytes - segments are fragmented in chunkSize bytes; larger values are more efficient for searching but less for distribution and network replication

Returns:

the same building context to eventually create the Directory instance

overrideSegmentReadLocker

public BuildContext overrideSegmentReadLocker(SegmentReadLocker srl)

Description copied from interface: BuildContext

Overrides the default SegmentReadLocker. In some cases you might be able to provide more efficient implementations than the default one by controlling the IndexReader's lifecycle

Specified by:

overrideSegmentReadLocker in interface BuildContext

Parameters:

srl - the new read locking strategy for fragmented segments

Returns:

the same building context to eventually create the Directory instance

See Also:

org.infinispan.lucene.readlocks

affinityLocationIntoSegment

public BuildContext affinityLocationIntoSegment(int segmentId)

Description copied from interface: BuildContext

When set to a positive integer, this will force a specific data distribution: the hashing function will resolve all keys used to store the various entries for the resulting index to be owned by the specified segment id. Use with caution, as this will obviously lead into a severely unbalanced distribution.

Specified by:

affinityLocationIntoSegment in interface BuildContext

Returns:

writeFileListAsynchronously

public BuildContext writeFileListAsynchronously(boolean writeFileListAsync)

Description copied from interface: BuildContext

When set to true, the list of files of the Directory is propagated to other nodes asynchronously. This implies that a committed change to the index will not immediately be accessible by searching threads on other nodes, but the gap in time is not longer than the time of a single RPC so this gap should not be measurable unless there is some form of congestion. Currently defaults to false as it's safer.

Specified by:

writeFileListAsynchronously in interface BuildContext

Returns:

the same building context to eventually create the Directory instance

deleteOperationsExecutor

public BuildContext deleteOperationsExecutor(Executor executor)

Description copied from interface: BuildContext

Provides an Executor to handle delete operations in a background thread

Specified by:

deleteOperationsExecutor in interface BuildContext

Returns:

overrideWriteLocker

public BuildContext overrideWriteLocker(org.apache.lucene.store.LockFactory lockFactory)

Description copied from interface: BuildContext

Overrides the IndexWriter LockFactory

Specified by:

overrideWriteLocker in interface BuildContext

Parameters:

lockFactory - the LockFactory to be used by IndexWriters.

Returns:

the same building context to eventually create the Directory instance

See Also:

org.infinispan.lucene.locking