[hibernate-commits] Hibernate SVN: r14915 - in search/trunk/src/java/org/hibernate/search: engine and 1 other directories.

[hibernate-commits at lists.jboss.org]

Author: hardy.ferentschik
Date: 2008-07-10 11:14:20 -0400 (Thu, 10 Jul 2008)
New Revision: 14915

Added:
   search/trunk/src/java/org/hibernate/search/annotations/CacheBitResults.java
Removed:
   search/trunk/src/java/org/hibernate/search/annotations/CachingWrapperFilter.java
Modified:
   search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java
   search/trunk/src/java/org/hibernate/search/engine/FilterDef.java
   search/trunk/src/java/org/hibernate/search/query/FullTextQueryImpl.java
Log:
HSEARCH-174:
- Renamed enum CachingWrapperFilter to CacheBitResults
- updated javadoc

Added: search/trunk/src/java/org/hibernate/search/annotations/CacheBitResults.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/CacheBitResults.java	                        (rev 0)
+++ search/trunk/src/java/org/hibernate/search/annotations/CacheBitResults.java	2008-07-10 15:14:20 UTC (rev 14915)
@@ -0,0 +1,28 @@
+// $Id:$
+package org.hibernate.search.annotations;
+
+/**
+ * Defines the strategy for using <code>CachingWrappingFilter</code>
+ * 
+ * @author Hardy Ferentschik
+ * @see org.hibernate.search.filter.CachingWrapperFilter
+ */
+public enum CacheBitResults {
+	/**
+	 * Use a <code>CachingWrapperFilter<code> depending on the value of the <code>cache</code>
+	 * parameter of the filter definition. If <code>cache == true</code> a wrapping filter will 
+	 * be used, otherwise not.
+	 * @see FullTextFilterDef#cache()
+	 */
+	AUTOMATIC,
+	
+	/**
+	 * Wrap the filter around a <code>CachingWrappingFilter</code>.
+	 */
+	YES,
+	
+	/**
+	 * Do not use a <code>CachingWrappingFilter</code>.
+	 */
+	NO;
+}
\ No newline at end of file


Property changes on: search/trunk/src/java/org/hibernate/search/annotations/CacheBitResults.java
___________________________________________________________________
Name: svn:keywords
   + Id

Deleted: search/trunk/src/java/org/hibernate/search/annotations/CachingWrapperFilter.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/CachingWrapperFilter.java	2008-07-10 14:14:26 UTC (rev 14914)
+++ search/trunk/src/java/org/hibernate/search/annotations/CachingWrapperFilter.java	2008-07-10 15:14:20 UTC (rev 14915)
@@ -1,26 +0,0 @@
-// $Id:$
-package org.hibernate.search.annotations;
-
-/**
- * Defines the strategy for using <code>CachingWrappingFilter</code>
- * 
- * @author Hardy Ferentschik
- * @see org.hibernate.search.filter.CachingWrapperFilter
- */
-public enum CachingWrapperFilter {
-	/**
-	 * Use a <code>CachingWrapperFilter<code> depending on the value of
-	 * @see FullTextFilterDef#cache()
-	 */
-	AUTOMATIC,
-	
-	/**
-	 * Wrap the filter around a <code>CachingWrappingFilter</code>.
-	 */
-	YES,
-	
-	/**
-	 * Do not use a <code>CachingWrappingFilter</code>.
-	 */
-	NO;
-}
\ No newline at end of file

Modified: search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java	2008-07-10 14:14:26 UTC (rev 14914)
+++ search/trunk/src/java/org/hibernate/search/annotations/FullTextFilterDef.java	2008-07-10 15:14:20 UTC (rev 14915)
@@ -42,5 +42,5 @@
 	/**
 	 * Determines whether the filter should be wrapped around a <code>CachingWrapperFilter</code>.
 	 */	
-	CachingWrapperFilter useCachingWrapperFilter() default CachingWrapperFilter.AUTOMATIC;
+	CacheBitResults useCachingWrapperFilter() default CacheBitResults.AUTOMATIC;
 }

Modified: search/trunk/src/java/org/hibernate/search/engine/FilterDef.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/engine/FilterDef.java	2008-07-10 14:14:26 UTC (rev 14914)
+++ search/trunk/src/java/org/hibernate/search/engine/FilterDef.java	2008-07-10 15:14:20 UTC (rev 14915)
@@ -7,7 +7,7 @@
 import java.util.Map;
 
 import org.hibernate.search.SearchException;
-import org.hibernate.search.annotations.CachingWrapperFilter;
+import org.hibernate.search.annotations.CacheBitResults;
 
 /**
  * A wrapper class which encapsualtes all required information to create a defined filter.
@@ -22,14 +22,14 @@
 	private Method keyMethod;
 	private Map<String, Method> setters = new HashMap<String, Method>();
 	private boolean cache;
-	private CachingWrapperFilter useCachingWrapperFilter;
+	private CacheBitResults useCachingWrapperFilter;
 
-	public CachingWrapperFilter getUseCachingWrapperFilter() {
+	public CacheBitResults getUseCachingWrapperFilter() {
 		return useCachingWrapperFilter;
 	}
 
 	public void setUseCachingWrapperFilter(
-			CachingWrapperFilter useCachingWrapperFilter) {
+			CacheBitResults useCachingWrapperFilter) {
 		this.useCachingWrapperFilter = useCachingWrapperFilter;
 	}
 

Modified: search/trunk/src/java/org/hibernate/search/query/FullTextQueryImpl.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/query/FullTextQueryImpl.java	2008-07-10 14:14:26 UTC (rev 14914)
+++ search/trunk/src/java/org/hibernate/search/query/FullTextQueryImpl.java	2008-07-10 15:14:20 UTC (rev 14915)
@@ -40,7 +40,7 @@
 import org.hibernate.search.FullTextFilter;
 import org.hibernate.search.FullTextQuery;
 import org.hibernate.search.SearchException;
-import org.hibernate.search.annotations.CachingWrapperFilter;
+import org.hibernate.search.annotations.CacheBitResults;
 import org.hibernate.search.engine.DocumentBuilder;
 import org.hibernate.search.engine.DocumentExtractor;
 import org.hibernate.search.engine.EntityInfo;
@@ -382,8 +382,8 @@
 	 * <code>def</code>.
 	 */
 	private Filter addCachingWrapperFilter(Filter filter, FilterDef def) {
-		if (def.getUseCachingWrapperFilter() == CachingWrapperFilter.YES
-				|| (def.getUseCachingWrapperFilter() == CachingWrapperFilter.AUTOMATIC && def
+		if (def.getUseCachingWrapperFilter() == CacheBitResults.YES
+				|| (def.getUseCachingWrapperFilter() == CacheBitResults.AUTOMATIC && def
 						.isCache())) {
 			int cachingWrapperFilterSize = getSearchFactoryImplementor().getCachingWrapperFilterSize();
 			filter = new org.hibernate.search.filter.CachingWrapperFilter(filter, cachingWrapperFilterSize);