com.groupdocs.parser.options

Class SearchOptions

java.lang.Object

com.groupdocs.parser.options.SearchOptions

public class SearchOptions
extends Object

Provides the options which are used for text search.

An instance of SearchOptions class is used as parameter in Parser.search(String, SearchOptions) method. See the usage examples there.

Learn more:

• Search text
• Search text in Microsoft Office Word documents
• Search text in Microsoft Office Excel spreadsheets
• Search text in Microsoft Office PowerPoint presentations
• Search text in PDF documents
• Search text in Emails
• Search text in EPUB eBooks
• Search text in HTML documents
• Search text in Microsoft OneNote sections

Constructor Summary

Constructors

Constructor and Description
SearchOptions() Initializes a new instance of the SearchOptions class with default values.
SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression) Initializes a new instance of the SearchOptions class which is used to search without highlight extraction.
SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages) Initializes a new instance of the SearchOptions class which is used to search by pages and without highlight extraction.
SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions) Initializes a new instance of the SearchOptions class.
SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions highlightOptions) Initializes a new instance of the SearchOptions class which is used to search with the same highlight options for the left and the right highlight extraction.
SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions) Initializes a new instance of the SearchOptions class which is used to search with the highlight options for the left and the right highlight extraction.
SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, int maxPageIndex, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions) Initializes a new instance of the SearchOptions class.

Method Summary

Modifier and Type	Method and Description
HighlightOptions	getLeftHighlightOptions() Gets the options for the left highlight.
int	getMaxPageIndex() Gets the value that represents the max index of the page to search.
HighlightOptions	getRightHighlightOptions() Gets the options for the right highlight.
boolean	isMatchCase() Gets the value that indicates whether a text case isn't ignored.
boolean	isMatchWholeWord() Gets the value that indicates whether text search is limited by a whole word.
boolean	isSearchByPages() Gets the value that indicates whether the search is performed by pages.
boolean	isUseRegularExpression() Gets the value that indicates whether a regular expression is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOptions

public SearchOptions(boolean matchCase,
                     boolean matchWholeWord,
                     boolean useRegularExpression,
                     boolean searchByPages,
                     HighlightOptions leftHighlightOptions,
                     HighlightOptions rightHighlightOptions)

Initializes a new instance of the SearchOptions class.

Parameters:

matchCase - The value that indicates whether a text case isn't ignored.

matchWholeWord - The value that indicates whether text search is limited by a whole word.

useRegularExpression - The value that indicates whether a regular expression is used.

searchByPages - The value that indicates whether the search is performed by pages.

leftHighlightOptions - The options for the left highlight.

rightHighlightOptions - The options for the right highlight.

SearchOptions

public SearchOptions(boolean matchCase,
                     boolean matchWholeWord,
                     boolean useRegularExpression,
                     int maxPageIndex,
                     HighlightOptions leftHighlightOptions,
                     HighlightOptions rightHighlightOptions)

Initializes a new instance of the SearchOptions class.

Parameters:

matchCase - The value that indicates whether a text case isn't ignored.

matchWholeWord - The value that indicates whether text search is limited by a whole word.

useRegularExpression - The value that indicates whether a regular expression is used.

maxPageIndex - The value that represents the max index of the page to search

leftHighlightOptions - The options for the left highlight.

rightHighlightOptions - The options for the right highlight.

SearchOptions

public SearchOptions(boolean matchCase,
                     boolean matchWholeWord,
                     boolean useRegularExpression,
                     HighlightOptions leftHighlightOptions,
                     HighlightOptions rightHighlightOptions)

Initializes a new instance of the SearchOptions class which is used to search with the highlight options for the left and the right highlight extraction.

Parameters:

matchCase - The value that indicates whether a text case isn't ignored.

matchWholeWord - The value that indicates whether text search is limited by a whole word.

useRegularExpression - The value that indicates whether a regular expression is used.

leftHighlightOptions - The options for the left highlight.

rightHighlightOptions - The options for the right highlight.

SearchOptions

public SearchOptions(boolean matchCase,
                     boolean matchWholeWord,
                     boolean useRegularExpression,
                     HighlightOptions highlightOptions)

Initializes a new instance of the SearchOptions class which is used to search with the same highlight options for the left and the right highlight extraction.

Parameters:

matchCase - The value that indicates whether a text case isn't ignored.

matchWholeWord - The value that indicates whether text search is limited by a whole word.

useRegularExpression - The value that indicates whether a regular expression is used.

highlightOptions - The options for both highlights.

SearchOptions

public SearchOptions(boolean matchCase,
                     boolean matchWholeWord,
                     boolean useRegularExpression)

Initializes a new instance of the SearchOptions class which is used to search without highlight extraction.

Parameters:

matchCase - The value that indicates whether a text case isn't ignored.

matchWholeWord - The value that indicates whether text search is limited by a whole word.

useRegularExpression - The value that indicates whether a regular expression is used.

SearchOptions

public SearchOptions(boolean matchCase,
                     boolean matchWholeWord,
                     boolean useRegularExpression,
                     boolean searchByPages)

Initializes a new instance of the SearchOptions class which is used to search by pages and without highlight extraction.

Parameters:

matchCase - The value that indicates whether a text case isn't ignored.

matchWholeWord - The value that indicates whether text search is limited by a whole word.

useRegularExpression - The value that indicates whether a regular expression is used.

searchByPages - The value that indicates whether the search is performed by pages.

SearchOptions

public SearchOptions()

Initializes a new instance of the SearchOptions class with default values. See remarks for details.

The following properties have default values:

• MatchCase: false
• MatchWholeWord: false
• UseRegularExpression: false
• LeftHighlightOptions: null
• RightHighlightOptions: null

Method Detail

isMatchCase

public boolean isMatchCase()

Gets the value that indicates whether a text case isn't ignored.

Returns:

true if a text case isn't ignored; otherwise, false.

isMatchWholeWord

public boolean isMatchWholeWord()

Gets the value that indicates whether text search is limited by a whole word.

Returns:

true if text search is limited by a whole word; otherwise, false.

isUseRegularExpression

public boolean isUseRegularExpression()

Gets the value that indicates whether a regular expression is used.

Returns:

true if a regular expression is used; otherwise, false.

isSearchByPages

public boolean isSearchByPages()

Gets the value that indicates whether the search is performed by pages.

Returns:

true if the search is performed by pages; otherwise, false and the search is performed on the whole document without including SearchResult.getPageIndex() property value in SearchResult class.

getLeftHighlightOptions

public HighlightOptions getLeftHighlightOptions()

Gets the options for the left highlight.

Returns:

An instance of HighlightOptions class; nill if it isn't set.

getRightHighlightOptions

public HighlightOptions getRightHighlightOptions()

Gets the options for the right highlight.

Returns:

An instance of HighlightOptions class; nill if it isn't set.

getMaxPageIndex

public int getMaxPageIndex()

Gets the value that represents the max index of the page to search.

Returns:

An integer value that represents the max index of the page to search; -1 if not set;