SearchResult.MatchInfo.Builder

Page Summary

• SearchResult.MatchInfo.Builder is used to construct SearchResult.MatchInfo objects.

• You can create a new Builder by specifying the property path where a match was found.

• The Builder allows you to set the exact match range, snippet range, and submatch range using SearchResult.MatchRange objects.

• Finally, the build() method constructs the SearchResult.MatchInfo object.

public static final class SearchResult.MatchInfo.Builder extends Object

Builder for SearchResult.MatchInfo objects.

Public Constructor Summary

Builder(String propertyPath) Creates a new SearchResult.MatchInfo.Builder reporting a match with the given property path.

Public Method Summary

SearchResult.MatchInfo	build() Constructs a new SearchResult.MatchInfo.
SearchResult.MatchInfo.Builder	setExactMatchRange(SearchResult.MatchRange matchRange) Sets the exact SearchResult.MatchRange corresponding to the given entry.
SearchResult.MatchInfo.Builder	setSnippetRange(SearchResult.MatchRange matchRange) Sets the snippet SearchResult.MatchRange corresponding to the given entry.
SearchResult.MatchInfo.Builder	setSubmatchRange(SearchResult.MatchRange matchRange) Sets the start and end of a submatch SearchResult.MatchRange corresponding to the given entry.

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 propertyPath)

Creates a new SearchResult.MatchInfo.Builder reporting a match with the given property path.

A property path is a dot-delimited sequence of property names indicating which property in the document these snippets correspond to.

Example properties: 'body', 'sender.name', 'sender.emailaddress', etc. For class example 1, this returns "subject".

Parameters

propertyPath	A dot-delimited sequence of property names indicating which property in the document these snippets correspond to.

Public Methods

public SearchResult.MatchInfo build ()

Constructs a new SearchResult.MatchInfo.

public SearchResult.MatchInfo.Builder setExactMatchRange (SearchResult.MatchRange matchRange)

Sets the exact SearchResult.MatchRange corresponding to the given entry.

public SearchResult.MatchInfo.Builder setSnippetRange (SearchResult.MatchRange matchRange)

Sets the snippet SearchResult.MatchRange corresponding to the given entry.

public SearchResult.MatchInfo.Builder setSubmatchRange (SearchResult.MatchRange matchRange)

Sets the start and end of a submatch SearchResult.MatchRange corresponding to the given entry.