svn commit: r949311 - in /lucene/dev/trunk/lucene/src/java/org/apache/lucene/search: CachingWrapperFilter.java ConstantScoreQuery.java

[mi...@apache.org]

Author: mikemccand
Date: Fri May 28 22:24:39 2010
New Revision: 949311

URL: http://svn.apache.org/viewvc?rev=949311&view=rev
Log:
LUCENE-2468: strengthen javadocs

Modified:
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingWrapperFilter.java
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/ConstantScoreQuery.java

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingWrapperFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingWrapperFilter.java?rev=949311&r1=949310&r2=949311&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingWrapperFilter.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingWrapperFilter.java Fri May 28 22:24:39 2010
@@ -29,7 +29,13 @@ import org.apache.lucene.util.Bits;
 
 /**
  * Wraps another filter's result and caches it.  The purpose is to allow
- * filters to simply filter, and then wrap with this class to add caching.
+ * filters to simply filter, and then wrap with this class
+ * to add caching.
+ *
+ * <p><b>NOTE</b>: if you wrap this filter as a query (eg,
+ * using ConstantScoreQuery), you'll likely want to enforce
+ * deletions (using either {@link DeletesMode#RECACHE} or
+ * {@link DeletesMode#DYNAMIC}).
  */
 public class CachingWrapperFilter extends Filter {
   Filter filter;

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/ConstantScoreQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/ConstantScoreQuery.java?rev=949311&r1=949310&r2=949311&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/ConstantScoreQuery.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/ConstantScoreQuery.java Fri May 28 22:24:39 2010
@@ -26,6 +26,12 @@ import java.util.Set;
 /**
  * A query that wraps a filter and simply returns a constant score equal to the
  * query boost for every document in the filter.
+ *
+ * <p><b>NOTE</b>: if the wrapped filter is an instance of
+ * {@link CachingWrapperFilter}, you'll likely want to
+ * enforce deletions in the filter (using either {@link
+ * CachingWrapperFilter.DeletesMode#RECACHE} or {@link
+ * CachingWrapperFilter.DeletesMode#DYNAMIC}).
  */
 public class ConstantScoreQuery extends Query {
   protected final Filter filter;