Class FieldFilterAtomicReader

A Lucene.Net.Index.FilterAtomicReader that exposes only a subset of fields from the underlying wrapped reader.

Inheritance

object

IndexReader

AtomicReader

FilterAtomicReader

FieldFilterAtomicReader

Implements

IDisposable

Inherited Members

FilterAtomicReader.Unwrap(AtomicReader)

FilterAtomicReader.LiveDocs

FilterAtomicReader.NumDocs

FilterAtomicReader.MaxDoc

FilterAtomicReader.GetSortedSetDocValues(string)

FilterAtomicReader.CheckIntegrity()

AtomicReader.Context

AtomicReader.AtomicContext

AtomicReader.HasNorms(string)

AtomicReader.DocFreq(Term)

AtomicReader.TotalTermFreq(Term)

AtomicReader.GetSumDocFreq(string)

AtomicReader.GetDocCount(string)

AtomicReader.GetSumTotalTermFreq(string)

AtomicReader.GetTerms(string)

AtomicReader.GetTermDocsEnum(Term)

AtomicReader.GetTermPositionsEnum(Term)

IndexReader.AddReaderDisposedListener(IReaderDisposedListener)

IndexReader.RemoveReaderDisposedListener(IReaderDisposedListener)

IndexReader.RegisterParentReader(IndexReader)

IndexReader.RefCount

IndexReader.IncRef()

IndexReader.TryIncRef()

IndexReader.DecRef()

IndexReader.Equals(object)

IndexReader.GetHashCode()

IndexReader.Open(Directory)

IndexReader.Open(Directory, int)

IndexReader.Open(IndexWriter, bool)

IndexReader.Open(IndexCommit)

IndexReader.Open(IndexCommit, int)

IndexReader.GetTermVector(int, string)

IndexReader.NumDeletedDocs

IndexReader.Document(int)

IndexReader.Document(int, ISet<string>)

IndexReader.HasDeletions

IndexReader.Dispose()

IndexReader.Leaves

IndexReader.CoreCacheKey

IndexReader.CombinedCoreAndDeletesKey

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.TestFramework.dll

Syntax

public sealed class FieldFilterAtomicReader : FilterAtomicReader, IDisposable

Constructors

FieldFilterAtomicReader(AtomicReader, ISet<string>, bool)

A Lucene.Net.Index.FilterAtomicReader that exposes only a subset of fields from the underlying wrapped reader.

Declaration

public FieldFilterAtomicReader(AtomicReader @in, ISet<string> fields, bool negate)

Parameters

Type	Name	Description
AtomicReader	in
ISet<string>	fields
bool	negate

Properties

FieldInfos

Get the Lucene.Net.Index.FieldInfos describing all fields in this reader.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public override FieldInfos FieldInfos { get; }

Property Value

Type	Description
FieldInfos

Overrides

Lucene.Net.Index.FilterAtomicReader.FieldInfos

Fields

Returns Lucene.Net.Index.Fields for this reader. this property may return null if the reader has no postings.

Declaration

public override Fields Fields { get; }

Property Value

Type	Description
Fields

Overrides

Lucene.Net.Index.FilterAtomicReader.Fields

Methods

Document(int, StoredFieldVisitor)

Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, use Document(int). If you want to load a subset, use Lucene.Net.Documents.DocumentStoredFieldVisitor.

Declaration

public override void Document(int docID, StoredFieldVisitor visitor)

Parameters

Type	Name	Description
int	docID
StoredFieldVisitor	visitor

Overrides

FilterAtomicReader.Document(int, StoredFieldVisitor)

GetBinaryDocValues(string)

Returns Lucene.Net.Index.BinaryDocValues for this field, or null if no Lucene.Net.Index.BinaryDocValues were indexed for this field. The returned instance should only be used by a single thread.

Declaration

public override BinaryDocValues GetBinaryDocValues(string field)

Parameters

Type	Name	Description
string	field

Returns

Type	Description
BinaryDocValues

Overrides

FilterAtomicReader.GetBinaryDocValues(string)

GetDocsWithField(string)

Returns a Lucene.Net.Util.IBits at the size of reader.MaxDoc, with turned on bits for each docid that does have a value for this field, or null if no Lucene.Net.Index.DocValues were indexed for this field. The returned instance should only be used by a single thread.

Declaration

public override IBits GetDocsWithField(string field)

Parameters

Type	Name	Description
string	field

Returns

Type	Description
IBits

Overrides

FilterAtomicReader.GetDocsWithField(string)

GetNormValues(string)

Returns Lucene.Net.Index.NumericDocValues representing norms for this field, or null if no Lucene.Net.Index.NumericDocValues were indexed. The returned instance should only be used by a single thread.

Declaration

public override NumericDocValues GetNormValues(string field)

Parameters

Type	Name	Description
string	field

Returns

Type	Description
NumericDocValues

Overrides

FilterAtomicReader.GetNormValues(string)

GetNumericDocValues(string)

Returns Lucene.Net.Index.NumericDocValues for this field, or null if no Lucene.Net.Index.NumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

Declaration

public override NumericDocValues GetNumericDocValues(string field)

Parameters

Type	Name	Description
string	field

Returns

Type	Description
NumericDocValues

Overrides

FilterAtomicReader.GetNumericDocValues(string)

GetSortedDocValues(string)

Returns Lucene.Net.Index.SortedDocValues for this field, or null if no Lucene.Net.Index.SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

Declaration

public override SortedDocValues GetSortedDocValues(string field)

Parameters

Type	Name	Description
string	field

Returns

Type	Description
SortedDocValues

Overrides

FilterAtomicReader.GetSortedDocValues(string)

GetTermVectors(int)

Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Lucene.Net.Index.Fields instance acts like a single-document inverted index (the docID will be 0).

Declaration

public override Fields GetTermVectors(int docID)

Parameters

Type	Name	Description
int	docID

Returns

Type	Description
Fields

Overrides

FilterAtomicReader.GetTermVectors(int)

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

Lucene.Net.Index.FilterAtomicReader.ToString()

Implements

IDisposable