dnaber 2004/11/23 12:56:06
Modified: src/java/org/apache/lucene/search RangeFilter.java
Log:
some small javadoc improvements
Revision Changes Path
1.2 +9 -8
jakarta-lucene/src/java/org/apache/lucene/search/RangeFilter.java
Index: RangeFilter.java
===================================================================
RCS file:
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/RangeFilter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RangeFilter.java 23 Nov 2004 14:17:18 -0000 1.1
+++ RangeFilter.java 23 Nov 2004 20:56:06 -0000 1.2
@@ -1,7 +1,5 @@
package org.apache.lucene.search;
-
-
/**
* Copyright 2004 The Apache Software Foundation
*
@@ -32,8 +30,8 @@
* field.
*
* <p>
- * This code borrows heavily from [EMAIL PROTECTED] RangeQuery}, but
implemented as a Filter
- * (much like [EMAIL PROTECTED] DateFilter})
+ * This code borrows heavily from [EMAIL PROTECTED] RangeQuery}, but is
implemented as a Filter
+ * (much like [EMAIL PROTECTED] DateFilter}).
* </p>
*/
public class RangeFilter extends Filter {
@@ -50,6 +48,9 @@
* @param upperTerm The upper bound on this range
* @param includeLower Does this range include the lower bound?
* @param includeUpper Does this range include the upper bound?
+ * @throws IllegalArgumentException if both terms are null or if
+ * lowerTerm is null and includeLower is true (similar for upperTerm
+ * and includeUpper)
*/
public RangeFilter(String fieldName, String lowerTerm, String upperTerm,
boolean includeLower, boolean includeUpper) {
@@ -74,16 +75,16 @@
}
/**
- * Constructs a filter for field <code>field</code> matching
- * less than or equal to <code>value</code>
+ * Constructs a filter for field <code>fieldName</code> matching
+ * less than or equal to <code>upperTerm</code>.
*/
public static RangeFilter Less(String fieldName, String upperTerm) {
return new RangeFilter(fieldName, null, upperTerm, false, true);
}
/**
- * Constructs a filter for field <code>field</code> matching
- * greater than or equal to <code>lower</code>
+ * Constructs a filter for field <code>fieldName</code> matching
+ * greater than or equal to <code>lowerTerm</code>.
*/
public static RangeFilter More(String fieldName, String lowerTerm) {
return new RangeFilter(fieldName, lowerTerm, null, true, false);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
