Package lumis.portal.bigdata.query

Class HighlightConfig

  • @StableMinor(version="14.2",
             sinceVersion="8.1")
public class HighlightConfig
extends Object
    A search highlight configuration.
    Since:
    8.1.0
    Version:
    $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

    • Constructor Detail

      • HighlightConfig

        public HighlightConfig()

    • Method Detail

      • addHighlightFields

        public HighlightConfig addHighlightFields​(String... highlightFieldIds)
        Adds the given field identifiers as highlighted fields.
        Parameters:
        highlightFieldIds - the field identifiers.
        Returns:
        this highlight configuration.
        Since:
        8.1.0

      • addHighlightFields

        public HighlightConfig addHighlightFields​(Collection<String> highlightFieldIds)
        Adds the given field identifiers as highlighted fields.
        Parameters:
        highlightFieldIds - the field identifiers.
        Returns:
        this highlight configuration.
        Since:
        8.1.0

      • getHighlightFieldIds

        public List<String> getHighlightFieldIds()
        Returns the highlight fields identifiers.
        Returns:
        the highlight fields identifiers.
        Since:
        8.1.0

      • setEndHighlightTag

        public HighlightConfig setEndHighlightTag​(String endHighlightTag)
        Sets the end highlight custom tag.
        Parameters:
        endHighlightTag - the end highlight custom tag.
        Returns:
        this highlight configuration.
        Since:
        8.1.0

      • setStartHighlightTag

        public HighlightConfig setStartHighlightTag​(String startHighlightTag)
        Sets the start highlight custom tag.
        Parameters:
        startHighlightTag - the start highlight custom tag.
        Returns:
        this highlight configuration.
        Since:
        8.1.0

      • getStartHighlightTag

        public String getStartHighlightTag()
        Returns the custom start highlight tag.
        Returns:
        the custom start highlight tag.
        Since:
        8.1.0

      • getEndHighlightTag

        public String getEndHighlightTag()
        Returns the custom end highlight tag.
        Returns:
        the custom end highlight tag.
        Since:
        8.1.0

      • setFragmentSize

        public HighlightConfig setFragmentSize​(Integer fragmentSize)
        Sets the highlight fragment size.
        Parameters:
        fragmentSize - the highlight fragment size.
        Returns:
        this highlight configuration.
        Since:
        8.1.0

      • getFragmentSize

        public Integer getFragmentSize()
        Returns the highlight fragment size.
        Returns:
        the highlight fragment size.
        Since:
        8.1.0

      • setNumberOfFragments

        public HighlightConfig setNumberOfFragments​(Integer numberOfFragments)
        Sets the maximum number of fragments returned by the search.
        Parameters:
        numberOfFragments - the maximum number of fragments returned by the search.
        Returns:
        this highlight configuration.
        Since:
        8.1.0

      • getNumberOfFragments

        public Integer getNumberOfFragments()
        Returns the maximum number of fragments returned by the search.
        Returns:
        the maximum number of fragments returned by the search.
        Since:
        8.1.0