C# Class Lucene.Net.Index.FilterAtomicReader

A FilterAtomicReader contains another AtomicReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterAtomicReader itself simply implements all abstract methods of IndexReader with versions that pass all requests to the contained index reader. Subclasses of FilterAtomicReader may further override some of these methods and may also provide additional methods and fields.

NOTE: If you override #getLiveDocs(), you will likely need to override #numDocs() as well and vice-versa.

NOTE: If this FilterAtomicReader does not change the content the contained reader, you could consider overriding #getCoreCacheKey() so that IFieldCache and CachingWrapperFilter share the same entries for this atomic reader and the wrapped one. #getCombinedCoreAndDeletesKey() could be overridden as well if the #getLiveDocs() live docs are not changed either.

Inheritance: AtomicReader

Show file Open project: paulirwin/lucene.net

Protected Properties

Property	Type	Description
@in	AtomicReader

Public Methods

Method	Description
CheckIntegrity ( ) : void
Document ( int docID, Lucene.Net.Index.StoredFieldVisitor visitor ) : void
FilterAtomicReader ( AtomicReader @in ) : System.Collections.Generic	Construct a FilterAtomicReader based on the specified base reader. Note that base reader is closed if this FilterAtomicReader is closed.
GetBinaryDocValues ( string field ) : Lucene.Net.Index.BinaryDocValues
GetDocsWithField ( string field ) : Bits
GetNormValues ( string field ) : Lucene.Net.Index.NumericDocValues
GetNumericDocValues ( string field ) : Lucene.Net.Index.NumericDocValues
GetSortedDocValues ( string field ) : Lucene.Net.Index.SortedDocValues
GetSortedSetDocValues ( string field ) : Lucene.Net.Index.SortedSetDocValues
GetTermVectors ( int docID ) : Fields
ToString ( ) : string
Unwrap ( AtomicReader reader ) : AtomicReader	Get the wrapped instance by `reader` as long as this reader is an intance of FilterAtomicReader.

Protected Methods

Method	Description
DoClose ( ) : void

Method Details

CheckIntegrity() public method

public CheckIntegrity ( ) : void
return	void

DoClose() protected method

protected DoClose ( ) : void
return	void

Document() public method

public Document ( int docID, Lucene.Net.Index.StoredFieldVisitor visitor ) : void
docID	int
visitor	Lucene.Net.Index.StoredFieldVisitor
return	void

FilterAtomicReader() public method

Construct a FilterAtomicReader based on the specified base reader.

Note that base reader is closed if this FilterAtomicReader is closed.

public FilterAtomicReader ( AtomicReader @in ) : System.Collections.Generic
@in	AtomicReader
return	System.Collections.Generic

GetBinaryDocValues() public method

public GetBinaryDocValues ( string field ) : Lucene.Net.Index.BinaryDocValues
field	string
return	Lucene.Net.Index.BinaryDocValues

GetDocsWithField() public method

public GetDocsWithField ( string field ) : Bits
field	string
return	Bits

GetNormValues() public method

public GetNormValues ( string field ) : Lucene.Net.Index.NumericDocValues
field	string
return	Lucene.Net.Index.NumericDocValues

GetNumericDocValues() public method

public GetNumericDocValues ( string field ) : Lucene.Net.Index.NumericDocValues
field	string
return	Lucene.Net.Index.NumericDocValues

GetSortedDocValues() public method

public GetSortedDocValues ( string field ) : Lucene.Net.Index.SortedDocValues
field	string
return	Lucene.Net.Index.SortedDocValues

GetSortedSetDocValues() public method

public GetSortedSetDocValues ( string field ) : Lucene.Net.Index.SortedSetDocValues
field	string
return	Lucene.Net.Index.SortedSetDocValues

GetTermVectors() public method

public GetTermVectors ( int docID ) : Fields
docID	int
return	Fields

ToString() public method

public ToString ( ) : string
return	string

Unwrap() public static method

Get the wrapped instance by reader as long as this reader is an intance of FilterAtomicReader.

public static Unwrap ( AtomicReader reader ) : AtomicReader
reader	AtomicReader
return	AtomicReader

Property Details

@in protected property

The underlying AtomicReader.

protected AtomicReader,Lucene.Net.Index @in
return	AtomicReader