Interface ITaxonomyDirectoryFactory

Namespace

Examine.Lucene.Directories

Assembly

Examine.Lucene.dll

Creates a Lucene Lucene.Net.Store.Directory for taxonomy-based faceting on an index

public interface ITaxonomyDirectoryFactory

Remarks

Implement this interface alongside IDirectoryFactory to enable taxonomy-based faceting. If an IDirectoryFactory does not also implement this interface, taxonomy faceting will not be available.

Methods

CreateTaxonomyDirectory(LuceneIndex, bool)

Creates the directory instance for the Taxonomy Index

Directory? CreateTaxonomyDirectory(LuceneIndex luceneIndex, bool forceUnlock)

Parameters

luceneIndex LuceneIndex

forceUnlock bool

If true, will force unlock the directory when created

Returns

Directory

The taxonomy directory, or null if taxonomy is not enabled for this index

Remarks

Any subsequent calls for the same index will return the same directory instance. If this returns null, taxonomy-based faceting will not be available for this index.