Class FilterDirectoryReader
A FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it.
Subclasses should implement DoWrapDirectoryReader(DirectoryReader) to return an instance of the subclass.
If the subclass wants to wrap the DirectoryReader's subreaders, it should also implement a FilterDirectoryReader.SubReaderWrapper subclass, and pass an instance to its base constructor.
Inheritance
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class FilterDirectoryReader : DirectoryReaderConstructors
| Improve this Doc View SourceFilterDirectoryReader(DirectoryReader)
Create a new FilterDirectoryReader that filters a passed in DirectoryReader.
Declaration
public FilterDirectoryReader(DirectoryReader input)Parameters
| Type | Name | Description |
|---|---|---|
| DirectoryReader | input | the DirectoryReader to filter |
FilterDirectoryReader(DirectoryReader, FilterDirectoryReader.SubReaderWrapper)
Create a new FilterDirectoryReader that filters a passed in DirectoryReader, using the supplied FilterDirectoryReader.SubReaderWrapper to wrap its subreader.
Declaration
public FilterDirectoryReader(DirectoryReader input, FilterDirectoryReader.SubReaderWrapper wrapper)Parameters
| Type | Name | Description |
|---|---|---|
| DirectoryReader | input | the DirectoryReader to filter |
| FilterDirectoryReader.SubReaderWrapper | wrapper | the FilterDirectoryReader.SubReaderWrapper to use to wrap subreaders |
Fields
| Improve this Doc View Sourcem_input
The filtered DirectoryReader
Declaration
protected readonly DirectoryReader m_inputField Value
| Type | Description |
|---|---|
| DirectoryReader |
Properties
| Improve this Doc View SourceIndexCommit
Declaration
public override IndexCommit IndexCommit { get; }Property Value
| Type | Description |
|---|---|
| IndexCommit |
Overrides
| Improve this Doc View SourceVersion
Declaration
public override long Version { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Overrides
Methods
| Improve this Doc View SourceDoClose()
Declaration
protected override void DoClose()Overrides
| Improve this Doc View SourceDoOpenIfChanged()
Declaration
protected override sealed DirectoryReader DoOpenIfChanged()Returns
| Type | Description |
|---|---|
| DirectoryReader |
Overrides
| Improve this Doc View SourceDoOpenIfChanged(IndexCommit)
Declaration
protected override sealed DirectoryReader DoOpenIfChanged(IndexCommit commit)Parameters
| Type | Name | Description |
|---|---|---|
| IndexCommit | commit |
Returns
| Type | Description |
|---|---|
| DirectoryReader |
Overrides
| Improve this Doc View SourceDoOpenIfChanged(IndexWriter, Boolean)
Declaration
protected override sealed DirectoryReader DoOpenIfChanged(IndexWriter writer, bool applyAllDeletes)Parameters
| Type | Name | Description |
|---|---|---|
| IndexWriter | writer | |
| System.Boolean | applyAllDeletes |
Returns
| Type | Description |
|---|---|
| DirectoryReader |
Overrides
| Improve this Doc View SourceDoWrapDirectoryReader(DirectoryReader)
Called by the DoOpenIfChanged() methods to return a new wrapped DirectoryReader.
Implementations should just return an instance of themselves, wrapping the passed in DirectoryReader.
Declaration
protected abstract DirectoryReader DoWrapDirectoryReader(DirectoryReader input)Parameters
| Type | Name | Description |
|---|---|---|
| DirectoryReader | input | the DirectoryReader to wrap |
Returns
| Type | Description |
|---|---|
| DirectoryReader | the wrapped DirectoryReader |
IsCurrent()
Declaration
public override bool IsCurrent()Returns
| Type | Description |
|---|---|
| System.Boolean |