com.groupdocs.parser.options

Class HighlightOptions

    • Constructor Detail

      • HighlightOptions

        public HighlightOptions(int maxLength)
        Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.
        Parameters:
        maxLength - The maximum text length.
      • HighlightOptions

        public HighlightOptions(Integer maxLength,
                        boolean isLineLimited)
        Initializes a new instance of the HighlightOptions class which is used to extract a line-limited highlight.
        Parameters:
        maxLength - The maximum text length.
        isLineLimited - The value that indicates whether the highlight extraction is limited by the start (or the end) of a text line.
      • HighlightOptions

        public HighlightOptions(Integer maxLength,
                        int wordCount)
        Initializes a new instance of the HighlightOptions class which is used to extract a highlight with the fixed word count.
        Parameters:
        maxLength - The maximum text length.
        wordCount - The maximum word count.
      • HighlightOptions

        public HighlightOptions(Integer maxLength,
                        Integer wordCount,
                        boolean isLineLimited)
        Initializes a new instance of the HighlightOptions class.
        Parameters:
        maxLength - The maximum text length.
        wordCount - The maximum word count.
        isLineLimited - The value that indicates whether the highlight extraction is limited by the start (or the end) of a text line.
    • Method Detail

      • getMaxLength

        public Integer getMaxLength()
        Gets a maximum text length.
        Returns:
        A positive integer value that represents the maximum text length; null if the text length isn't limited.
      • getWordCount

        public Integer getWordCount()
        Gets a maximum word count.
        Returns:
        A positive integer value that represents the maximum word count; null if the word count isn't limited.
      • isLineLimited

        public boolean isLineLimited()
        Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
        Returns:
        true if highlight extraction is limited by the start (or the end) of a text line; otherwise, false.