Package org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationHighlighting

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAlternateHighlightField()
      Returns the index field whose content should be used if no highlighting snippet is available.
      java.lang.String getFormatter()
      Returns the formatter that should be used for highlighting.
      java.lang.String getFragmenter()
      Returns the fragmenter that should be used for highlighting.
      java.lang.Integer getFragSize()
      Returns the maximal size a highlighted snippet should have.
      java.lang.String getHightlightField()
      Returns the index field that should be used for highlighting.
      java.lang.Integer getMaxAlternateHighlightFieldLength()
      Returns the maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found.
      java.lang.String getSimplePost()
      Returns the String that should be inserted directly after the term that should be highlighted.
      java.lang.String getSimplePre()
      Returns the String that should be inserted directly in front of the term that should be highlighted.
      java.lang.Integer getSnippetsCount()
      Returns the number of highlighted snippets that should be returned.
      java.lang.Boolean getUseFastVectorHighlighting()
      Returns the flag, that indicates if fast vector highlighting should be used.

    • Method Detail

      • getAlternateHighlightField

        java.lang.String getAlternateHighlightField()
        Returns the index field whose content should be used if no highlighting snippet is available.
        Returns:
        The index field whose content should be used if no highlighting snippet is available. (Solr: hl.alternateField)

      • getFormatter

        java.lang.String getFormatter()
        Returns the formatter that should be used for highlighting.
        Returns:
        The formatter that should be used for highlighting. (Solr: hl.formatter)

      • getFragmenter

        java.lang.String getFragmenter()
        Returns the fragmenter that should be used for highlighting.
        Returns:
        The fragmenter that should be used for highlighting. (Solr: hl.fragmenter)

      • getFragSize

        java.lang.Integer getFragSize()
        Returns the maximal size a highlighted snippet should have.
        Returns:
        The maximal size a highlighted snippet should have. (Solr: hl.fragsize)

      • getHightlightField

        java.lang.String getHightlightField()
        Returns the index field that should be used for highlighting.
        Returns:
        The index field that should be used for highlighting.

      • getMaxAlternateHighlightFieldLength

        java.lang.Integer getMaxAlternateHighlightFieldLength()
        Returns the maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found.
        Returns:
        The maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found. (Solr: hl.maxAlternateFieldLength)

      • getSimplePost

        java.lang.String getSimplePost()
        Returns the String that should be inserted directly after the term that should be highlighted.
        Returns:
        The String that should be inserted directly after the term that should be highlighted. (Solr: hl.simple.post)

      • getSimplePre

        java.lang.String getSimplePre()
        Returns the String that should be inserted directly in front of the term that should be highlighted.
        Returns:
        The String that should be inserted directly in front the term that should be highlighted. (Solr: hl.simple.pre)

      • getSnippetsCount

        java.lang.Integer getSnippetsCount()
        Returns the number of highlighted snippets that should be returned.
        Returns:
        The number of highlighted snippets that should be returned. (Solr: hl.snippets)

      • getUseFastVectorHighlighting

        java.lang.Boolean getUseFastVectorHighlighting()
        Returns the flag, that indicates if fast vector highlighting should be used.
        Returns:
        The flag, that indicates if fast vector highlighting should be used. (Solr: hl.useFastVectorHighlighting)