Search text Leave feedback
GroupDocs.Parser provides the functionality to search a text from documents by the search(String) and search(String, SearchOptions) methods:
Iterable<SearchResult> search(String keyword);
Iterable<SearchResult> search(String keyword, SearchOptions options);
The keyword parameter can contain a text or a regular expression. SearchResult class contains every occurrence of the keyword in the document text. This class has the following members:
| Member | Description |
|---|---|
| getPosition | A zero-based index of the start position of the search result. Depending on isSearchByPages property value this index starts from the document start or the document page start. |
| getPageIndex | The page index where the text is found. |
| getText | The found text. |
| getLeftHighlightItem | The left highlight. |
| getRightHighlightItem | The right highlight. |
Here are the steps to search a keyword in the document:
- Instantiate Parser object for the initial document;
- Call search(String) method and obtain collection of SearchResult objects;
- Check if collection isn’t null (search is supported for the document);
- Iterate through the collection and get position and text.
The following example shows how to find a keyword in a document:
// Create an instance of Parser class
try (Parser parser = new Parser(Constants.SamplePdf)) {
// Search a keyword:
Iterable<SearchResult> sr = parser.search("lorem");
// Check if search is supported
if (sr == null) {
System.out.println("Search isn't supported");
return;
}
// Iterate over search results
for (SearchResult s : sr) {
// Print an index and found text:
System.out.println(String.format("At %d: %s", s.getPosition(), s.getText()));
}
}
SearchOptions parameter is used to customize a search. This class has the following members:
| Member | Description |
|---|---|
| isMatchCase | The value that indicates whether a text case isn’t ignored. |
| isMatchWholeWord | The value that indicates whether text search is limited by the whole word. |
| isUseRegularExpression | The value that indicates whether a regular expression is used. |
| isSearchByPages | The value that indicates whether the search is performed by pages. |
| getLeftHighlightOptions | The options for the left highlight. |
| getRightHighlightOptions | The options for the right highlight. |
Here are the steps to search with a regular expression in the document:
- Instantiate Parser object for the initial document;
- Instantiate SearchOptions object with the parameters for the search;
- Call search(String, SearchOptions) method and obtain collection of SearchResult objects;
- Check if collection isn’t null (search is supported for the document);
- Iterate through the collection and get position and text.
The following example shows how to search with a regular expression in a document:
// Create an instance of Parser class
try (Parser parser = new Parser(Constants.SamplePdf)) {
// Search with a regular expression with case matching
Iterable<SearchResult> sr = parser.search("[0-9]+", new SearchOptions(true, false, true));
// Check if search is supported
if (sr == null) {
System.out.println("Search isn't supported");
return;
}
// Iterate over search results
for (SearchResult s : sr) {
// Print an index and found text:
System.out.println(String.format("At %d: %s", s.getPosition(), s.getText()));
}
}
Here are the steps to search a text with a highlights:
- Instantiate Parser object for the initial document;
- Instantiate HighlightOptions object with the parameters for the highlight extraction;
- Instantiate SearchOptions object with the parameters for the search;
- Call search(String, SearchOptions) method and obtain collection of SearchResult objects;
- Check if collection isn’t null (search is supported for the document);
- Iterate through the collection and get position and text.
The following example shows how to search a text with the highlights:
// Create an instance of Parser class
try (Parser parser = new Parser(Constants.SamplePdf)) {
HighlightOptions highlightOptions = new HighlightOptions(15);
// Search a keyword:
Iterable<SearchResult> sr = parser.search("lorem", new SearchOptions(true, false, false, highlightOptions));
// Check if search is supported
if (sr == null) {
System.out.println("Search isn't supported");
return;
}
// Iterate over search results
for (SearchResult s : sr) {
// Print the found text and highlights:
System.out.println(String.format("%s%s%s", s.getLeftHighlightItem().getText(), s.getText(), s.getRightHighlightItem().getText()));
}
}
Here are the steps to search a text with page numbers:
- Instantiate Parser object for the initial document;
- Instantiate SearchOptions object with the parameters for the search;
- Call search(String, SearchOptions) method and obtain collection of SearchResult objects;
- Check if collection isn’t null (search is supported for the document);
- Iterate through the collection and get position, text and page number.
The following example shows how to search a text with page numbers:
// Create an instance of Parser class
try (Parser parser = new Parser(Constants.SamplePdf)) {
// Search a keyword with page numbers
Iterable<SearchResult> sr = parser.search("lorem", new SearchOptions(false, false, false, true));
// Check if search is supported
if (sr == null) {
System.out.println("Search isn't supported");
return;
}
// Iterate over search results
for (SearchResult s : sr) {
// Print an index, page number and found text:
System.out.println(String.format("At %d (%d): %s", s.getPosition(), s.getPageIndex(), s.getText()));
}
}
You may easily run the code above and see the feature in action in our GitHub examples:
Along with full featured Java library we provide simple, but powerful free Apps.
You are welcome to extract data from PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, Emails and more with our free online Free Online Document Parser App.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
