You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/08/27 19:31:24 UTC
svn commit: r1377758 - in /lucene/dev/trunk/lucene:
queries/src/java/org/apache/lucene/queries/function/valuesource/
queryparser/src/java/org/apache/lucene/queryparser/surround/query/
queryparser/src/java/org/apache/lucene/queryparser/xml/ spatial/src/...
Author: rmuir
Date: Mon Aug 27 17:31:23 2012
New Revision: 1377758
URL: http://svn.apache.org/viewvc?rev=1377758&view=rev
Log:
add more missing javadocs
Modified:
lucene/dev/trunk/lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/ShortFieldSource.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/DistanceSubQuery.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/FieldsQuery.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/NotQuery.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SimpleTerm.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndPrefixQuery.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndTermQuery.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java
lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/CachingDoubleValueSource.java
lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java
Modified: lucene/dev/trunk/lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/ShortFieldSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/ShortFieldSource.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/ShortFieldSource.java (original)
+++ lucene/dev/trunk/lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/ShortFieldSource.java Mon Aug 27 17:31:23 2012
@@ -25,8 +25,9 @@ import org.apache.lucene.search.FieldCac
/**
- *
- *
+ * Obtains short field values from the {@link org.apache.lucene.search.FieldCache}
+ * using <code>getShorts()</code>
+ * and makes those values available as other numeric types, casting as needed.
**/
public class ShortFieldSource extends FieldCacheSource {
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/DistanceSubQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/DistanceSubQuery.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/DistanceSubQuery.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/DistanceSubQuery.java Mon Aug 27 17:31:23 2012
@@ -18,6 +18,10 @@ package org.apache.lucene.queryparser.su
import java.io.IOException;
+/**
+ * Interface for queries that can be nested as subqueries
+ * into a span near.
+ */
public interface DistanceSubQuery {
/** When distanceSubQueryNotAllowed() returns non null, the reason why the subquery
* is not allowed as a distance subquery is returned.
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/FieldsQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/FieldsQuery.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/FieldsQuery.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/FieldsQuery.java Mon Aug 27 17:31:23 2012
@@ -22,6 +22,9 @@ import java.util.Iterator;
import org.apache.lucene.search.Query;
+/**
+ * Forms an OR query of the provided query across multiple fields.
+ */
public class FieldsQuery extends SrndQuery { /* mostly untested */
private SrndQuery q;
private List<String> fieldNames;
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/NotQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/NotQuery.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/NotQuery.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/NotQuery.java Mon Aug 27 17:31:23 2012
@@ -21,6 +21,9 @@ import org.apache.lucene.search.Query;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.BooleanClause;
+/**
+ * Factory for prohibited clauses
+ */
public class NotQuery extends ComposedQuery {
public NotQuery(List<SrndQuery> queries, String opName) { super(queries, true /* infix */, opName); }
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SimpleTerm.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SimpleTerm.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SimpleTerm.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SimpleTerm.java Mon Aug 27 17:31:23 2012
@@ -22,6 +22,9 @@ import org.apache.lucene.index.IndexRead
import org.apache.lucene.index.Term;
import org.apache.lucene.search.Query;
+/**
+ * Base class for queries that expand to sets of simple terms.
+ */
public abstract class SimpleTerm
extends SrndQuery
implements DistanceSubQuery, Comparable<SimpleTerm>
@@ -67,6 +70,10 @@ public abstract class SimpleTerm
String fieldName,
MatchingTermVisitor mtv) throws IOException;
+ /**
+ * Callback to visit each matching term during "rewrite"
+ * in {@link #visitMatchingTerm(Term)}
+ */
public interface MatchingTermVisitor {
void visitMatchingTerm(Term t)throws IOException;
}
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndPrefixQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndPrefixQuery.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndPrefixQuery.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndPrefixQuery.java Mon Aug 27 17:31:23 2012
@@ -27,6 +27,9 @@ import org.apache.lucene.index.MultiFiel
import java.io.IOException;
+/**
+ * Query that matches String prefixes
+ */
public class SrndPrefixQuery extends SimpleTerm {
private final BytesRef prefixRef;
public SrndPrefixQuery(String prefix, boolean quoted, char truncator) {
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndTermQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndTermQuery.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndTermQuery.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndTermQuery.java Mon Aug 27 17:31:23 2012
@@ -26,6 +26,9 @@ import org.apache.lucene.index.MultiFiel
import org.apache.lucene.util.BytesRef;
+/**
+ * Simple single-term clause
+ */
public class SrndTermQuery extends SimpleTerm {
public SrndTermQuery(String termText, boolean quoted) {
super(quoted);
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java Mon Aug 27 17:31:23 2012
@@ -22,7 +22,9 @@ import org.apache.lucene.queryparser.xml
*/
/**
- *
+ * Assembles a QueryBuilder which uses Query objects from
+ * Lucene's <code>sandbox</code> and <code>queries</code>
+ * modules in addition to core queries.
*/
public class CorePlusExtensionsParser extends CoreParser {
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java Mon Aug 27 17:31:23 2012
@@ -26,7 +26,7 @@ import java.io.Reader;
*/
/**
- *
+ * Helper methods for parsing XML
*/
public class DOMUtils {
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java Mon Aug 27 17:31:23 2012
@@ -20,7 +20,8 @@ package org.apache.lucene.queryparser.xm
*/
/**
- *
+ * Thrown when the xml queryparser encounters
+ * invalid syntax/configuration.
*/
public class ParserException extends Exception {
Modified: lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/CachingDoubleValueSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/CachingDoubleValueSource.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/CachingDoubleValueSource.java (original)
+++ lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/CachingDoubleValueSource.java Mon Aug 27 17:31:23 2012
@@ -26,6 +26,8 @@ import java.util.HashMap;
import java.util.Map;
/**
+ * Caches the doubleVal of another value source in a HashMap
+ * so that it is computed only once.
* @lucene.internal
*/
public class CachingDoubleValueSource extends ValueSource {
Modified: lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java?rev=1377758&r1=1377757&r2=1377758&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java (original)
+++ lucene/dev/trunk/lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java Mon Aug 27 17:31:23 2012
@@ -28,6 +28,8 @@ import org.apache.lucene.util.Bits;
import java.io.IOException;
/**
+ * Filter that matches all documents where a valuesource is
+ * in between a range of <code>min</code> and <code>max</code>
* @lucene.internal
*/
public class ValueSourceFilter extends Filter {