FieldComparatorSource (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.search, class: FieldComparatorSource

Package org.apache.lucene.search

# Class FieldComparatorSource

java.lang.Object
org.apache.lucene.search.FieldComparatorSource

public abstract class FieldComparatorSource extends Object
Provides a `FieldComparator` for custom field sorting.

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

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `FieldComparatorSource()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `abstract FieldComparator<?>`
  `newComparator(String fieldname, int numHits, Pruning pruning, boolean reversed)`
  Creates a comparator for the field in the given index.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### FieldComparatorSource

    public FieldComparatorSource()

- ## Method Details

  - ### newComparator

    public abstract FieldComparator<?> newComparator(String fieldname, int numHits, Pruning pruning, boolean reversed)
    Creates a comparator for the field in the given index.
    Parameters:
      `fieldname` - Name of the field to create comparator for.
    Returns:
      FieldComparator.