Class FilterAtomicReader.FilterTerms
Base class for filtering Terms implementations.
NOTE: If the order of terms and documents is not changed, and if these terms are going to be intersected with automata, you could consider overriding Intersect(CompiledAutomaton, BytesRef) for better performance.Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class FilterAtomicReader.FilterTerms : TermsConstructors
FilterTerms(Terms)
Creates a new FilterAtomicReader.FilterTerms
Declaration
public FilterTerms(Terms input)Parameters
| Type | Name | Description |
|---|---|---|
| Terms | input | the underlying Terms instance. |
Fields
m_input
The underlying Terms instance.
Declaration
protected readonly Terms m_inputField Value
| Type | Description |
|---|---|
| Terms |
Properties
Comparer
Return the IComparer{BytesRef} used to sort terms
provided by the iterator. This method may return null
if there are no terms. This method may be invoked
many times; it's best to cache a single instance &
reuse it.
Declaration
public override IComparer<BytesRef> Comparer { get; }Property Value
| Type | Description |
|---|---|
| IComparer<BytesRef> |
Overrides
Count
Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account. NOTE: This was size() in Lucene.
Declaration
public override long Count { get; }Property Value
| Type | Description |
|---|---|
| long |
Overrides
DocCount
Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.
Declaration
public override int DocCount { get; }Property Value
| Type | Description |
|---|---|
| int |
Overrides
HasFreqs
Returns true if documents in this field store per-document term frequency (Freq).
Declaration
public override bool HasFreqs { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
HasOffsets
Returns true if documents in this field store offsets.
Declaration
public override bool HasOffsets { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
HasPayloads
Returns true if documents in this field store payloads.
Declaration
public override bool HasPayloads { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
HasPositions
Returns true if documents in this field store positions.
Declaration
public override bool HasPositions { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
SumDocFreq
Returns the sum of DocFreq for all terms in this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.
Declaration
public override long SumDocFreq { get; }Property Value
| Type | Description |
|---|---|
| long |
Overrides
SumTotalTermFreq
Returns the sum of TotalTermFreq for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions). Note that, just like other term measures, this measure does not take deleted documents into account.
Declaration
public override long SumTotalTermFreq { get; }Property Value
| Type | Description |
|---|---|
| long |
Overrides
Methods
GetEnumerator()
Returns an iterator that will step through all
terms. This method will not return null.
Declaration
public override TermsEnum GetEnumerator()Returns
| Type | Description |
|---|---|
| TermsEnum |
Overrides
GetEnumerator(TermsEnum)
Returns an iterator that will step through all
terms. This method will not return null.
Declaration
public override TermsEnum GetEnumerator(TermsEnum reuse)Parameters
| Type | Name | Description |
|---|---|---|
| TermsEnum | reuse | If you have a previous TermsEnum, for example from a different field, you can pass it for possible reuse if the implementation can do so. |
Returns
| Type | Description |
|---|---|
| TermsEnum |