Package org.alfresco.search.model

Class RequestHighlight

java.lang.Object
org.alfresco.search.model.RequestHighlight
@Validated public class RequestHighlight extends Object
Request that highlight fragments to be added to result set rows The properties reflect SOLR highlighting parameters.

  • Constructor Details

    • RequestHighlight

      public RequestHighlight()

  • Method Details

    • prefix

      public RequestHighlight prefix(String prefix)

    • getPrefix

      public String getPrefix()
      The string used to mark the start of a highlight in a fragment.
      Returns:
      prefix

    • setPrefix

      public void setPrefix(String prefix)

    • postfix

      public RequestHighlight postfix(String postfix)

    • getPostfix

      public String getPostfix()
      The string used to mark the end of a highlight in a fragment.
      Returns:
      postfix

    • setPostfix

      public void setPostfix(String postfix)

    • snippetCount

      public RequestHighlight snippetCount(Integer snippetCount)

    • getSnippetCount

      public Integer getSnippetCount()
      The maximum number of distinct highlight snippets to return for each highlight field.
      Returns:
      snippetCount

    • setSnippetCount

      public void setSnippetCount(Integer snippetCount)

    • fragmentSize

      public RequestHighlight fragmentSize(Integer fragmentSize)

    • getFragmentSize

      public Integer getFragmentSize()
      The character length of each snippet.
      Returns:
      fragmentSize

    • setFragmentSize

      public void setFragmentSize(Integer fragmentSize)

    • maxAnalyzedChars

      public RequestHighlight maxAnalyzedChars(Integer maxAnalyzedChars)

    • getMaxAnalyzedChars

      public Integer getMaxAnalyzedChars()
      The number of characters to be considered for highlighting. Matches after this count will not be shown.
      Returns:
      maxAnalyzedChars

    • setMaxAnalyzedChars

      public void setMaxAnalyzedChars(Integer maxAnalyzedChars)

    • mergeContiguous

      public RequestHighlight mergeContiguous(Boolean mergeContiguous)

    • isMergeContiguous

      public Boolean isMergeContiguous()
      If fragments over lap they can be merged into one larger fragment
      Returns:
      mergeContiguous

    • setMergeContiguous

      public void setMergeContiguous(Boolean mergeContiguous)

    • usePhraseHighlighter

      public RequestHighlight usePhraseHighlighter(Boolean usePhraseHighlighter)

    • isUsePhraseHighlighter

      public Boolean isUsePhraseHighlighter()
      Should phrases be identified.
      Returns:
      usePhraseHighlighter

    • setUsePhraseHighlighter

      public void setUsePhraseHighlighter(Boolean usePhraseHighlighter)

    • fields

      public RequestHighlight fields(List<RequestHighlightFields> fields)

    • addFieldsItem

      public RequestHighlight addFieldsItem(RequestHighlightFields fieldsItem)

    • getFields

      @Valid public @Valid List<RequestHighlightFields> getFields()
      The fields to highlight and field specific configuration properties for each field
      Returns:
      fields

    • setFields

      public void setFields(List<RequestHighlightFields> fields)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object