SearchResult.MatchInfo.Builder

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

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.