Module org.apache.lucene.facet
Package org.apache.lucene.facet
Record Class FacetsCollectorManager.FacetsResult
java.lang.Object
java.lang.Record
org.apache.lucene.facet.FacetsCollectorManager.FacetsResult
- Record Components:
topDocs
- the top docsfacetsCollector
- the facets result included in aFacetsCollector
instance
- Enclosing class:
FacetsCollectorManager
public static record FacetsCollectorManager.FacetsResult(TopDocs topDocs, FacetsCollector facetsCollector)
extends Record
Holds results of a search run via static utility methods exposed by this class. Those include
TopDocs
as well as facets result included in the returned FacetsCollector
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FacetsCollector
The field for thefacetsCollector
record component.private final TopDocs
The field for thetopDocs
record component. -
Constructor Summary
ConstructorsConstructorDescriptionFacetsResult
(TopDocs topDocs, FacetsCollector facetsCollector) Creates an instance of aFacetsResult
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.Returns the value of thefacetsCollector
record component.final int
hashCode()
Returns a hash code value for this object.topDocs()
Returns the value of thetopDocs
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
topDocs
The field for thetopDocs
record component. -
facetsCollector
The field for thefacetsCollector
record component.
-
-
Constructor Details
-
FacetsResult
Creates an instance of aFacetsResult
record class.- Parameters:
topDocs
- the value for thetopDocs
record componentfacetsCollector
- the value for thefacetsCollector
record component
-
-
Method Details
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
topDocs
Returns the value of thetopDocs
record component.- Returns:
- the value of the
topDocs
record component
-
facetsCollector
Returns the value of thefacetsCollector
record component.- Returns:
- the value of the
facetsCollector
record component
-