Package ch.rswk.meta.engine

Record Class LuceneService.SearchResult

java.lang.Object

java.lang.Record

ch.rswk.meta.engine.LuceneService.SearchResult

Enclosing class:

LuceneService

public static record LuceneService.SearchResult(String cursor, List<org.apache.lucene.document.Document> docs, long totalHits)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
private final String	cursor	The field for the cursor record component.
private final List<org.apache.lucene.document.Document>	docs	The field for the docs record component.
private final long	totalHits	The field for the totalHits record component.

Constructor Summary

Constructors

Constructor	Description
SearchResult(String cursor, List<org.apache.lucene.document.Document> docs, long totalHits)	Creates an instance of a SearchResult record class.

Method Summary

Modifier and Type	Method	Description
String	cursor()	Returns the value of the cursor record component.
List<org.apache.lucene.document.Document>	docs()	Returns the value of the docs 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.
final String	toString()	Returns a string representation of this record class.
long	totalHits()	Returns the value of the totalHits record component.

Methods inherited from class java.lang.Object

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

Field Details

cursor

private final String cursor

The field for the cursor record component.

docs

private final List<org.apache.lucene.document.Document> docs

The field for the docs record component.

totalHits

private final long totalHits

The field for the totalHits record component.

Constructor Details

SearchResult

public SearchResult(String cursor,
 List<org.apache.lucene.document.Document> docs,
 long totalHits)

Creates an instance of a SearchResult record class.

Parameters:

cursor - the value for the cursor record component

docs - the value for the docs record component

totalHits - the value for the totalHits 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.

cursor

public String cursor()

Returns the value of the cursor record component.

Returns:

the value of the cursor record component

docs

public List<org.apache.lucene.document.Document> docs()

Returns the value of the docs record component.

Returns:

the value of the docs record component

totalHits

public long totalHits()

Returns the value of the totalHits record component.

Returns:

the value of the totalHits record component