Class RequestHighlight
-
- All Implemented Interfaces:
@JsonClass(generateAdapter = true) public final class RequestHighlightRequest that highlight fragments to be added to result set rows The properties reflect SOLR highlighting parameters.
-
-
Field Summary
Fields Modifier and Type Field Description private Stringprefixprivate Stringpostfixprivate IntegersnippetCountprivate IntegerfragmentSizeprivate IntegermaxAnalyzedCharsprivate BooleanmergeContiguousprivate BooleanusePhraseHighlighterprivate List<RequestHighlightFields>fields
-
Constructor Summary
Constructors Constructor Description RequestHighlight(String prefix, String postfix, Integer snippetCount, Integer fragmentSize, Integer maxAnalyzedChars, Boolean mergeContiguous, Boolean usePhraseHighlighter, List<RequestHighlightFields> fields)
-
Method Summary
Modifier and Type Method Description final StringgetPrefix()The string used to mark the start of a highlight in a fragment. final UnitsetPrefix(@Json(name = "prefix") String prefix)The string used to mark the start of a highlight in a fragment. final StringgetPostfix()The string used to mark the end of a highlight in a fragment. final UnitsetPostfix(@Json(name = "postfix") String postfix)The string used to mark the end of a highlight in a fragment. final IntegergetSnippetCount()The maximum number of distinct highlight snippets to return for each highlight field. final UnitsetSnippetCount(@Json(name = "snippetCount") Integer snippetCount)The maximum number of distinct highlight snippets to return for each highlight field. final IntegergetFragmentSize()The character length of each snippet. final UnitsetFragmentSize(@Json(name = "fragmentSize") Integer fragmentSize)The character length of each snippet. final IntegergetMaxAnalyzedChars()The number of characters to be considered for highlighting. final UnitsetMaxAnalyzedChars(@Json(name = "maxAnalyzedChars") Integer maxAnalyzedChars)The number of characters to be considered for highlighting. final BooleangetMergeContiguous()If fragments over lap they can be merged into one larger fragment final UnitsetMergeContiguous(@Json(name = "mergeContiguous") Boolean mergeContiguous)If fragments over lap they can be merged into one larger fragment final BooleangetUsePhraseHighlighter()Should phrases be identified. final UnitsetUsePhraseHighlighter(@Json(name = "usePhraseHighlighter") Boolean usePhraseHighlighter)Should phrases be identified. final List<RequestHighlightFields>getFields()The fields to highlight and field specific configuration properties for each field final UnitsetFields(@Json(name = "fields") List<RequestHighlightFields> fields)The fields to highlight and field specific configuration properties for each field -
-
Method Detail
-
setPrefix
final Unit setPrefix(@Json(name = "prefix") String prefix)
The string used to mark the start of a highlight in a fragment.
-
getPostfix
final String getPostfix()
The string used to mark the end of a highlight in a fragment.
-
setPostfix
final Unit setPostfix(@Json(name = "postfix") String postfix)
The string used to mark the end of a highlight in a fragment.
-
getSnippetCount
final Integer getSnippetCount()
The maximum number of distinct highlight snippets to return for each highlight field.
-
setSnippetCount
final Unit setSnippetCount(@Json(name = "snippetCount") Integer snippetCount)
The maximum number of distinct highlight snippets to return for each highlight field.
-
getFragmentSize
final Integer getFragmentSize()
The character length of each snippet.
-
setFragmentSize
final Unit setFragmentSize(@Json(name = "fragmentSize") Integer fragmentSize)
The character length of each snippet.
-
getMaxAnalyzedChars
final Integer getMaxAnalyzedChars()
The number of characters to be considered for highlighting. Matches after this count will not be shown.
-
setMaxAnalyzedChars
final Unit setMaxAnalyzedChars(@Json(name = "maxAnalyzedChars") Integer maxAnalyzedChars)
The number of characters to be considered for highlighting. Matches after this count will not be shown.
-
getMergeContiguous
final Boolean getMergeContiguous()
If fragments over lap they can be merged into one larger fragment
-
setMergeContiguous
final Unit setMergeContiguous(@Json(name = "mergeContiguous") Boolean mergeContiguous)
If fragments over lap they can be merged into one larger fragment
-
getUsePhraseHighlighter
final Boolean getUsePhraseHighlighter()
Should phrases be identified.
-
setUsePhraseHighlighter
final Unit setUsePhraseHighlighter(@Json(name = "usePhraseHighlighter") Boolean usePhraseHighlighter)
Should phrases be identified.
-
getFields
final List<RequestHighlightFields> getFields()
The fields to highlight and field specific configuration properties for each field
-
setFields
final Unit setFields(@Json(name = "fields") List<RequestHighlightFields> fields)
The fields to highlight and field specific configuration properties for each field
-
-
-
-