changelog.txt

Hibernate Search Changelog
==========================

3.3.0.Final (15-12-2010)
------------------------

** Bug
    * [HSEARCH-629] - Mark the NumericField feature as experimental (Lucene mark it as such)
    * [HSEARCH-646] - Unable to run tests against non in memory db
    * [HSEARCH-647] - WorkPlan causes ConcurrentModificationException on finding new entity types during processContainedInAndPrepareExecution
    * [HSEARCH-649] - Fix assembly not containing Infinispan dependencies


** Improvement
    * [HSEARCH-648] - Apply suggestions from Infinispan team to Infinispan default configuration


3.3.0.CR2 (09-12-2010)
----------------------

** Bug
    * [HSEARCH-513] - Experiencing long delays when indexing entities saved in different transactions
    * [HSEARCH-577] - IllegalArgumentException when using @Proxy and trying to delete a loaded but proxied class
    * [HSEARCH-625] - Some errors triggered by Lucene are not catched by the ErrorHandler
    * [HSEARCH-635] - Remove build cycle and duplicate classes from hibernate-search-testing module
    * [HSEARCH-640] - MassIndexer/JBoss 6: Could not register synchronization for container transaction
    * [HSEARCH-641] - idProvided flag in DocumentBuilderIndexedEntity is always false


** Improvement
    * [HSEARCH-511] - Clean up orphaned lock files on startup
    * [HSEARCH-570] - Optimize the o^2 loop in DocumentBuilderIndexedEntity.addWorkToQueue
    * [HSEARCH-630] - Rename limitFetchTime() to query.limitTimeAllowedTo() or limitExecutionTimeTo() in Query API
    * [HSEARCH-631] - Protect against excessive proxying (in particular in Seam)
    * [HSEARCH-632] - Make sure indexAsNull and Query DSL work like a charm together
    * [HSEARCH-639] - Update dependency to Lucene 3.0.3

** New Feature
    * [HSEARCH-307] - Implement clustering with Infinispan
    * [HSEARCH-416] - Analyze Payload and how this could be used to store id and class in the index and not the document
    * [HSEARCH-644] - Enable Byteman for unit tests


** Task
    * [HSEARCH-579] - Ensure compatibility with latest Hibernate Core 3.6
    * [HSEARCH-602] - Create new hibernate-search-infinispan skeleton module
    * [HSEARCH-637] - Review documentation


3.3.0.CR1 (08-11-2010)
----------------------

** Bug
    * [HSEARCH-513] - Experiencing long delays when indexing entities saved in different transactions
    * [HSEARCH-532] - FSSlaveDirectoryProvider could retry several times when the current marker file is not found
    * [HSEARCH-573] - PerDPQueueProcessor forces release of lock even if not held - causes corrupt index
    * [HSEARCH-610] - AndDocIdSet makeDocIdSetOnAgreedBits() returns wrong values
    * [HSEARCH-621] - Some dependencies have the wrong scope
    * [HSEARCH-624] - NumericField is not working properly with id fields


** Improvement
    * [HSEARCH-115] - Add a default value for indexing null value
    * [HSEARCH-275] - support NIOFSDirectory and others as optimized FSDirectory extensions
    * [HSEARCH-618] - BridgeFactory should pass along the field type to the field bridge constructor (if an appropriate constructor exists)
    * [HSEARCH-627] - Use System.nanoTime() instead of currentTimeMillis() when measuring elapsed time (better precision)
    * [HSEARCH-628] - Provide shortcut names for the major DirectoryProviders

** New Feature
    * [HSEARCH-390] - Allow customization of the charset used by analyzer components
    * [HSEARCH-434] - Make use of NumericField
    * [HSEARCH-615] - Support for queries limited in time: return the first nth elements within a given time


** Task
    * [HSEARCH-622] - Remove <remoteTagging>true</remoteTagging> in the maven-release-plugin configuration (no longer needed)


3.3.0.Beta3 (1-11-2010)
-----------------------

** Bug
    * [HSEARCH-608] - Index not created if path contains tilde like ~/.lucene/
    * [HSEARCH-616] - Factory method invocation in FullTextQueryImpl swallows exception
    * [HSEARCH-619] - Update documentation about hibernate-search-analyzers module
    
** Improvement
    * [HSEARCH-405] - Be able to set Similarity per index in configuration properties
    * [HSEARCH-424] - Update to Lucene 3.0
    * [HSEARCH-569] - duplicate identifiers on @AnalyzerDef are accepted and don't warn about the inconsistent configuration

** New Feature
    * [HSEARCH-374] - Timeout support for full-text searches
    * [HSEARCH-603] - Support pluggable services and expose them to pluggable components like DirectoryProviders and ReaderProviders


** Task
    * [HSEARCH-524] - Migrate unit tests to H2 (instead of HSQLDB) for inclusion in the Hudson train
    * [HSEARCH-607] - Consider creating a distribution project
    * [HSEARCH-613] - Automatic archetype install and deploy
    * [HSEARCH-617] - Move monitoring section as top level chapter


3.3.0.Beta2 (15-10-2010)
------------------------

** Sub-task
    * [HSEARCH-435] - New token stream API, is there a benefit, work on our part?
    * [HSEARCH-449] - Consider LUCENE-1575 carefully: not scoring by default?
    * [HSEARCH-457] - Analyzers in Lucene 3.0 don't have a default constructor
    * [HSEARCH-593] - Upgrade/Update Solr analyzer framework
    * [HSEARCH-596] - Add isCompressed() to LuceneOptions

** Bug
    * [HSEARCH-528] - MassIndexer attempts to index non-indexed subclasses of indexed types
    * [HSEARCH-545] - Unable to project FullTextQuery.SCORE when using a custom Sort
    * [HSEARCH-546] - ProjectionLoader ignores FetchMode.JOIN set via a Criteria
    * [HSEARCH-554] - Documentation about worker configuration is not up to date
    * [HSEARCH-587] - Maven release:perform fails
    * [HSEARCH-588] - Query DSL documentation has incorrect queries
    * [HSEARCH-589] - org.hibernate.search.test.TransactionTest fails under PostgreSQL 8.4
    * [HSEARCH-591] - Programmatic mapping raises exception when a non getter method is parsed by the metadata binder
    * [HSEARCH-594] - Typos in Hibernate Search documentation
    * [HSEARCH-600] - Sync Hibernate Search with Hibernate Core 3.6.0.Final
    * [HSEARCH-604] - Add better exception handling for FulltextQueryImpl.calculateTopDocsRetrievalSize()
    * [HSEARCH-606] - Exceptions during indexing are logged but swallowed when using local transactions (not JTA)

** Deprecation
    * [HSEARCH-572] - Reconsider deprecating luceneOptions.getStore(), luceneOptions.getIndex() etc

** Improvement
    * [HSEARCH-556] - Throw meaningful error on Search static helper methods used with null argument
    * [HSEARCH-575] - More useful error message on bridge indexing failure
    * [HSEARCH-586] - Rework the JMX chapter as a monitoring chapter describing the programmatic API and then how to expose it via JMX
    * [HSEARCH-592] - Make sure that all tests can be run from within the IDE

** New Feature
    * [HSEARCH-555] - Properly expose as public API the SearchFactoryBuilder
    * [HSEARCH-574] - Allow @DocumentId and @Id to be put on different members


** Task
    * [HSEARCH-371] - Refactor DocumentBuilder and introduce abstract base class
    * [HSEARCH-590] - update test db profile id against dballocator's schema and update jdbc driver version
    * [HSEARCH-602] - Create new hibernate-search-infinispan skeleton module


3.3.0.Beta1 (25-08-2010)
------------------------

** Bug
    * [HSEARCH-585] - ClassBridgeAndProjectionTest and NestedContainedInTest hang when run against PostgreSQL due to missing transactions


** Improvement
    * [HSEARCH-580] - Copy SoftLimitMRUCache into Hibernate Search codebase to no longer depend on Hibernate Core internals
    * [HSEARCH-581] - No longer use Hibernate Core's Helper classes: use Commons Annotations Helpers instead
    * [HSEARCH-582] - Move Query DSL package to org.hibernate.search.query.dsl
    * [HSEARCH-583] - Add enforcer plugin to Search master pom to enforce JDK 6

** New Feature
    * [HSEARCH-135] - Create a RAMDirectoryProvider from an existing Lucene FSDirectory
    * [HSEARCH-278] - Create a Search Statistic JMX Bean


** Task
    * [HSEARCH-562] - Convert or add JBossTS usage to the integrationtest module
    * [HSEARCH-563] - Document the DSL query language
    * [HSEARCH-564] - Document the API changes of the semi public APIs
    * [HSEARCH-584] - Upgrade to Hibernate Core 3.6.0.Beta3

    
3.3.0.Alpha1 (26-07-2010)
-------------------------

** Sub-task
    * [HSEARCH-507] - Rename exact() to keywords() and move fuzzy() and wildcard() back as suboperations of keywords()
    * [HSEARCH-508] - Support query on multiple fields
    * [HSEARCH-509] - Add support for all() query and all except ones
    * [HSEARCH-533] - Use Hibernate Search bridge system to convert input
    * [HSEARCH-541] - Restructure various initialize contracts to allow SearchFactory implementors to be immutable
    * [HSEARCH-544] - Provide an immutable SearchFactory implementation

** Bug
    * [HSEARCH-487] - Find why the zh-CN translation fails
    * [HSEARCH-530] - Entity analyzers (aka scoped analyzers) improperly return random analyzers on field not marked as TOKENIZED
    * [HSEARCH-534] - circular graphs of IndexedEmbedded might break MassIndexer
    * [HSEARCH-536] - IndexingGeneratedCorpusTest raises OOME and hangs
    * [HSEARCH-537] - SearchIndexerTest fails
    * [HSEARCH-540] - JTA transaction commit causes AssertionFailure: Access a Sealed WorkQueue which has not been sealed
    * [HSEARCH-548] - Specify explicit version for deploy and artifact plugins in partent pom
    * [HSEARCH-560] - Version is displayed after the SearchFactory metadata creation
    * [HSEARCH-568] - Unable to push stagged releases because hibernate-search-testing does not deploy the sources artifacts


** Improvement
    * [HSEARCH-535] - Always setAccessible to true as it makes property access faster (bypass repetitive security checkings)
    * [HSEARCH-549] - Isolate Hibernate.initialize / Hibernate.getClass calls into HibernateHelper
    * [HSEARCH-552] - Raise an exception when the object passed to the worker is not of an unindexed or contained type
    * [HSEARCH-553] - Mutualize class extraction logic from a Work object
    * [HSEARCH-559] - Migrate to SLF4J 1.6 for graceful degradation when no slf4j implementation is provided
    * [HSEARCH-561] - Add tests making use of JTA and Spring in a new module

** New Feature
    * [HSEARCH-397] - Allow classes to be lazily added to the SearchFactory
    * [HSEARCH-414] - Add support for a Lucene query builder using a fluent API
    * [HSEARCH-538] - Allow Hibernate Search to use the @FailureExpected test framework


** Task
    * [HSEARCH-523] - Build the distribution package with the docs in the same directory structure as on the docs server
    * [HSEARCH-558] - Align Search with Core 3.6


3.2.0.Final (05-05-2010)
------------------------

** Bug
    * [HSEARCH-333] - Remove or improve log warning in DocumentBuilderContainedEntity.checkDocumentId
    * [HSEARCH-396] - disableFullTextFilter(String name) in FullTextQueryImpl does not disable the filter.
    * [HSEARCH-485] - mvn site is currently not working (in ./hibernate-search)
    * [HSEARCH-512] - MassIndexer might associate proxies to two open session
    * [HSEARCH-515] - Lucene AlreadyClosedExceptions During Batch Processing With ASYNC Workers
    * [HSEARCH-516] - Lucene Directories might be closed before the backend finished all tasks on shutdown
    * [HSEARCH-517] - ThreadLocal in ContextHolder causes memory leak when deployed in a web container
    * [HSEARCH-518] - pom.xml misses pluginrepository
    * [HSEARCH-522] - Search only compiles against JDK 6 with the current version of JGroups


** Improvement
    * [HSEARCH-506] - Bump dependency to core 3.5.1-Final
    * [HSEARCH-519] - Update JGroups dependencies

** New Feature
    * [HSEARCH-467] - publish Maven artifacts containing the testsuite

** Patch
    * [HSEARCH-503] - Generated archetype broken for any package name with dot (.)
    * [HSEARCH-514] - logging and typo improvements in JGroups backend

** Task
    * [HSEARCH-486] - Review the getting started section's pom and archetype creation
    * [HSEARCH-510] - Update pom to use the new distributationManagement information
    

3.2.0.CR1 (12-04-2010)
----------------------

** Sub-task
    * [HSEARCH-411] - Get a feature complete programmatic mapping (Amin Mohammed-Coleman)
    * [HSEARCH-459] - Update quickstart archetype
    * [HSEARCH-480] - Some add/delete operations have null primary keys
    * [HSEARCH-481] - In a given sealed queue, only apply the same add/delete operation once
    * [HSEARCH-493] - Continuous integration builds fail some tests on Oracle databases
    * [HSEARCH-496] - Some hudson configurations need more time to run the testsuite
    * [HSEARCH-497] - sybase15 Hudson configuration fails because of java.net.ConnectException: Connection refused
    * [HSEARCH-498] - Postgres Hudson configurations fail by SQLGrammarException

** Bug
    * [HSEARCH-305] - Hibernate search doesn't work with criteria when it is not initialized laziily
    * [HSEARCH-321] - FSSlaveDirectoryProvider incorrectly creates a subdirectory named 0
    * [HSEARCH-346] - Setup hudson job testing Search against several databases
    * [HSEARCH-382] - Indexing fails silently in case the file based index is mounted read only
    * [HSEARCH-385] - Lazy ManyToOne association with @containedIn annotation cause HSearch create entity index with documentId = 0
    * [HSEARCH-386] - In a Transaction, Delete on unindexed entities referenced by indexed entities with ContainedIn throw LazyInitializationException
    * [HSEARCH-393] - unit test of the NotSharedReaderPerfTest hangs on with some database
    * [HSEARCH-399] - NPE in org.hibernate.search.backend.WorkQueue.clear()
    * [HSEARCH-422] - Properly implement delegation for FullTextEntityManager, FullTextSession and FullTextQuery methods of the new Hibernate version
    * [HSEARCH-440] - FSSlaveDirectoryProvider creates a wrong index directory in case the current marker file does not exist
    * [HSEARCH-443] - Using a Field extending AbstractField causes a ClassCastException in DocumentBuilderIndexedEntity when using @AnalyzerDiscriminator
    * [HSEARCH-448] - Update JPATestCase after renaming of HibernatePersistence to AvailableSettings in Core
    * [HSEARCH-450] - Example 1.9. superfluous hibernate word
    * [HSEARCH-452] - FSMasterDirectoryProvider: typo in marker file name (Stephan Bublava)
    * [HSEARCH-456] - CalendarBridge ignoring setParameterValues
    * [HSEARCH-473] - Fields for _hibernate_class and the document ID are hard-coded to be analyzed and have "norms" enabled (Dobes Vandermeer)
    * [HSEARCH-474] - Ensure IndexWriter is closed on errors in backend
    * [HSEARCH-476] - Work queue contains the same operation multiple times and some add/delete operations have null primary keys
    * [HSEARCH-478] - Entities with composite PK lead to query exceptions on MySQL
    * [HSEARCH-479] - Return empty result list - Composed primary key - lucene search ok - primary key bridge ok
    * [HSEARCH-484] - Building documentation fails
    * [HSEARCH-488] - Nested use of @ContainedIn: changes not propagated to Lucene index
    * [HSEARCH-490] - MassIndexer needs to use distinct on primary key selection
    * [HSEARCH-492] - FSMasterDirectoryProvider and FSSlaveDirectoryProvider don't shutdown the Executor
    * [HSEARCH-495] - IdentifierProducer: ClassCastException
    * [HSEARCH-500] - Some tests don't close the SessionFactory and SearchFactory
    * [HSEARCH-505] - JGroupsMasterTest uses native SQL failing on DB2 and sybase


** Improvement
    * [HSEARCH-437] - When using Thread bound sessions, Hibernate Search FTSession creation fails if out of transaction
    * [HSEARCH-441] - Custom LockFactory loading should use PluginLoader
    * [HSEARCH-447] - The build should use the maven-injection-plugin in order to dynamically inject the version string into org.hibernate.search.Version
    * [HSEARCH-464] - Upgrade Lucene to 2.9.2
    * [HSEARCH-475] - Improve error message on wrong type as filter parameter
    * [HSEARCH-477] - Support for the new Solr's character filters (Gustavo Fernandes)
    * [HSEARCH-489] - Remove the code avoiding the use of in restrictions when a composite id is used: Core does it automatically
    * [HSEARCH-491] - Make some optional dependencies mandatory
    * [HSEARCH-501] - Make use of BeforeTransactionCompletionProcess and AfterTransactionCompletionProcess instead of Synchronization
    * [HSEARCH-502] - update MassIndexer to use new core features

** New Feature
    * [HSEARCH-352] - Introduce a programmatic mapping API
    * [HSEARCH-372] - Support projection for ClassBridges that pass and use the field name passed in @ClassBridge.name
    * [HSEARCH-379] - Properly implement new JPA 2 methods (Query and EntityManager)
    * [HSEARCH-415] - Consider moving to Lucene 2.9
    * [HSEARCH-421] - Provide a callback on indexing exception (Amin Mohammed-Coleman)
    * [HSEARCH-429] - Add a configuration property to declaratively use a factory for the programmatic mapping API (Amin Mohammed-Coleman)


** Task
    * [HSEARCH-322] - Review MultiClassesQueryLoader
    * [HSEARCH-408] - Improve execution speed of functional tests
    * [HSEARCH-425] - Reimplement support for compressed fields (support removed in Lucene3)
    * [HSEARCH-427] - Make the hibernate-search-artifact directory a proper maven module
    * [HSEARCH-428] - Update the Getting Started section of the documentation
    * [HSEARCH-432] - Add logging to trace the WorkQueue before being processed
    * [HSEARCH-439] - Merge fixes from JBAPP (v3_1_1_GA_CP) branch to trunk
    * [HSEARCH-442] - Upgrade existing code to Lucene 2.9.1
    * [HSEARCH-454] - Upgrade Solr dependencies (Gustavo Fernandes)
    * [HSEARCH-455] - Keep Search compatible with latest Hibernate Core
    * [HSEARCH-458] - Remove all deprecations from Lucene's 2.9 API usage
    * [HSEARCH-463] - Change the master docbook document to use the version number provided by the docbook plugin
    * [HSEARCH-465] - Move to commons-annotations 3.2.0.Final
    * [HSEARCH-468] - Refactor build to have a module setup
    * [HSEARCH-482] - Update dependencies to Hibernate Core 3.5.0-Final
    * [HSEARCH-483] - update readme.txt
    * [HSEARCH-494] - Fix hudson failures
    * [HSEARCH-504] - Fix ContainedIn tests which break on Oracle as they use a reserved keyword as column name


3.2.0.Beta1 (30-11-2009)
------------------------

** Sub-task
    * [HSEARCH-410] - Write documentation for what's available of the programmatic mapping API (Amin Mohammed-Coleman)
    * [HSEARCH-412] - Provide the main mapping artifacts programmatically

** Bug
    * [HSEARCH-178] - Out of transaction work causes collection lazy loading to throw AssertionFailure
    * [HSEARCH-332] - documentation errors: org.hibernate.Query  should be  javax.persistence.Query
    * [HSEARCH-353] - removing an entity and adding another with same PK  (in same TX) will not add second entity to index
    * [HSEARCH-355] - FilterOptimizationHelper was improperly using method overloading
    * [HSEARCH-357] - IdBridge being applied on null entity during purgeAll()
    * [HSEARCH-366] - typo in Discriminator.getAnanyzerDefinitionName()
    * [HSEARCH-367] - Support only one kind of Similarity per index
    * [HSEARCH-380] - Duplicate classes from Maven transitive dependencies (incompatible version of solr-lucene-core)
    * [HSEARCH-391] - Two-Level embedded objects don't get an index update
    * [HSEARCH-394] - @ProvidedId gets ignored
    * [HSEARCH-398] - NPE when named FullTextFilter is disabled without being enabled first
    * [HSEARCH-418] - ProvidedIdTest fails

** Deprecation
    * [HSEARCH-201] - IndexWriter settings meant for transactional operations won't be inherited by the settings meant for batch operations

** Improvement
    * [HSEARCH-246] - Run optimize at the end of the transaction even if flushToIndexes() is used
    * [HSEARCH-284] - Be able to configure a LockFactory
    * [HSEARCH-301] - Refactor JMSMasterTest and JMSSlaveTest
    * [HSEARCH-327] - Capability to reuse IndexWriter instances across transactions
    * [HSEARCH-328] - Add a builtin bridge for Calendar (Amin Mohammed-Coleman)
    * [HSEARCH-358] - @ClassBridge.impl is no longer defaulted
    * [HSEARCH-365] - Update pom.xml to include database profiles for QA Lab
    * [HSEARCH-369] - typos in documentation
    * [HSEARCH-384] - improve error messages for loading plugins and add consistency to the performed checks
    * [HSEARCH-404] - Update database profiles in pom.xml

** New Feature
    * [HSEARCH-218] - add indexAll( Class type ) to rebuild indexes from all data
    * [HSEARCH-251] - Query on a shard subset based on a filter activation (Chase Seibert)
    * [HSEARCH-324] - @DynamicBoost(BoostStrategy.class)
    * [HSEARCH-334] - Create a builtin bridge for Character
    * [HSEARCH-345] - Use any custom LockFactory
    * [HSEARCH-347] - Adding a blackhole backend
    * [HSEARCH-392] - Provide a JGroups based backend


** Task
    * [HSEARCH-82] - Migrate from ant  to maven2
    * [HSEARCH-326] - Drop support for IndexReader usage to update indexes.
    * [HSEARCH-348] - Upgrade to Lucene 2.4.1
    * [HSEARCH-359] - Fix usage of deprecated Hibernate commons-annotations methods
    * [HSEARCH-375] - Create pot files in order to allow translation of documentation
    * [HSEARCH-403] - Fix copyright notice and end-of-line terminators in source code
    * [HSEARCH-409] - Write documentation for JGroups based configuration (Lukasz Moren)
    * [HSEARCH-413] - Document all new features
    * [HSEARCH-419] - Create a proper @ProvidedId test
    * [HSEARCH-423] - Migrate to Hibernate Core 3.5 beta2 and JPA 2.0 CR1
    * [HSEARCH-426] - Update archetype sources 


3.1.1.GA (28-05-2009)
---------------------

** Bug
    * [HSEARCH-178] - Out of transaction work causes collection lazy loading to throw AssertionFailure
    * [HSEARCH-310] - Out of Memory on ScrollableResults
    * [HSEARCH-325] - FullTextQuery.iterate() skips last result.
    * [HSEARCH-330] - NegativeArraySizeException if you use FullTextQuery.setMaxResults(Integer.MAX_VALUE)
    * [HSEARCH-338] - ScrollableResults initial position not coherent to core Hibernate
    * [HSEARCH-339] - ScrollableResults may return unmanaged entities from it's own cache
    * [HSEARCH-342] - Delete on unindexed entities referenced by indexed entities with ContainedIn annotation failed
    * [HSEARCH-355] - FilterOptimizationHelper was improperly using method overloading
    * [HSEARCH-357] - IdBridge being applied on null entity during purgeAll()
    * [HSEARCH-360] - Hibernate Search 3.1.0GA Bugs after HSEARCH-160


** Improvement
    * [HSEARCH-340] - ScrollableResults exploits batch loading for backwards and random order scrolling
    * [HSEARCH-369] - typos in documentation


** Task
    * [HSEARCH-348] - Upgrade to Lucene 2.4.1


3.1.0.GA (4-12-2008)
--------------------

** Bug
    * [HSEARCH-233] - EntityNotFoundException during indexing
    * [HSEARCH-280] - Make FSSlaveAndMasterDPTest pass against postgresql
    * [HSEARCH-297] - Allow PatternTokenizerFactory to be used
    * [HSEARCH-309] - PurgeAllLuceneWork duplicates in work queue

** Improvement
    * [HSEARCH-221] - Get Lucene Analyzer runtime (indexing)
    * [HSEARCH-265] - Raise warnings when an abstract class is marked @Indexed
    * [HSEARCH-285] - Refactor DocumentBuilder to support containedIn only and regular Indexed entities
    * [HSEARCH-298] - Warn for dangerous IndexWriter settings
    * [HSEARCH-299] - Use of faster Bit operations when possible to chain Filters
    * [HSEARCH-302] - Utilize pagination settings when retrieving TopDocs from the Lucene query to only retrieve required TopDocs
    * [HSEARCH-308] - getResultSize() implementation should not load documents
    * [HSEARCH-311] - Add a close() method to BackendQueueProcessorFactory
    * [HSEARCH-312] - Rename hibernate.search.filter.cache_bit_results.size to hibernate.search.filter.cache_docidresults.size

** New Feature
    * [HSEARCH-160] - Truly polymorphic queries
    * [HSEARCH-268] - Apply changes to different indexes in parallel
    * [HSEARCH-296] - Expose managed entity class via a Projection constant

** Task
    * [HSEARCH-303] - Review reference documentation


3.1.0.CR1 (17-10-2008)
------------------------

** Bug
    * [HSEARCH-250] - In ReaderStrategies, ensure that the reader is current AND that the directory returned by the DirectoryProvider are the same
    * [HSEARCH-293] - AddLuceneWork is not being removed from the queue when DeleteLuceneWork is added for the same entity
    * [HSEARCH-300] - Fix documentation on use_compound_file

** Improvement
    * [HSEARCH-213] - Use FieldSelector and doc(int, fieldSelector) to only select the necessary fields
    * [HSEARCH-224] - Use MultiClassesQueryLoader in ProjectionLoader
    * [HSEARCH-255] - Create a extensive Analyzer testing suite
    * [HSEARCH-266] - Do not switch to the current directory in FSSlaveDirectoryProvider if no file has been copied
    * [HSEARCH-274] - Use Lucene's new readonly IndexReader
    * [HSEARCH-281] - Work should be Work<T>
    * [HSEARCH-283] - Replace deprecated Classes and methods calls to Lucene 2.4

** New Feature
    * [HSEARCH-104] - Make @DocumentId optional and rely on @Id
    * [HSEARCH-290] - Use IndexReader = readonly on Reader strategies (see Lucene 2.4)
    * [HSEARCH-294] - Rename INSTANCE_AND_BITSETRESULTS to INSTANCE_AND_DOCIDSETRESULTS

** Task
    * [HSEARCH-288] - Evaluate changes in Lucene 2.4.0
    * [HSEARCH-289] - Move to new Lucene Filter DocIdSet
    * [HSEARCH-291] - improve documentation about thread safety requirements of Bridges.
    

3.1.0.Beta2 (27-10-2008)
------------------------

** Bug
    * [HSEARCH-142] - Modifications on objects indexed via @IndexedEmbedded not updated when not annotated @Indexed
    * [HSEARCH-162] - NPE on queries when no entity is marked as @Indexed
    * [HSEARCH-222] - Entities not found during concurrent update
    * [HSEARCH-225] - Avoid using IndexReader.deleteDocument when index is not shared amongst several entity types
    * [HSEARCH-232] - Using SnowballPorterFilterFactory throws NoClassDefFoundError
    * [HSEARCH-237] - IdHashShardingStrategy fails on IDs having negative hashcode
    * [HSEARCH-241] - initialize methods taking Properties cannot list available properties
    * [HSEARCH-247] - Hibernate Search cannot run without apache-solr-analyzer.jar
    * [HSEARCH-253] - Inconsistent detection of EventListeners during autoregistration into Hibernate listeners
    * [HSEARCH-257] - Ignore delete operation when Core does update then delete on the same entity
    * [HSEARCH-259] - Filter were not isolated by name in the cache
    * [HSEARCH-262] - fullTextSession.purgeAll(Class<?>) does not consider subclasses
    * [HSEARCH-263] - Wrong analyzers used in IndexWriter
    * [HSEARCH-267] - Inheritance of annotations and analyzer
    * [HSEARCH-271] - wrong Similarity used when sharing index among entities
    * [HSEARCH-287] - master.xml is mistakenly copied to the distribution

** Deprecation
    * [HSEARCH-279] - deprecate SharedReaderProvider replaced by SharingBufferReaderProvider as default ReaderProvider

** Improvement
    * [HSEARCH-145] - Document a configuration property
    * [HSEARCH-226] - Use Lucene ability to delete by query in IndexWriter
    * [HSEARCH-240] - Generify the IndexShardingStrategy
    * [HSEARCH-245] - Add ReaderStratregy.destroy() method
    * [HSEARCH-256] - Remove CacheBitResults.YES
    * [HSEARCH-260] - Simplify the Filter Caching definition: cache=FilterCacheModeType.[MODE]
    * [HSEARCH-272] - Improve contention on DirectoryProviders in lucene backend
    * [HSEARCH-273] - Make LuceneOptions an interface
    * [HSEARCH-282] - Make the API more Generics friendly

** New Feature
    * [HSEARCH-170] - Support @Boost in @Field
    * [HSEARCH-235] - provide a destroy() method in ReaderProvider
    * [HSEARCH-252] - Document Solr integration
    * [HSEARCH-258] - Add configuration option for Lucene's UseCompoundFile

** Patch
    * [HSEARCH-20] - Lucene extensions

** Task
    * [HSEARCH-231] - Update the getting started guide with Solr analyzers
    * [HSEARCH-236] - Find whether or not indexWriter.optimize() requires an index lock
    * [HSEARCH-244] - Abiltiy to ask SearchFactory for the scoped analyzer of a given class
    * [HSEARCH-254] - Migrate to Solr 1.3
    * [HSEARCH-276] - upgrade to Lucene 2.4
    * [HSEARCH-286] - Align to GA versions of all dependencies
    * [HSEARCH-292] - Document the new Filter caching approach


3.1.0.Beta1 (17-07-2008)
------------------------

** Bug
    * [HSEARCH-166] - documentation error : hibernate.search.worker.batch_size vs hibernate.worker.batch_size
    * [HSEARCH-171] - Do not log missing objects when using QueryLoader
    * [HSEARCH-173] - CachingWrapperFilter loses its WeakReference making filter caching inefficient
    * [HSEARCH-194] - Inconsistent performance between hibernate search and pure lucene access
    * [HSEARCH-196] - ObjectNotFoundException not caught in FullTextSession
    * [HSEARCH-198] - Documentation out of sync with implemented/released features
    * [HSEARCH-203] - Counter of index modification operations not always incremented
    * [HSEARCH-204] - Improper calls to Session during a projection not involving THIS
    * [HSEARCH-205] - Out of Memory on copy of large indexes
    * [HSEARCH-217] - Proper errors on parsing of all numeric configuration parameters
    * [HSEARCH-227] - Criteria based fetching is not used when objects are loaded one by one (iterate())


** Improvement
    * [HSEARCH-19] - Do not filter classes on queries when we know that all Directories only contains the targeted classes
    * [HSEARCH-156] - Retrofit FieldBridge.set lucene parameters into a LuceneOptions class
    * [HSEARCH-157] - Make explicit in FAQ and doc that query.list() followed by query.getResultSize() triggers only one query
    * [HSEARCH-163] - Enhance error messages when @FieldBridge is wrongly used (no impl or impl not implementing the right interfaces)
    * [HSEARCH-176] - Permits alignment properties to lucene default (Sanne Grinovero)
    * [HSEARCH-179] - Documentation should be explicit that @FulltextFilter filters every object, regardless which object is annotated
    * [HSEARCH-181] - Better management of file-based index directories (Sanne Grinovero)
    * [HSEARCH-189] - Thread management improvements for Master/Slave DirectoryProviders
    * [HSEARCH-197] - Move to slf4j
    * [HSEARCH-199] - Property close Search resources on SessionFactory.close()
    * [HSEARCH-202] - Avoid many maps lookup in Workspace
    * [HSEARCH-207] - Make DateBridge TwoWay to facilitate projection
    * [HSEARCH-208] - Raise exception on index and purge when the entity is not an indexed entity
    * [HSEARCH-209] - merge FullTextIndexCollectionEventListener into FullTextIndexEventListener
    * [HSEARCH-215] - Rename Search.createFTS to Search.getFTS deprecating the old method
    * [HSEARCH-223] - Use multiple criteria queries rather than ObjectLoader in most cases
    * [HSEARCH-230] - Ensure initialization safety in a multi-core machine

** New Feature
    * [HSEARCH-133] - Allow overriding DefaultSimilarity for indexing and searching (Nick Vincent)
    * [HSEARCH-141] - Allow term position information to be stored in an index
    * [HSEARCH-153] - Provide the possibility to configure writer.setRAMBufferSizeMB()  (Lucene 2.3)
    * [HSEARCH-154] - Provide a facility to access Lucene query explanations
    * [HSEARCH-164] - Built-in bridge to index java.lang.Class
    * [HSEARCH-165] - URI and URL built-in bridges
    * [HSEARCH-174] - Improve transparent filter caching by wrapping filters into our own CachingWrapperFilter
    * [HSEARCH-186] - Enhance analyzer to support the Solr model
    * [HSEARCH-190] - Add pom
    * [HSEARCH-191] - Make build independent of Hibernate Core structure
    * [HSEARCH-192] - Move to Hibernate Core 3.3
    * [HSEARCH-193] - Use dependency on Solr-analyzer JAR rather than the full Solr JAR
    * [HSEARCH-195] - Expose Analyzers instance by name: searchFactory.getAnalyzer(String)
    * [HSEARCH-200] - Expose IndexWriter setting MAX_FIELD_LENGTH via IndexWriterSetting
    * [HSEARCH-212] - Added ReaderProvider strategy reusing unchanged segments (using reader.reopen())
    * [HSEARCH-220] - introduce session.flushToIndexes API and deprecate batch_size


** Task
    * [HSEARCH-169] - Migrate to Lucene 2.3.1 (index corruption possiblity in 2.3.0)
    * [HSEARCH-187] - Clarify which directories need read-write access, verify readonly behaviour on others.
    * [HSEARCH-214] - Upgrade Lucene to 2.3.2
    * [HSEARCH-229] - Deprecate FullTextQuery.BOOST


3.0.1.GA (20-02-2008)
---------------------

** Bug
    * [HSEARCH-56] - Updating a collection does not reindex
    * [HSEARCH-123] - Use mkdirs instead of mkdir to create necessary parent directory in the DirectoryProviderHelper
    * [HSEARCH-128] - Indexing embedded children's child
    * [HSEARCH-136] - CachingWrapperFilter does not cache
    * [HSEARCH-137] - Wrong class name in Exception when a FieldBridge does not implement TwoWayFieldBridge for a document id property
    * [HSEARCH-138] - JNDI Property names have first character cut off
    * [HSEARCH-140] - @IndexedEmbedded default depth is effectively 1 due to integer overflow
    * [HSEARCH-146] - ObjectLoader doesn't catch javax.persistence.EntityNotFoundException
    * [HSEARCH-149] - Default FieldBridge for enums passing wrong class to EnumBridge constructor


** Improvement
    * [HSEARCH-125] - Add support for fields declared by interface or unmapped superclass
    * [HSEARCH-127] - Wrong prefix for worker configurations
    * [HSEARCH-129] - IndexedEmbedded for Collections Documentation
    * [HSEARCH-130] - Should provide better log infos (on the indexBase parameter for the FSDirectoryProvider)
    * [HSEARCH-144] - Keep indexer running till finished on VM shutdown
    * [HSEARCH-147] - Allow projection of Lucene DocId

** New Feature
    * [HSEARCH-114] - Introduce ResultTransformer to the query API
    * [HSEARCH-150] - Migrate to Lucene 2.3

** Patch
    * [HSEARCH-126] - Better diagnostic when Search index directory cannot be opened (Ian)


3.0.0.GA (23-09-2007)
---------------------

** Bug
    * [HSEARCH-116] - FullTextEntityManager acessing getDelegate() in the constructor leads to NPE in JBoss AS + Seam
    * [HSEARCH-117] - FullTextEntityManagerImpl and others should implement Serializable

** Deprecation
    * [HSEARCH-122] - Remove query.setIndexProjection (replaced by query.setProjection)

** Improvement
    * [HSEARCH-118] - Add ClassBridges (plural) functionality

** New Feature
    * [HSEARCH-81] - Create a @ClassBridge Annotation (John Griffin)


** Task
    * [HSEARCH-98] - Add a Getting started section to the reference documentation


3.0.0.CR1 (4-09-2007)
---------------------

** Bug
    * [HSEARCH-108] - id of embedded object is not indexed when using @IndexedEmbedded
    * [HSEARCH-109] - Lazy loaded entity could not be indexed
    * [HSEARCH-110] - ScrollableResults does not obey out of bounds rules (John Griffin)
    * [HSEARCH-112] - Unkown @FullTextFilter  when attempting to associate a filter

** Deprecation
    * [HSEARCH-113] - Remove @Text, @Keyword and @Unstored (old mapping annotations)

** Improvement
    * [HSEARCH-107] - DirectoryProvider should have a start() method

** New Feature
    * [HSEARCH-14] - introduce fetch_size for Hibernate Search scrollable resultsets (John Griffin)
    * [HSEARCH-69] - Ability to purge an index by class (John Griffin)
    * [HSEARCH-111] - Ability to disable event based indexing (for read only or batch based indexing)


3.0.0.Beta4 (1-08-2007)
-----------------------

** Bug
    * [HSEARCH-88] - Unable to update 2 entity types in the same transaction if they share the same index
    * [HSEARCH-90] - Use of setFirstResult / setMaxResults can lead to a list with negative capacity (John Griffin)
    * [HSEARCH-92] - NPE for null fields on projection
    * [HSEARCH-99] - Avoid returning non initialized proxies in scroll() and iterate() (loader.load(EntityInfo))


** Improvement
    * [HSEARCH-79] - Recommend to use FlushMode.APPLICATION on massive indexing
    * [HSEARCH-84] - Migrate to Lucene 2.2
    * [HSEARCH-91] - Avoid wrapping a Session object if the Session is already FullTextSession
    * [HSEARCH-100] - Rename fullTextSession.setIndexProjection() to fullTextSession.setProjection()
    * [HSEARCH-102] - Default index operation in @Field to TOKENIZED
    * [HSEARCH-106] - Use the shared reader strategy as the default strategy

** New Feature
    * [HSEARCH-6] - Provide access to the Hit.getScore() and potentially the Document on a query
    * [HSEARCH-15] - Notion of Filtered Lucene queries (Hardy Ferentschik)
    * [HSEARCH-41] - Allow fine grained analyzers (Entity, attribute, @Field)
    * [HSEARCH-45] - Support @Fields() for multiple indexing per property (useful for sorting)
    * [HSEARCH-58] - Support named Filters (and caching)
    * [HSEARCH-67] - Expose mergeFactor, maxMergeDocs and minMergeDocs (Hardy Ferentschik)
    * [HSEARCH-73] - IncrementalOptimizerStrategy triggered on transactions or operations limits
    * [HSEARCH-74] - Ability to project Lucene meta information (Score, Boost, Document, Id, This) (John Griffin)
    * [HSEARCH-83] - Introduce OptimizerStrategy
    * [HSEARCH-86] - Index sharding: multiple Lucene indexes per entity type
    * [HSEARCH-89] - FullText wrapper for JPA APIs
    * [HSEARCH-103] - Ability to override the indexName in the FSDirectoryProviders family


** Task
    * [HSEARCH-94] - Deprecate ContextHelper


3.0.0.Beta3 (6-06-2007)
-----------------------

** Bug
    * [HSEARCH-64] - Exception Thrown If Index Directory Does Not Exist
    * [HSEARCH-66] - Some results not returned in some circumstances (Brandon Munroe)


** Improvement
    * [HSEARCH-60] - Introduce SearchFactory / SearchFactoryImpl
    * [HSEARCH-68] - Set index copy threads as daemon
    * [HSEARCH-70] - Create the index base directory if it does not exists

** New Feature
    * [HSEARCH-11] - Provide access to IndexWriter.optimize()
    * [HSEARCH-33] - hibernate.search.worker.batch_size to prevent OutOfMemoryException while inserting many objects
    * [HSEARCH-71] - Provide fullTextSession.getSearchFactory()
    * [HSEARCH-72] - searchFactory.optimize() and searchFactory.optimize(Class) (Andrew Hahn)


3.0.0.Beta2 (31-05-2007)
------------------------

** Bug
    * [HSEARCH-37] - Verify that Serializable return type are not resolved by StringBridge built in type
    * [HSEARCH-39] - event listener declaration example is wrong
    * [HSEARCH-44] - Build the Lucene Document in the beforeComplete transaction phase
    * [HSEARCH-50] - Null Booleans lead to NPE
    * [HSEARCH-59] - Unable to index @indexEmbedded object through session.index when object is lazy and field access is used in object


** Improvement
    * [HSEARCH-36] - Meaningful exception message when Search Listeners are not initialized
    * [HSEARCH-38] - Make the @IndexedEmbedded documentation example easier to understand
    * [HSEARCH-51] - Optimization: Use a query rather than batch-size to load objects when a single entity (hierarchy) is expected
    * [HSEARCH-63] - rename query.resultSize() to getResultSize()

** New Feature
    * [HSEARCH-4] - Be able to use a Lucene Sort on queries (Hardy Ferentschik)
    * [HSEARCH-13] - Cache IndexReaders per SearchFactory
    * [HSEARCH-40] - Be able to embed collections in lucene index (@IndexedEmbeddable in collections)
    * [HSEARCH-43] - Expose resultSize and do not load object when only resultSize is retrieved
    * [HSEARCH-52] - Ability to load more efficiently an object graph from a lucene query by customizing the fetch modes
    * [HSEARCH-53] - Add support for projection (ie read the data from the index only)
    * [HSEARCH-61] - Move from MultiSearcher to MultiReader
    * [HSEARCH-62] - Support pluggable ReaderProvider strategies
    

** Task
    * [HSEARCH-65] - Update to JBoss Embedded beta2


3.0.0.Beta1 (19-03-2007)
------------------------

Initial release as a standalone product (see Hibernate Annotations changelog for previous informations)


Release Notes - Hibernate Search - Version 3.0.0.beta1

** Bug
    * [HSEARCH-7] - Ignore object found in the index but no longer present in the database (for out of date indexes)
    * [HSEARCH-21] - NPE in SearchFactory while using different threads
    * [HSEARCH-22] - Enum value Index.UN_TOKENISED is misspelled
    * [HSEARCH-24] - Potential deadlock when using multiple DirectoryProviders in a highly concurrent index update
    * [HSEARCH-25] - Class cast exception in org.hibernate.search.impl.FullTextSessionImpl<init>(FullTextSessionImpl.java:54)
    * [HSEARCH-28] - Wrong indexDir property in Apache Lucene Integration


** Improvement
    * [HSEARCH-29] - Share the initialization state across all Search event listeners instance
    * [HSEARCH-30] - @FieldBridge now use o.h.s.a.Parameter rather than o.h.a.Parameter
    * [HSEARCH-31] - Move to Lucene 2.1.0

** New Feature
    * [HSEARCH-1] - Give access to Directory providers
    * [HSEARCH-2] - Default FieldBridge for enums (Sylvain Vieujot)
    * [HSEARCH-3] - Default FieldBridge for booleans (Sylvain Vieujot)
    * [HSEARCH-9] - Introduce a worker factory and its configuration
    * [HSEARCH-16] - Cluster capability through JMS
    * [HSEARCH-23] - Support asynchronous batch worker queue
    * [HSEARCH-27] - Ability to index associated / embedded objects