LUCENE-6245: Force Filter subclasses to implement toString API from Query

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1659982 13f79535-47bb-0310-9956-ffa450edef68

lucene/CHANGES.txt

@@ -117,6 +117,9 @@ API Changes
 * LUCENE-1518: Make Filter extend Query and return 0 as score.
   (Uwe Schindler, Adrien Grand)
 
+* LUCENE-6245: Force Filter subclasses to implement toString API from Query.
+  (Ryan Ernst)
+
 Other
 
 * LUCENE-6193: Collapse identical catch branches in try-catch statements.

lucene/core/src/java/org/apache/lucene/search/DocTermOrdsRewriteMethod.java

@@ -55,9 +55,9 @@ public final class DocTermOrdsRewriteMethod extends MultiTermQuery.RewriteMethod
     }
     
     @Override
-    public String toString() {
+    public String toString(String field) {
       // query.toString should be ok for the filter, too, if the query boost is 1.0f
-      return query.toString();
+      return query.toString(field);
     }
     
     @Override

lucene/core/src/java/org/apache/lucene/search/DocValuesRewriteMethod.java

@@ -55,9 +55,9 @@ public final class DocValuesRewriteMethod extends MultiTermQuery.RewriteMethod {
     }
     
     @Override
-    public String toString() {
+    public String toString(String field) {
       // query.toString should be ok for the filter, too, if the query boost is 1.0f
-      return query.toString();
+      return query.toString(field);
     }
     
     @Override

lucene/core/src/java/org/apache/lucene/search/Filter.java

@@ -75,11 +75,6 @@ public abstract class Filter extends Query {
     return System.identityHashCode(this);
   }
 
-  @Override
-  public String toString(String field) {
-    return getClass().getSimpleName();
-  }
-
   @Override
   public Weight createWeight(IndexSearcher searcher, boolean needsScores) throws IOException {
     return new Weight(this) {

lucene/core/src/java/org/apache/lucene/search/MultiTermQueryWrapperFilter.java

@@ -52,9 +52,9 @@ public class MultiTermQueryWrapperFilter<Q extends MultiTermQuery> extends Filte
   }
 
   @Override
-  public String toString() {
+  public String toString(String field) {
     // query.toString should be ok for the filter, too, if the query boost is 1.0f
-    return query.toString();
+    return query.toString(field);
   }
 
   @Override

lucene/core/src/java/org/apache/lucene/search/PrefixFilter.java

@@ -31,9 +31,9 @@ public class PrefixFilter extends MultiTermQueryWrapperFilter<PrefixQuery> {
 
   public Term getPrefix() { return query.getPrefix(); }
 
-  /** Prints a user-readable version of this query. */
+  /** Prints a user-readable version of this filter. */
   @Override
-  public String toString () {
+  public String toString(String field) {
     StringBuilder buffer = new StringBuilder();
     buffer.append("PrefixFilter(");
     buffer.append(getPrefix().toString());

lucene/core/src/java/org/apache/lucene/search/Query.java

@@ -65,7 +65,7 @@ public abstract class Query implements Cloneable {
 
   /** Prints a query to a string. */
   @Override
-  public String toString() {
+  public final String toString() {
     return toString("");
   }
 

lucene/core/src/test/org/apache/lucene/search/JustCompileSearch.java

@@ -137,6 +137,11 @@ final class JustCompileSearch {
     public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
       return null;
     }
+
+    @Override
+    public String toString(String field) {
+      return "JustCompileFilter";
+    }
   }
 
   static final class JustCompileFilteredDocIdSet extends FilteredDocIdSet {

lucene/core/src/test/org/apache/lucene/search/MockFilter.java

@@ -32,6 +32,11 @@ public class MockFilter extends Filter {
     return new BitDocIdSet(bits);
   }
 
+  @Override
+  public String toString(String field) {
+    return "MockFilter";
+  }
+
   public void clear() {
     wasCalled = false;
   }

lucene/core/src/test/org/apache/lucene/search/SingleDocTestFilter.java

@@ -38,4 +38,9 @@ public class SingleDocTestFilter extends Filter {
     if (acceptDocs != null && !acceptDocs.get(doc)) bits.clear(doc);
     return new BitDocIdSet(bits);
   }
+
+  @Override
+  public String toString(String field) {
+    return "SingleDocTestFilter(" + doc + ")";
+  }
 }

lucene/core/src/test/org/apache/lucene/search/TestCachingWrapperFilter.java

@@ -181,6 +181,10 @@ public class TestCachingWrapperFilter extends LuceneTestCase {
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
         return null;
       }
+      @Override
+      public String toString(String field) {
+        return "nullDocIdSetFilter";
+      }
     };
     CachingWrapperFilter cacher = new CachingWrapperFilter(filter, MAYBE_CACHE_POLICY);
 
@@ -214,6 +218,10 @@ public class TestCachingWrapperFilter extends LuceneTestCase {
           }
         };
       }
+      @Override
+      public String toString(String field) {
+        return "nullDocIdSetIteratorFilter";
+      }
     };
     CachingWrapperFilter cacher = new CachingWrapperFilter(filter, FilterCachingPolicy.ALWAYS_CACHE);
 
@@ -267,6 +275,10 @@ public class TestCachingWrapperFilter extends LuceneTestCase {
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
         return new BitDocIdSet(new FixedBitSet(context.reader().maxDoc()));
       }
+      @Override
+      public String toString(String field) {
+        return "cacheableFilter";
+      }
     }, true);
 
     reader.close();

lucene/core/src/test/org/apache/lucene/search/TestDocIdSet.java

@@ -127,6 +127,10 @@ public class TestDocIdSet extends LuceneTestCase {
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
         return null;
       }
+      @Override
+      public String toString(String field) {
+        return "nullDocIdSetFilter";
+      }
     };
     
     Assert.assertEquals(0, searcher.search(new MatchAllDocsQuery(), f, 10).totalHits);
@@ -169,6 +173,10 @@ public class TestDocIdSet extends LuceneTestCase {
           }
         };
       }
+      @Override
+      public String toString(String field) {
+        return "nullDocIdSetFilter";
+      }
     };
     
     Assert.assertEquals(0, searcher.search(new MatchAllDocsQuery(), f, 10).totalHits);

lucene/core/src/test/org/apache/lucene/search/TestFilteredQuery.java

@@ -113,6 +113,10 @@ public class TestFilteredQuery extends LuceneTestCase {
         if (acceptDocs.get(3)) bitset.set(3);
         return new BitDocIdSet(bitset);
       }
+      @Override
+      public String toString(String field) {
+        return "staticFilterB";
+      }
     };
   }
 
@@ -194,6 +198,10 @@ public class TestFilteredQuery extends LuceneTestCase {
         bitset.set(0, Math.min(5, bitset.length()));
         return new BitDocIdSet(bitset);
       }
+      @Override
+      public String toString(String field) {
+        return "staticFilterA";
+      }
     };
   }
   
@@ -480,6 +488,10 @@ public class TestFilteredQuery extends LuceneTestCase {
               
             };
           }
+          @Override
+          public String toString(String field) {
+            return "filterField0";
+          }
         }, FilteredQuery.QUERY_FIRST_FILTER_STRATEGY);
     
     TopDocs search = searcher.search(query, 10);
@@ -559,7 +571,13 @@ public class TestFilteredQuery extends LuceneTestCase {
             };
           }
           
+          
         };
+        
+      }
+      @Override
+      public String toString(String field) {
+        return "filterField0";
       }
         }, queryFirst ? FilteredQuery.LEAP_FROG_QUERY_FIRST_STRATEGY : random()
             .nextBoolean() ? FilteredQuery.RANDOM_ACCESS_FILTER_STRATEGY

lucene/core/src/test/org/apache/lucene/search/TestFilteredSearch.java

@@ -101,6 +101,11 @@ public class TestFilteredSearch extends LuceneTestCase {
       }
       return set.cardinality() == 0 ? null : new BitDocIdSet(set);
     }
+
+    @Override
+    public String toString(String field) {
+      return "SimpleDocIdSetFilter";
+    }
   }
 
 }

lucene/core/src/test/org/apache/lucene/search/TestLRUFilterCache.java

@@ -350,6 +350,11 @@ public class TestLRUFilterCache extends LuceneTestCase {
       return null;
     }
 
+    @Override
+    public String toString(String field) {
+      return "DummyFilter";
+    }
+
   }
 
   // Test what happens when the cache contains only filters and doc id sets

lucene/core/src/test/org/apache/lucene/search/TestScorerPerf.java

@@ -149,6 +149,10 @@ public class TestScorerPerf extends LuceneTestCase {
         assertNull("acceptDocs should be null, as we have an index without deletions", acceptDocs);
         return new BitDocIdSet(rnd);
       }
+      @Override
+      public String toString(String field) {
+        return "randomBitSetFilter";
+      }
     });
     bq.add(q, BooleanClause.Occur.MUST);
     if (validate) {

lucene/core/src/test/org/apache/lucene/search/TestSortRandom.java

@@ -263,5 +263,10 @@ public class TestSortRandom extends LuceneTestCase {
 
       return new BitDocIdSet(bits);
     }
+
+    @Override
+    public String toString(String field) {
+      return "RandomFilter(density=" + density + ")";
+    }
   }
 }

lucene/facet/src/java/org/apache/lucene/facet/range/DoubleRange.java

@@ -105,7 +105,7 @@ public final class DoubleRange extends Range {
     return new Filter() {
 
       @Override
-      public String toString() {
+      public String toString(String field) {
         return "Filter(" + DoubleRange.this.toString() + ")";
       }
 

lucene/facet/src/java/org/apache/lucene/facet/range/LongRange.java

@@ -97,7 +97,7 @@ public final class LongRange extends Range {
     return new Filter() {
 
       @Override
-      public String toString() {
+      public String toString(String field) {
         return "Filter(" + LongRange.this.toString() + ")";
       }
 

lucene/facet/src/test/org/apache/lucene/facet/TestDrillSideways.java

@@ -660,6 +660,10 @@ public class TestDrillSideways extends FacetTestCase {
               }
               return new BitDocIdSet(bits);
             }
+            @Override
+            public String toString(String field) {
+              return "drillSidewaysTestFilter";
+            }
           };
       } else {
         filter = null;

lucene/highlighter/src/test/org/apache/lucene/search/vectorhighlight/FieldQueryTest.java

@@ -943,6 +943,10 @@ public class FieldQueryTest extends AbstractTestCase {
           throws IOException {
         return null;
       }
+      @Override
+      public String toString(String field) {
+        return "filterToBeFlattened";
+      }
     });
     query.setBoost(boost);
     FieldQuery fq = new FieldQuery( query, true, true );

lucene/join/src/java/org/apache/lucene/search/join/BitDocIdSetCachingWrapperFilter.java

@@ -81,7 +81,7 @@ public class BitDocIdSetCachingWrapperFilter extends BitDocIdSetFilter implement
   }
 
   @Override
-  public String toString() {
+  public String toString(String field) {
     return filter.toString();
   }
 

lucene/misc/src/test/org/apache/lucene/uninverting/TestFieldCacheSortRandom.java

@@ -293,5 +293,10 @@ public class TestFieldCacheSortRandom extends LuceneTestCase {
 
       return new BitDocIdSet(bits);
     }
+
+    @Override
+    public String toString(String field) {
+      return "RandomFilter(density=" + density + ")";
+    }
   }
 }

lucene/queries/src/test/org/apache/lucene/queries/BooleanFilterTest.java

@@ -96,6 +96,10 @@ public class BooleanFilterTest extends LuceneTestCase {
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
         return new BitDocIdSet(new FixedBitSet(context.reader().maxDoc()));
       }
+      @Override
+      public String toString(String field) {
+        return "emptyFilter";
+      }
     };
   }
 
@@ -105,6 +109,10 @@ public class BooleanFilterTest extends LuceneTestCase {
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
         return null;
       }
+      @Override
+      public String toString(String field) {
+        return "nullDISFilter";
+      }
     };
   }
 
@@ -114,6 +122,10 @@ public class BooleanFilterTest extends LuceneTestCase {
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
         return DocIdSet.EMPTY;
       }
+      @Override
+      public String toString(String field) {
+        return "nullDISIFilter";
+      }
     };
   }
 

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/RewriteQuery.java

@@ -37,15 +37,10 @@ abstract class RewriteQuery<SQ extends SrndQuery> extends Query {
   @Override
   abstract public Query rewrite(IndexReader reader) throws IOException;
 
-  @Override
-  public String toString() {
-    return toString(null);
-  }
-
   @Override
   public String toString(String field) {
     return getClass().getName()
-    + (field == null ? "" : "(unused: " + field + ")")
+    + (field.isEmpty() ? "" : "(unused: " + field + ")")
     + "(" + fieldName
     + ", " + srndQuery.toString()
     + ", " + qf.toString()

lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/NumericRangeFilterBuilder.java

@@ -159,5 +159,10 @@ public class NumericRangeFilterBuilder implements FilterBuilder {
       return null;
     }
 
+
+    @Override
+    public String toString(String field) {
+      return "NoMatchFilter()";
+    }
   }
 }

lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/DuplicateFilter.java

@@ -205,6 +205,15 @@ public class DuplicateFilter extends Filter {
         fieldName != null && fieldName.equals(other.fieldName);
   }
 
+  @Override
+  public String toString(String field) {
+    return "DuplicateFilter(" +
+              "fieldName=" + fieldName +"," +
+              "keepMode=" + (keepMode == KeepMode.KM_USE_FIRST_OCCURRENCE ? "first" : "last") + "," +
+              "processingMode=" + (processingMode == ProcessingMode.PM_FAST_INVALIDATION ? "fast" : "full") +
+           ")";
+  }
+
   @Override
   public int hashCode() {
     int hash = 217;

lucene/sandbox/src/test/org/apache/lucene/search/TestTermAutomatonQuery.java

@@ -643,5 +643,10 @@ public class TestTermAutomatonQuery extends LuceneTestCase {
 
       return new BitDocIdSet(bits);
     }
+
+    @Override
+    public String toString(String field) {
+      return "RandomFilter(seed=" + seed + ",density=" + density + ")";
+    }
   }
 }

lucene/spatial/src/java/org/apache/lucene/spatial/prefix/ContainsPrefixTreeFilter.java

@@ -74,6 +74,16 @@ public class ContainsPrefixTreeFilter extends AbstractPrefixTreeFilter {
     return super.hashCode() + (multiOverlappingIndexedShapes ? 1 : 0);
   }
 
+  @Override
+  public String toString(String field) {
+    return "ContainsPrefixTreeFilter(" +
+        // TODO: print something about the shape?
+        "fieldName=" + fieldName + "," +
+        "detailLevel=" + detailLevel + "," +
+        "multiOverlappingIndexedShapes=" + multiOverlappingIndexedShapes +
+        ")";
+  }
+
   @Override
   public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) throws IOException {
     return new ContainsVisitor(context, acceptDocs).visit(grid.getWorldCell(), acceptDocs);

lucene/spatial/src/java/org/apache/lucene/spatial/prefix/IntersectsPrefixTreeFilter.java

@@ -84,4 +84,15 @@ public class IntersectsPrefixTreeFilter extends AbstractVisitingPrefixTreeFilter
     }.getDocIdSet();
   }
 
+  @Override
+  public String toString(String field) {
+    return "IntersectsPrefixTreeFilter(" +
+        // TODO: print something about the shape?
+        "fieldName=" + fieldName + "," +
+        "detailLevel=" + detailLevel + "," +
+        "prefixGridScanLevel=" + prefixGridScanLevel + "," +
+        "hasIndexedLeaves=" + hasIndexedLeaves +
+        ")";
+  }
+
 }

lucene/spatial/src/java/org/apache/lucene/spatial/prefix/PrefixTreeFacetCounter.java

@@ -116,6 +116,11 @@ public class PrefixTreeFacetCounter {
     // traversal code.  TODO consider refactoring if/when it makes sense (more use cases than this)
     new AbstractVisitingPrefixTreeFilter(queryShape, strategy.getFieldName(), tree, facetLevel, scanLevel,
         !strategy.isPointsOnly()) {
+      
+      @Override
+      public String toString(String field) {
+        return "anonPrefixTreeFilter";
+      }
 
       @Override
       public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) throws IOException {

lucene/spatial/src/java/org/apache/lucene/spatial/prefix/WithinPrefixTreeFilter.java

@@ -90,6 +90,17 @@ public class WithinPrefixTreeFilter extends AbstractVisitingPrefixTreeFilter {
     result = 31 * result + (bufferedQueryShape != null ? bufferedQueryShape.hashCode() : 0);
     return result;
   }
+  
+  @Override
+  public String toString(String field) {
+    return "WithinPrefixTreeFilter(" +
+             // TODO: print something about the shape?
+             "fieldName=" + fieldName + "," +
+             "detailLevel=" + detailLevel + "," +
+             "prefixGridScanLevel=" + prefixGridScanLevel + "," +
+             "hasIndexedLeaves=" + hasIndexedLeaves +
+           ")";
+  }
 
   /** Returns a new shape that is larger than shape by at distErr.
    */

lucene/spatial/src/java/org/apache/lucene/spatial/serialized/SerializedDVStrategy.java

@@ -196,6 +196,13 @@ public class SerializedDVStrategy extends SpatialStrategy {
     public int hashCode() {
       return predicateValueSource.hashCode();
     }
+    
+    @Override
+    public String toString(String field) {
+      return "PredicateValueSourceFilter(" +
+               predicateValueSource.toString() +
+             ")";
+    }
   }//PredicateValueSourceFilter
 
   /**

lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java

@@ -62,4 +62,14 @@ public class ValueSourceFilter extends Filter {
       }
     };
   }
+
+  @Override
+  public String toString(String field) {
+    return "ValueSourceFilter(" +
+             "startingFilter=" + startingFilter.toString(field) + "," +
+             "source=" + source.toString() + "," +
+             "min=" + min + "," +
+             "max=" + max +
+           ")";
+  }
 }

solr/core/src/java/org/apache/solr/search/BitDocSet.java

@@ -358,6 +358,10 @@ public class BitDocSet extends DocSetBase {
 
         }, acceptDocs2);
       }
+      @Override
+      public String toString(String field) {
+        return "BitSetDocTopFilter";
+      }
     };
   }
 }

solr/core/src/java/org/apache/solr/search/DocSetBase.java

@@ -229,6 +229,10 @@ abstract class DocSetBase implements DocSet {
 
         }, acceptDocs2);
       }
+      @Override
+      public String toString(String field) {
+        return "DocSetTopFilter";
+      }
     };
   }
 

solr/core/src/java/org/apache/solr/search/ReRankQParserPlugin.java

@@ -150,6 +150,7 @@ public class ReRankQParserPlugin extends QParserPlugin {
       return new ReRankCollector(reRankDocs, length, reRankQuery, reRankWeight, cmd, searcher, boostedPriority);
     }
 
+    @Override
     public String toString(String s) {
       return "{!rerank mainQuery='"+mainQuery.toString()+
              "' reRankQuery='"+reRankQuery.toString()+
@@ -157,10 +158,6 @@ public class ReRankQParserPlugin extends QParserPlugin {
              " reRankWeigh="+reRankWeight+"}";
     }
 
-    public String toString() {
-      return toString(null);
-    }
-
     public Query rewrite(IndexReader reader) throws IOException {
       return wrap(this.mainQuery.rewrite(reader));
 

solr/core/src/java/org/apache/solr/search/SolrIndexSearcher.java

@@ -2456,6 +2456,11 @@ class FilterImpl extends Filter {
     return new FilterSet(sub, context);
   }
 
+  @Override
+  public String toString(String field) {
+    return "SolrFilter";
+  }
+
   private class FilterSet extends DocIdSet {
     DocIdSet docIdSet;
     LeafReaderContext context;

solr/core/src/java/org/apache/solr/search/SortedIntDocSet.java

@@ -779,6 +779,10 @@ public class SortedIntDocSet extends DocSetBase {
 
         }, acceptDocs2);
       }
+      @Override
+      public String toString(String field) {
+        return "SortedIntDocSetTopFilter";
+      }
     };
   }
 

solr/core/src/java/org/apache/solr/search/function/ValueSourceRangeFilter.java

@@ -98,7 +98,7 @@ public class ValueSourceRangeFilter extends SolrFilter {
   }
 
   @Override
-  public String toString() {
+  public String toString(String field) {
     StringBuilder sb = new StringBuilder();
     sb.append("frange(");
     sb.append(valueSource);

solr/core/src/java/org/apache/solr/search/join/IgnoreAcceptDocsQuery.java

@@ -47,11 +47,6 @@ public class IgnoreAcceptDocsQuery extends Query {
     return q.getBoost();
   }
 
-  @Override
-  public String toString() {
-    return q.toString();
-  }
-
   @Override
   public Weight createWeight(IndexSearcher searcher, boolean needsScores) throws IOException {
     Weight inner = q.createWeight(searcher, needsScores);

solr/core/src/test/org/apache/solr/search/TestRankQueryPlugin.java

@@ -126,10 +126,7 @@ public class TestRankQueryPlugin extends QParserPlugin {
       return q.getBoost();
     }
 
-    public String toString() {
-      return q.toString();
-    }
-
+    @Override
     public String toString(String field) {
       return q.toString(field);
     }

solr/core/src/test/org/apache/solr/search/TestSort.java

@@ -239,6 +239,10 @@ public class TestSort extends SolrTestCaseJ4 {
           public DocIdSet getDocIdSet(LeafReaderContext context, Bits acceptDocs) {
             return BitsFilteredDocIdSet.wrap(randSet(context.reader().maxDoc()), acceptDocs);
           }
+          @Override
+          public String toString(String field) {
+            return "TestSortFilter";
+          }
         };
 
         int top = r.nextInt((ndocs>>3)+1)+1;