Compass Core

Compass Core provides the core of Compass simplification of search engine integration into an application. Compass is very simple to use, and you can start/enable a searchable application in a matter of hours, many times without knowing about Compass advance features and extendibility.

The two most important chapters are Chapter 2, Introduction, which explains the high level Compass API's (similar to your usual ORM framework), and Chapter 3, Configuration which explains how to configure a Compass instance. Chapter 5, Search Engine dives into details of Compass search engine abstraction, explaining concepts, index structure, and Lucene extensions (both Compass extensions and Compass enabling Lucene features simply). In order to start using Compass, reading this chapter is not required, though it does provide a good overview of how Compass abstracts Lucene, and explains how to configure advance search engine related features (Analyzers, Optimizers, Sub Index Hashing, and so on).

The following chapters dive into details of Compass different mapping technologies. Chapter 6, OSEM - Object/Search Engine Mapping explain how to use Compass OSEM (Object/Search Engine Mapping), Chapter 7, XSEM - Xml to Search Engine Mapping goes into details of how to use Compass XSEM (Xml/Search Engine Mapping), and Chapter 8, RSEM - Resource/Search Engine Mapping dives into Compass RSEM (Resource/Search Engine Mapping), which is a low level, Lucene like, mapping support.

Chapter 9, Common Meta Data explains Compass support for creating a semantic model defined outside of the mapping definitions. Using it is, in the spirit of Compass, completely optional, and depends on the developers if they wish to use it within their Compass enabled application.

Chapter 10, Transaction goes into details of the different ways to integrate Compass transaction support within different transaction managers. It explains both local (Compass managed) transaction, and JTA integration.