Record Class MatchRegionRetriever.DocHighlightData
java.lang.Object
java.lang.Record
org.apache.lucene.search.matchhighlight.MatchRegionRetriever.DocHighlightData
- Enclosing class:
MatchRegionRetriever
private static record MatchRegionRetriever.DocHighlightData(int docId, LeafReader leafReader, int leafDocId, MatchRegionRetriever.FieldValueProvider fieldValueProvider, Map<String,List<OffsetRange>> hits)
extends Record
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The field for thedocId
record component.private final MatchRegionRetriever.FieldValueProvider
The field for thefieldValueProvider
record component.private final Map
<String, List<OffsetRange>> The field for thehits
record component.private final int
The field for theleafDocId
record component.private final LeafReader
The field for theleafReader
record component. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
DocHighlightData
(int docId, LeafReader leafReader, int leafDocId, MatchRegionRetriever.FieldValueProvider fieldValueProvider, Map<String, List<OffsetRange>> hits) Creates an instance of aDocHighlightData
record class. -
Method Summary
Modifier and TypeMethodDescriptionint
docId()
Returns the value of thedocId
record component.final boolean
Indicates whether some other object is "equal to" this one.Returns the value of thefieldValueProvider
record component.final int
hashCode()
Returns a hash code value for this object.hits()
Returns the value of thehits
record component.int
Returns the value of theleafDocId
record component.Returns the value of theleafReader
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
docId
private final int docIdThe field for thedocId
record component. -
leafReader
The field for theleafReader
record component. -
leafDocId
private final int leafDocIdThe field for theleafDocId
record component. -
fieldValueProvider
The field for thefieldValueProvider
record component. -
hits
The field for thehits
record component.
-
-
Constructor Details
-
DocHighlightData
private DocHighlightData(int docId, LeafReader leafReader, int leafDocId, MatchRegionRetriever.FieldValueProvider fieldValueProvider, Map<String, List<OffsetRange>> hits) Creates an instance of aDocHighlightData
record class.- Parameters:
docId
- the value for thedocId
record componentleafReader
- the value for theleafReader
record componentleafDocId
- the value for theleafDocId
record componentfieldValueProvider
- the value for thefieldValueProvider
record componenthits
- the value for thehits
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. Reference components are compared withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
docId
public int docId()Returns the value of thedocId
record component.- Returns:
- the value of the
docId
record component
-
leafReader
Returns the value of theleafReader
record component.- Returns:
- the value of the
leafReader
record component
-
leafDocId
public int leafDocId()Returns the value of theleafDocId
record component.- Returns:
- the value of the
leafDocId
record component
-
fieldValueProvider
Returns the value of thefieldValueProvider
record component.- Returns:
- the value of the
fieldValueProvider
record component
-
hits
Returns the value of thehits
record component.- Returns:
- the value of the
hits
record component
-