Class IndexWriterConfigExtensions

Extension methods that can be used to provide similar IndexWriterConfig syntax as Java Lucene. (config.SetCheckIntegrityAtMerge(100).SetMaxBufferedDocs(1000);)

Inheritance

object

IndexWriterConfigExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Index.Extensions

Assembly: Lucene.Net.dll

Syntax

public static class IndexWriterConfigExtensions

Methods

SetCheckIntegrityAtMerge(IndexWriterConfig, bool)

Builder method for CheckIntegrityAtMerge.

Declaration

public static IndexWriterConfig SetCheckIntegrityAtMerge(this IndexWriterConfig config, bool checkIntegrityAtMerge)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
bool	checkIntegrityAtMerge

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetCheckIntegrityAtMerge(LiveIndexWriterConfig, bool)

Builder method for CheckIntegrityAtMerge.

Declaration

public static LiveIndexWriterConfig SetCheckIntegrityAtMerge(this LiveIndexWriterConfig config, bool checkIntegrityAtMerge)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
bool	checkIntegrityAtMerge

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetCodec(IndexWriterConfig, Codec)

Builder method for Codec.

Declaration

public static IndexWriterConfig SetCodec(this IndexWriterConfig config, Codec codec)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
Codec	codec

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetDefaultWriteLockTimeout(IndexWriterConfig, long)

Builder method for DefaultWriteLockTimeout.

Declaration

public static IndexWriterConfig SetDefaultWriteLockTimeout(this IndexWriterConfig config, long writeLockTimeout)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
long	writeLockTimeout

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetIndexCommit(IndexWriterConfig, IndexCommit)

Builder method for IndexCommit.

Declaration

public static IndexWriterConfig SetIndexCommit(this IndexWriterConfig config, IndexCommit commit)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
IndexCommit	commit

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetIndexDeletionPolicy(IndexWriterConfig, IndexDeletionPolicy)

Builder method for IndexDeletionPolicy.

Declaration

public static IndexWriterConfig SetIndexDeletionPolicy(this IndexWriterConfig config, IndexDeletionPolicy deletionPolicy)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
IndexDeletionPolicy	deletionPolicy

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMaxBufferedDeleteTerms(IndexWriterConfig, int)

Builder method for MaxBufferedDeleteTerms.

Declaration

public static IndexWriterConfig SetMaxBufferedDeleteTerms(this IndexWriterConfig config, int maxBufferedDeleteTerms)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
int	maxBufferedDeleteTerms

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMaxBufferedDeleteTerms(LiveIndexWriterConfig, int)

Builder method for MaxBufferedDeleteTerms.

Declaration

public static LiveIndexWriterConfig SetMaxBufferedDeleteTerms(this LiveIndexWriterConfig config, int maxBufferedDeleteTerms)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
int	maxBufferedDeleteTerms

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetMaxBufferedDocs(IndexWriterConfig, int)

Builder method for MaxBufferedDocs.

Declaration

public static IndexWriterConfig SetMaxBufferedDocs(this IndexWriterConfig config, int maxBufferedDocs)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
int	maxBufferedDocs

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMaxBufferedDocs(LiveIndexWriterConfig, int)

Builder method for MaxBufferedDocs.

Declaration

public static LiveIndexWriterConfig SetMaxBufferedDocs(this LiveIndexWriterConfig config, int maxBufferedDocs)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
int	maxBufferedDocs

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetMaxThreadStates(IndexWriterConfig, int)

Builder method for MaxThreadStates.

Declaration

public static IndexWriterConfig SetMaxThreadStates(this IndexWriterConfig config, int maxThreadStates)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
int	maxThreadStates

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMergePolicy(IndexWriterConfig, MergePolicy)

Builder method for MergePolicy.

Declaration

public static IndexWriterConfig SetMergePolicy(this IndexWriterConfig config, MergePolicy mergePolicy)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
MergePolicy	mergePolicy

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMergeScheduler(IndexWriterConfig, IMergeScheduler)

Builder method for MergeScheduler.

Declaration

public static IndexWriterConfig SetMergeScheduler(this IndexWriterConfig config, IMergeScheduler mergeScheduler)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
IMergeScheduler	mergeScheduler

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMergedSegmentWarmer(IndexWriterConfig, IndexReaderWarmer)

Builder method for MergedSegmentWarmer.

Declaration

public static IndexWriterConfig SetMergedSegmentWarmer(this IndexWriterConfig config, IndexWriter.IndexReaderWarmer mergeSegmentWarmer)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
IndexWriter.IndexReaderWarmer	mergeSegmentWarmer

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetMergedSegmentWarmer(LiveIndexWriterConfig, IndexReaderWarmer)

Builder method for MergedSegmentWarmer.

Declaration

public static LiveIndexWriterConfig SetMergedSegmentWarmer(this LiveIndexWriterConfig config, IndexWriter.IndexReaderWarmer mergeSegmentWarmer)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
IndexWriter.IndexReaderWarmer	mergeSegmentWarmer

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetOpenMode(IndexWriterConfig, OpenMode)

Builder method for OpenMode.

Declaration

public static IndexWriterConfig SetOpenMode(this IndexWriterConfig config, OpenMode openMode)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
OpenMode	openMode

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetRAMBufferSizeMB(IndexWriterConfig, double)

Builder method for RAMBufferSizeMB.

Declaration

public static IndexWriterConfig SetRAMBufferSizeMB(this IndexWriterConfig config, double ramBufferSizeMB)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
double	ramBufferSizeMB

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetRAMBufferSizeMB(LiveIndexWriterConfig, double)

Builder method for RAMBufferSizeMB.

Declaration

public static LiveIndexWriterConfig SetRAMBufferSizeMB(this LiveIndexWriterConfig config, double ramBufferSizeMB)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
double	ramBufferSizeMB

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetRAMPerThreadHardLimitMB(IndexWriterConfig, int)

Builder method for RAMPerThreadHardLimitMB.

Declaration

public static IndexWriterConfig SetRAMPerThreadHardLimitMB(this IndexWriterConfig config, int perThreadHardLimitMB)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
int	perThreadHardLimitMB

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetReaderPooling(IndexWriterConfig, bool)

Builder method for UseReaderPooling.

Declaration

public static IndexWriterConfig SetReaderPooling(this IndexWriterConfig config, bool readerPooling)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
bool	readerPooling

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetReaderTermsIndexDivisor(IndexWriterConfig, int)

Builder method for ReaderTermsIndexDivisor.

Declaration

public static IndexWriterConfig SetReaderTermsIndexDivisor(this IndexWriterConfig config, int divisor)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
int	divisor

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetReaderTermsIndexDivisor(LiveIndexWriterConfig, int)

Builder method for ReaderTermsIndexDivisor.

Declaration

public static LiveIndexWriterConfig SetReaderTermsIndexDivisor(this LiveIndexWriterConfig config, int divisor)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
int	divisor

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetSimilarity(IndexWriterConfig, Similarity)

Builder method for Similarity.

Declaration

public static IndexWriterConfig SetSimilarity(this IndexWriterConfig config, Similarity similarity)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
Similarity	similarity

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetTermIndexInterval(IndexWriterConfig, int)

Builder method for TermIndexInterval.

Declaration

public static IndexWriterConfig SetTermIndexInterval(this IndexWriterConfig config, int interval)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
int	interval

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetTermIndexInterval(LiveIndexWriterConfig, int)

Builder method for TermIndexInterval.

Declaration

public static LiveIndexWriterConfig SetTermIndexInterval(this LiveIndexWriterConfig config, int interval)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
int	interval

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetUseCompoundFile(IndexWriterConfig, bool)

Builder method for UseCompoundFile.

Declaration

public static IndexWriterConfig SetUseCompoundFile(this IndexWriterConfig config, bool useCompoundFile)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
bool	useCompoundFile

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance

SetUseCompoundFile(LiveIndexWriterConfig, bool)

Builder method for UseCompoundFile.

Declaration

public static LiveIndexWriterConfig SetUseCompoundFile(this LiveIndexWriterConfig config, bool useCompoundFile)

Parameters

Type	Name	Description
LiveIndexWriterConfig	config	this LiveIndexWriterConfig instance
bool	useCompoundFile

Returns

Type	Description
LiveIndexWriterConfig	this LiveIndexWriterConfig instance

SetWriteLockTimeout(IndexWriterConfig, long)

Builder method for WriteLockTimeout.

Declaration

public static IndexWriterConfig SetWriteLockTimeout(this IndexWriterConfig config, long writeLockTimeout)

Parameters

Type	Name	Description
IndexWriterConfig	config	this IndexWriterConfig instance
long	writeLockTimeout

Returns

Type	Description
IndexWriterConfig	this IndexWriterConfig instance