Module org.apache.lucene.facet

Package org.apache.lucene.facet.taxonomy

Record Class TaxonomyFacets.TopChildrenForPath

java.lang.Object

java.lang.Record

org.apache.lucene.facet.taxonomy.TaxonomyFacets.TopChildrenForPath

Enclosing class:

TaxonomyFacets

static record TaxonomyFacets.TopChildrenForPath(Number pathValue, int childCount, TopOrdAndNumberQueue childQueue)
extends Record

Intermediate result to store top children for a given path before resolving labels, etc.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	childCount	The field for the childCount record component.
private final TopOrdAndNumberQueue	childQueue	The field for the childQueue record component.
private final Number	pathValue	The field for the pathValue record component.

Constructor Summary

Constructors

Constructor	Description
TopChildrenForPath(Number pathValue, int childCount, TopOrdAndNumberQueue childQueue)	Creates an instance of a TopChildrenForPath record class.

Method Summary

Modifier and Type	Method	Description
int	childCount()	Returns the value of the childCount record component.
TopOrdAndNumberQueue	childQueue()	Returns the value of the childQueue record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Number	pathValue()	Returns the value of the pathValue record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

pathValue

private final Number pathValue

The field for the pathValue record component.

childCount

private final int childCount

The field for the childCount record component.

childQueue

private final TopOrdAndNumberQueue childQueue

The field for the childQueue record component.

Constructor Details

TopChildrenForPath

TopChildrenForPath(Number pathValue,
 int childCount,
 TopOrdAndNumberQueue childQueue)

Creates an instance of a TopChildrenForPath record class.

Parameters:

pathValue - the value for the pathValue record component

childCount - the value for the childCount record component

childQueue - the value for the childQueue record component

Method Details

toString

public final String 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.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

pathValue

public Number pathValue()

Returns the value of the pathValue record component.

Returns:

the value of the pathValue record component

childCount

public int childCount()

Returns the value of the childCount record component.

Returns:

the value of the childCount record component

childQueue

public TopOrdAndNumberQueue childQueue()

Returns the value of the childQueue record component.

Returns:

the value of the childQueue record component