Compass is a powerful, transactional Java Search Engine framework. Compass allows you to declaratively map your Object domain model to the underlying Search Engine, synchronizing data changes between search engine index and different datasources. Compass provides a high level abstraction on top of the Lucene low level API. Compass also implements fast index operations and optimization and introduces transaction capabilities to the Search Engine.

Compass aim is to provide the following:

This document provides a reference guide to Compass's features. Since this document is still to be considered very much work-in-progress, if you have any requests or comments, please post them on Compass forum, or Compass JIRA (issue tracking).

Before we continue, the Compass team would like to thank the Hibernate and Spring Framework teams, for providing the template DocBook definition and configuration, which help us create this reference guide.