SearchResult.Builder

AI-generated Key Takeaways

• The SearchResult.Builder class is used to construct SearchResult objects.

• A new builder is created by providing the package name and database name.

• You can add joined results and match information to the SearchResult being built.

• The matched document and its ranking signal can be set using the builder.

• The build() method finalizes the construction and returns the SearchResult object.

public static final class SearchResult.Builder extends Object

Builder for SearchResult objects.

Public Constructor Summary

Builder(String packageName, String databaseName) Constructs a new builder for SearchResult objects.

Public Method Summary

SearchResult.Builder	addJoinedResult(SearchResult joinedResult) Adds a SearchResult that was joined by the JoinSpec.
SearchResult.Builder	addMatchInfo(SearchResult.MatchInfo matchInfo) Adds another match to this SearchResult.
SearchResult	build() Constructs a new SearchResult.
SearchResult.Builder	setGenericDocument(GenericDocument document) Sets the document which matched.
SearchResult.Builder	setRankingSignal(double rankingSignal) Sets the ranking signal of the matched document in this SearchResult.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder (String packageName, String databaseName)

Constructs a new builder for SearchResult objects.

Parameters

packageName	the package name the matched document belongs to
databaseName	the database name the matched document belongs to.

Public Methods

public SearchResult.Builder addJoinedResult (SearchResult joinedResult)

Adds a SearchResult that was joined by the JoinSpec.

Parameters

joinedResult	The joined SearchResult to add.

public SearchResult.Builder addMatchInfo (SearchResult.MatchInfo matchInfo)

Adds another match to this SearchResult.

public SearchResult build ()

Constructs a new SearchResult.

public SearchResult.Builder setGenericDocument (GenericDocument document)

Sets the document which matched.

public SearchResult.Builder setRankingSignal (double rankingSignal)

Sets the ranking signal of the matched document in this SearchResult.