Reference Documentation 2.1.4 Copyright © 2004-2008 Shay Banon (kimchy), Alan Hardy Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically. Table of Contents Preface ................................................................................................................................................ 1. Introduction .................................................................................................................................. 1.1. Overview ............................................................................................................................. 1 1.2. I use ... ................................................................................................................................. 2 1.2.1. ... Lucene .................................................................................................................. 2 1.2.2. ... Domain Model ....................................................................................................... 4 1.2.3. ... Xml Model ............................................................................................................ 4 1.2.4. ... No Model .............................................................................................................. 4 1.2.5. ... ORM Framework ................................................................................................... 4 1.2.6. ... Spring Framework ................................................................................................. 5 I. Compass Core ................................................................................................................................. 2. Introduction .......................................................................................................................... 2.1. Overview ..................................................................................................................... 7 2.2. Session Lifecycle ......................................................................................................... 8 2.3. Template and Callback ................................................................................................. 8 3. Configuration ........................................................................................................................ 3.1. Programmatic Configuration ......................................................................................... 9 3.2. XML/JSON Configuration ............................................................................................ 11 3.2.1. Schema Based Configuration .............................................................................. 11 3.2.2. JSON Based Configuration ................................................................................ 13 3.2.3. DTD Based Configuration .................................................................................. 13 3.3. Obtaining a Compass reference ..................................................................................... 14 3.4. Rebuilding Compass ..................................................................................................... 14 3.5. Configuring Callback Events ........................................................................................ 14 4. Connection ............................................................................................................................ 4.1. File System Store ......................................................................................................... 15 4.2. RAM Store .................................................................................................................. 16 4.3. Jdbc Store .................................................................................................................... 16 4.3.1. Managed Environment ....................................................................................... 17 4.3.2. Data Source Provider ......................................................................................... 17 4.3.3. File Entry Handler ............................................................................................. 19 4.3.4. DDL ................................................................................................................. 19 4.4. Lock Factory ................................................................................................................ 20 4.5. Local Directory Cache .................................................................................................. 20 4.6. Lucene Directory Wrapper ............................................................................................ 21 4.6.1. SyncMemoryMirrorDirectoryWrapperProvider ................................................... 21 4.6.2. AsyncMemoryMirrorDirectoryWrapperProvider ................................................. 21 5. Search Engine ....................................................................................................................... 5.1. Introduction ................................................................................................................. 23 5.2. Alias, Resource and Property ........................................................................................ 23 5.2.1. Using Resource/Property .................................................................................... 23 5.3. Analyzers .................................................................................................................... 23 5.3.1. Configuring Analyzers ....................................................................................... 24 5.3.2. Analyzer Filter .................................................................................................. 25 5.3.3. Handling Synonyms .......................................................................................... 25 5.4. Similarity ..................................................................................................................... 26 5.5. Query Parser ................................................................................................................ 26 5.6. Index Structure ............................................................................................................. 26 Compass - Java Search Engine ii Compass - Java Search Engine Framework 5.7. Transaction .................................................................................................................. 27 5.7.1. Locking ............................................................................................................ 27 5.7.2. Isolation ............................................................................................................ 28 5.7.3. Transaction Log ................................................................................................ 29 5.8. All Support .................................................................................................................. 30 5.9. Sub Index Hashing ....................................................................................................... 31 5.9.1. Constant Sub Index Hashing .............................................................................. 31 5.9.2. Modulo Sub Index Hashing ................................................................................ 32 5.9.3. Custom Sub Index Hashing ................................................................................ 34 5.10. Optimizers ................................................................................................................. 35 5.10.1. Scheduled Optimizers ...................................................................................... 35 5.10.2. Aggressive Optimizer ...................................................................................... 35 5.10.3. Adaptive Optimizer ......................................................................................... 35 5.10.4. Null Optimizer ................................................................................................ 36 5.11. Merge ........................................................................................................................ 36 5.11.1. Merge Policy ................................................................................................... 36 5.11.2. Merge Scheduler .............................................................................................. 36 5.12. Index Deletion Policy ................................................................................................. 36 5.13. Spell Check / Did You Mean ....................................................................................... 37 5.13.1. Spell Index ...................................................................................................... 38 5.14. Direct Lucene ............................................................................................................. 39 5.14.1. Wrappers ........................................................................................................ 39 5.14.2. Searcher And IndexReader ............................................................................... 39 6. OSEM - Object/Search Engine Mapping ..............................................................................