Class DocTermOrdsRangeFilter

A range filter built on top of a cached multi-valued term field (in IFieldCache).

Like FieldCacheRangeFilter, this is just a specialized range query versus using a TermRangeQuery with DocTermOrdsRewriteMethod: it will only do two ordinal to term lookups.

Inheritance

object

Filter

DocTermOrdsRangeFilter

Inherited Members

Filter.NewAnonymous(Func<AtomicReaderContext, IBits, DocIdSet>)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Search

Assembly: Lucene.Net.dll

Syntax

public abstract class DocTermOrdsRangeFilter : Filter

Properties

Field

Returns the field name for this filter

Declaration

public virtual string Field { get; }

Property Value

Type	Description
string

IncludesLower

Returns true if the lower endpoint is inclusive

Declaration

public virtual bool IncludesLower { get; }

Property Value

Type	Description
bool

IncludesUpper

Returns true if the upper endpoint is inclusive

Declaration

public virtual bool IncludesUpper { get; }

Property Value

Type	Description
bool

LowerVal

Returns the lower value of this range filter

Declaration

public virtual BytesRef LowerVal { get; }

Property Value

Type	Description
BytesRef

UpperVal

Returns the upper value of this range filter

Declaration

public virtual BytesRef UpperVal { get; }

Property Value

Type	Description
BytesRef

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override sealed bool Equals(object o)

Parameters

Type	Name	Description
object	o

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetDocIdSet(AtomicReaderContext, IBits)

This method is implemented for each data type

Declaration

public override abstract DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)

Parameters

Type	Name	Description
AtomicReaderContext	context
IBits	acceptDocs

Returns

Type	Description
DocIdSet

Overrides

Filter.GetDocIdSet(AtomicReaderContext, IBits)

GetHashCode()

Serves as the default hash function.

Declaration

public override sealed int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

NewBytesRefRange(string, BytesRef, BytesRef, bool, bool)

Creates a BytesRef range filter using GetTermsIndex(AtomicReader, string, float). This works with all fields containing zero or one term in the field. The range can be half-open by setting one of the values to null.

Declaration

public static DocTermOrdsRangeFilter NewBytesRefRange(string field, BytesRef lowerVal, BytesRef upperVal, bool includeLower, bool includeUpper)

Parameters

Type	Name	Description
string	field
BytesRef	lowerVal
BytesRef	upperVal
bool	includeLower
bool	includeUpper

Returns

Type	Description
DocTermOrdsRangeFilter

ToString()

Returns a string that represents the current object.

Declaration

public override sealed string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()