com.groupdocs.parser.options

Class HighlightOptions

java.lang.Object

com.groupdocs.parser.options.HighlightOptions

public class HighlightOptions
extends Object

Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios).

An instance of HighlightOptions class is used as parameter in Parser.getHighlight(int, boolean, HighlightOptions) method. See the usage examples there.

Learn more:

• Extract highlights

Constructor Summary

Constructors

Constructor and Description
HighlightOptions() Initializes a new instance of the HighlightOptions class with no limits set.
HighlightOptions(int maxLength) Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.
HighlightOptions(Integer maxLength, boolean isLineLimited) Initializes a new instance of the HighlightOptions class which is used to extract a line-limited highlight.
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.
HighlightOptions(Integer maxLength, Integer wordCount, boolean isLineLimited) Initializes a new instance of the HighlightOptions class.

Method Summary

Modifier and Type	Method and Description
Integer	getMaxLength() Gets a maximum text length.
Integer	getWordCount() Gets a maximum word count.
boolean	isLineLimited() Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
void	setLineLimited(boolean lineLimited) Sets the value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
void	setMaxLength(Integer maxLength) Sets a maximum text length.
void	setWordCount(Integer wordCount) Sets a maximum word count.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HighlightOptions

public HighlightOptions()

Initializes a new instance of the HighlightOptions class with no limits set. Set at least one of setMaxLength(Integer), setWordCount(Integer), setLineLimited(boolean) before passing to the parser.

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.

setMaxLength

public void setMaxLength(Integer maxLength)

Sets a maximum text length.

Parameters:

maxLength - A non-negative integer; null to remove the length limit.

setWordCount

public void setWordCount(Integer wordCount)

Sets a maximum word count.

Parameters:

wordCount - A non-negative integer; null to remove the word-count limit.

setLineLimited

public void setLineLimited(boolean lineLimited)

Sets the value that indicates whether highlight extraction is limited by the start (or the end) of a text line.

Parameters:

lineLimited - true to limit by line bounds.