Class Terms

Access to the terms in a specific field. See Fields.

Note

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

Inheritance

object

Terms

BlockTreeTermsReader<TSubclassState>.FieldReader

FilterAtomicReader.FilterTerms

MultiTerms

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public abstract class Terms

Constructors

Terms()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration

protected Terms()

Fields

EMPTY_ARRAY

Zero-length array of Terms.

Declaration

public static readonly Terms[] EMPTY_ARRAY

Field 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 abstract IComparer<BytesRef> Comparer { get; }

Property Value

Type	Description
IComparer<BytesRef>

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 abstract long Count { get; }

Property Value

Type	Description
long

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 abstract int DocCount { get; }

Property Value

Type	Description
int

HasFreqs

Returns true if documents in this field store per-document term frequency (Freq).

Declaration

public abstract bool HasFreqs { get; }

Property Value

Type	Description
bool

HasOffsets

Returns true if documents in this field store offsets.

Declaration

public abstract bool HasOffsets { get; }

Property Value

Type	Description
bool

HasPayloads

Returns true if documents in this field store payloads.

Declaration

public abstract bool HasPayloads { get; }

Property Value

Type	Description
bool

HasPositions

Returns true if documents in this field store positions.

Declaration

public abstract bool HasPositions { get; }

Property Value

Type	Description
bool

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 abstract long SumDocFreq { get; }

Property Value

Type	Description
long

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 abstract long SumTotalTermFreq { get; }

Property Value

Type	Description
long

Methods

GetEnumerator()

Returns an iterator that will step through all terms. This method will not return null.

Declaration

public abstract TermsEnum GetEnumerator()

Returns

Type	Description
TermsEnum

GetEnumerator(TermsEnum)

Returns an iterator that will step through all terms. This method will not return null.

Declaration

public virtual 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

Intersect(CompiledAutomaton, BytesRef)

Returns a TermsEnum that iterates over all terms that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only accept terms

startTerm, but you still must call MoveNext() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

NOTE: the returned TermsEnum cannot seek

.

Declaration

public virtual TermsEnum Intersect(CompiledAutomaton compiled, BytesRef startTerm)

Parameters

Type	Name	Description
CompiledAutomaton	compiled
BytesRef	startTerm

Returns

Type	Description
TermsEnum