"Which library supports multiple formats?"

"GroupDocs.Search for Java handles PDF, DOCX, XLSX, PPTX, HTML, TXT, and over 50 other file types."

"How do I add documents to index?"

"Call the `index.add()` method with a folder path or a custom `DocumentFilter`."

"Can I run Boolean queries?"

"Yes—combine terms with AND, OR, NOT for precise results."

"How do I improve performance?"

"Use incremental indexing, enable result caching, and disable phonetic search unless needed."

Full text search example in Java with GroupDocs.Search

If you need a full text search example that works across PDFs, Word files, spreadsheets, and more, you’ve come to the right place. Manually scanning thousands of documents is a massive bottleneck, but GroupDocs.Search for Java automates indexing and querying with blazing speed. In this tutorial we’ll walk through everything you need to get up and running— from adding documents to index, crafting boolean query java statements, to optimizing search performance for production workloads.

Quick answers

What is full text search example? It indexes the raw text of every document so you can query any word or phrase instantly.
Which library supports multiple formats? GroupDocs.Search for Java handles PDF, DOCX, XLSX, PPTX, HTML, TXT, and over 50 other file types.
How do I add documents to index? Call the index.add() method with a folder path or a custom DocumentFilter.
Can I run Boolean queries? Yes—combine terms with AND, OR, NOT for precise results.
How do I improve performance? Use incremental indexing, enable result caching, and disable phonetic search unless needed.

What is full text search example?

A full text search example lets you scan the entire textual content of documents, store it in an efficient index, and retrieve matching records instantly. Unlike filename‑only searches, it looks inside PDFs, Word docs, spreadsheets, and other supported formats, making it ideal for document management systems, support portals, and any application where users need to locate information quickly.

Why use GroupDocs.Search for Java?

GroupDocs.Search for Java provides multi‑format support for over 50 file types, including PDF, DOCX, XLSX, PPTX, HTML and plain text. It scales to millions of files while keeping memory usage low by storing the index on disk. The library includes an advanced query language with built‑in Boolean, fuzzy and phonetic searches, and it integrates with a single Maven dependency, allowing you to start indexing within minutes.

Prerequisites

Before you begin, ensure you have:

Java 11+ (Java 8 works, but Java 11 or later is recommended for better performance).
Maven for dependency management.
A GroupDocs.Search license (a free trial key is sufficient for development).

Required libraries and dependencies

Add the repository and dependency to your pom.xml:

<repositories>
    <repository>
        <id>repository.groupdocs.com</id>
        <name>GroupDocs Repository</name>
        <url>https://releases.groupdocs.com/search/java/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.groupdocs</groupId>
        <artifactId>groupdocs-search</artifactId>
        <version>25.4</version>
    </dependency>
</dependencies>

For detailed usage see the documentation.

Environment setup

Install the JDK (8 or newer) and configure JAVA_HOME.
Use an IDE such as IntelliJ IDEA or Eclipse for easier debugging.

Knowledge prerequisites

Basic Java programming concepts.
Familiarity with Maven’s pom.xml structure.

Setting up GroupDocs.Search for Java

You can bring in the library via Maven (shown above) or download the JAR manually.

Direct download (if you prefer manual setup)

Grab the latest package from GroupDocs.Search for Java releases.

License acquisition steps

Free trial – Sign up and receive a temporary key.
Temporary license – Request a longer‑term key for extended testing.
Purchase – Upgrade to a full commercial license when you’re ready for production.

Basic initialization and setup

Create an index folder on disk and verify the library loads correctly:

import com.groupdocs.search.Index;

public class SearchSetup {
    public static void main(String[] args) {
        // Initialize an index in the specified directory
        Index index = new Index("C:\\MyIndex");
        
        System.out.println("GroupDocs.Search initialized!");
    }
}

Pro tip: Keep the index directory on a fast SSD to minimise query latency.

Adding documents to the index

Why this matters: No search results are possible without indexed content. Below we show how to add whole folders or filter specific file types.

Step 1: create an index

The Index class is the searchable container that stores indexed documents on disk.

Index index = new Index("C:\\MyIndex");

Step 2: add documents (add documents to index)

You can index everything in a folder or limit to certain extensions using a DocumentFilter.

index.add("C:\\Documents\\*.*"); // Adds all documents from the specified directory
// For specific file types, use:
index.add("C:\\Reports", new DocumentFilter() {
    @Override
    public boolean accept(String fileName) {
        return fileName.endsWith(".pdf") || fileName.endsWith(".docx");
    }
});

Explanation:
Index represents the searchable database.
add() ingests files; the wildcard *.* grabs all files, while DocumentFilter lets you fine‑tune the add documents to index step.

Performing a search (search documents java)

Now that the index holds data, you can query it.

Step 1: create a query

String query = "GroupDocs";

Step 2: execute the search

SearchResult result = index.search(query);
System.out.println("Documents found: " + result.getDocumentCount());

Explanation:
search() runs the query against the index.
getDocumentCount() tells you how many documents matched—useful for quick sanity checks.

Advanced query techniques (boolean query java)

For precise control, combine terms with Boolean logic.

Boolean queries

The BooleanQuery class lets you build complex expressions using AND, OR, NOT operators.

String booleanQuery = "GroupDocs AND Java";
SearchResult booleanResult = index.search(booleanQuery);

Phonetic searches (optional for fuzzy matching)

The PhoneticSearch feature enables phonetic matching for misspelled terms, but it adds overhead.

index.getSettings().setPhoneticSearch(true);

When to use: Enable phonetic search only if users frequently misspell terms; otherwise, keep it disabled to optimize search performance.

Common issues and solutions

Problem	Why it happens	Fix
Missing documents	Incorrect file path or insufficient permissions	Verify the path and grant read access
Slow queries	Large index without caching or unnecessary phonetic search	Enable caching, disable phonetic search, and consider splitting the index
Out‑of‑Memory errors	Index size exceeds JVM heap	Increase `-Xmx` or use incremental indexing

Practical applications

GroupDocs.Search shines in real‑world scenarios:

Content management systems – Provide instant full‑text search across articles, PDFs, and media assets.
Customer support portals – Agents can locate relevant manuals or policies in seconds.
Enterprise document repositories – Search across contracts, reports, and compliance documents without moving data to a separate database.

Performance considerations

Optimizing search performance

Incremental indexing: Add or update only changed files instead of rebuilding the whole index.
Caching: Keep frequently used query results in memory.
Resource monitoring: Adjust JVM heap (-Xmx2g or higher) based on index size.

Resource‑usage guidelines

Store the index folder on a fast SSD or NVMe drive.
Monitor CPU and memory during bulk indexing; throttle batch operations to avoid spikes.

Best practices for Java memory management

Use try‑with‑resources when working with streams.
Nullify large objects after use to aid garbage collection.

Conclusion

You now have a complete, production‑ready full text search example in Java using GroupDocs.Search. From setting up the library, adding documents to index, crafting boolean query java statements, to optimizing search performance, every step is covered.

Next steps

Explore deeper features such as custom analyzers, synonym dictionaries, and cloud‑storage integration by checking the official GroupDocs.Search Documentation.

Frequently asked questions

Q: What file formats does GroupDocs.Search support?
A: Over 50 formats, including PDF, DOCX, XLSX, PPTX, HTML, TXT, and many image types.

Q: How should I handle large datasets?
A: Split them into multiple indexes, update incrementally, and enable result caching to keep latency low.

Q: Can GroupDocs.Search run in cloud environments?
A: Yes—you can point the index folder to a mounted cloud storage (e.g., Azure Blob, AWS S3 via a filesystem driver).

Q: What are the advantages of GroupDocs.Search over other libraries?
A: Multi‑format support, built‑in Boolean/phonetic queries, and a lightweight Java API that processes millions of documents with a low memory footprint.

Q: How do I troubleshoot performance issues?
A: Review index settings, disable phonetic search if not needed, and monitor JVM memory/CPU usage during indexing and querying.

Last Updated: 2026-08-15
Tested With: GroupDocs.Search 25.4
Author: GroupDocs

Resources

Documentation: GroupDocs.Search Documentation
API reference: API Reference Guide
Download: Latest Releases
GitHub: Source Code on GitHub
Support: Forum and Community Support
License: Request a Temporary License