Class ToParentBlockJoinFieldComparer

A field comparer that allows parent documents to be sorted by fields from the nested / child documents.

Note

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

Inheritance
object
FieldComparer
FieldComparer<object>
ToParentBlockJoinFieldComparer
ToParentBlockJoinFieldComparer.Highest
ToParentBlockJoinFieldComparer.Lowest
Inherited Members
FieldComparer<object>.SetTopValue<TValue>(TValue)
FieldComparer<object>.CompareValues(object, object)
FieldComparer.SetScorer(Scorer)
Namespace: Lucene.Net.Search.Join
Assembly: Lucene.Net.Join.dll
Syntax
public abstract class ToParentBlockJoinFieldComparer : FieldComparer<object>

Properties

this[int]

Return the actual value in the slot. LUCENENET NOTE: This was value(int) in Lucene.

Declaration
public override object this[int slot] { get; }
Parameters
Type Name Description
int slot

The value
Property Value
Type Description
object

Value in this slot
Overrides

Methods

Compare(int, int)

Compare hit at slot1 with hit at slot2.

Declaration
public override int Compare(int slot1, int slot2)
Parameters
Type Name Description
int slot1

first slot to compare
int slot2

second slot to compare
Returns
Type Description
int

any N < 0 if slot2's value is sorted after slot1, any N > 0 if the slot2's value is sorted before slot1 and 0 if they are equal
Overrides

SetBottom(int)

Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When CompareBottom(int) is called, you should compare against this slot. This will always be called before CompareBottom(int).

Declaration
public override void SetBottom(int slot)
Parameters
Type Name Description
int slot

the currently weakest (sorted last) slot in the queue
Overrides

SetNextReader(AtomicReaderContext)

Set a new Lucene.Net.Index.AtomicReaderContext. All subsequent docIDs are relative to the current reader (you must add docBase if you need to map it to a top-level docID).

Declaration
public override FieldComparer SetNextReader(AtomicReaderContext context)
Parameters
Type Name Description
AtomicReaderContext context

Current reader context
Returns
Type Description
FieldComparer

The comparer to use for this segment; most comparers can just return "this" to reuse the same comparer across segments
Overrides
Lucene.Net.Search.FieldComparer<object>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)
Exceptions
Type Condition
IOException

If there is a low-level IO error

SetTopValue(object)

Record the top value, for future calls to CompareTop(int). This is only called for searches that use SearchAfter (deep paging), and is called before any calls to Lucene.Net.Search.FieldComparer<T>.SetNextReader(Lucene.Net.Index.AtomicReaderContext).

Declaration
public override void SetTopValue(object value)
Parameters
Type Name Description
object value
Overrides