Search text in EPUB eBooks

To search a keyword in EPUB e-books search(String) method is used. This method returns the collection of SearchResult objects. For details, see Search Text.

Here are the steps to search a keyword in EPUB e-book:

  • Instantiate Parser object for the initial e-book;
  • Call search(String) method and obtain the collection of SearchResult objects;
  • Iterate through the collection and get the position and text.

The following example shows how to find a keyword in EPUB e-book:

// Create an instance of Parser class
try (Parser parser = new Parser(Constants.SampleEpub)) {
    // Search a keyword:
    Iterable<SearchResult> sr = parser.search("One");
    // 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()));
    }
}

search(String, SearchOptions) method is used for the advanced search in EPUB e-books - like search with regular expressions, search by pages etc. SearchOptions parameter is used to customize a search.

Here are the steps to search with a regular expression in EPUB e-book:

The following example shows how to search with a regular expression in EPUB e-book:

// Create an instance of Parser class
try (Parser parser = new Parser(Constants.SampleEpub)) {
    // Search with a regular expression with case matching
    Iterable<SearchResult> sr = parser.search("\\\\slist", new SearchOptions(true, false, true));
    // 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()));
    }
}

More resources

GitHub examples

You may easily run the code above and see the feature in action in our GitHub examples:

Free online document parser App

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to parse documents and extract data from PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, Emails and more with our free online Free Online Document Parser App.