Binary files ../lucene-2.4.0-orig/contrib/db/bdb/lib/db-4.3.29.jar and ./contrib/db/bdb/lib/db-4.3.29.jar differ Binary files ../lucene-2.4.0-orig/junit-4.5.jar and ./junit-4.5.jar differ diff -ru --unidirectional-new-file ../lucene-2.4.0-orig/src/java/org/apache/lucene/search/FieldCache.java ./src/java/org/apache/lucene/search/FieldCache.java --- ../lucene-2.4.0-orig/src/java/org/apache/lucene/search/FieldCache.java 2008-11-25 11:13:38.000000000 -0800 +++ ./src/java/org/apache/lucene/search/FieldCache.java 2008-11-25 17:45:11.000000000 -0800 @@ -38,7 +38,29 @@ /** Expert: Stores term text values and document ordering data. */ public static class StringIndex { - + + public int binarySearchLookup(String key) { + // this special case is the reason that Arrays.binarySearch() isn't useful. + if (key == null) + return 0; + + int low = 1; + int high = lookup.length-1; + + while (low <= high) { + int mid = (low + high) >> 1; + int cmp = lookup[mid].compareTo(key); + + if (cmp < 0) + low = mid + 1; + else if (cmp > 0) + high = mid - 1; + else + return mid; // key found + } + return -(low + 1); // key not found. + } + /** All the term values, in natural order. */ public final String[] lookup; diff -ru --unidirectional-new-file ../lucene-2.4.0-orig/src/java/org/apache/lucene/search/FieldCacheRangeFilter.java ./src/java/org/apache/lucene/search/FieldCacheRangeFilter.java --- ../lucene-2.4.0-orig/src/java/org/apache/lucene/search/FieldCacheRangeFilter.java 1969-12-31 16:00:00.000000000 -0800 +++ ./src/java/org/apache/lucene/search/FieldCacheRangeFilter.java 2008-12-01 10:57:33.000000000 -0800 @@ -0,0 +1,196 @@ +package org.apache.lucene.search; +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.IOException; +import java.util.Arrays; + +import org.apache.lucene.index.IndexReader; + +/** + * A range filter built on top of a cached single term field (in FieldCache). + * + * FieldCacheRangeFilter builds a single cache for the field the first time it is used. + * + * Each subsequent FieldCacheRangeFilter on the same field then reuses this cache, + * even if the range itself changes. + * + * This means that FieldCacheRangeFilter is much faster (sometimes more than 100x as fast) + * as building a RangeFilter (or ConstantScoreRangeQuery on a RangeFilter) for each query. + * However, if the range never changes it is slower (around 2x as slow) than building a + * CachingWrapperFilter on top of a single RangeFilter. + * + * As with all FieldCache based functionality, FieldCacheRangeFilter is only valid for + * fields which contain zero or one terms for each document. Thus it works on dates, + * prices and other single value fields but will not work on regular text fields. It is + * preferable to use an UN_TOKENIZED field to ensure that there is only a single term. + * + * Also, collation is done at the time the FieldCache is built; to change + * collation you need to override the getFieldCache() method to change the underlying cache. + */ + +public class FieldCacheRangeFilter extends Filter { + private String field; + private String lowerVal; + private String upperVal; + private boolean includeLower; + private boolean includeUpper; + + public FieldCacheRangeFilter( + String field, + String lowerVal, + String upperVal, + boolean includeLower, + boolean includeUpper) { + this.field = field; + this.lowerVal = lowerVal; + this.upperVal = upperVal; + this.includeLower = includeLower; + this.includeUpper = includeUpper; + } + + public FieldCache getFieldCache() { + return FieldCache.DEFAULT; + } + + public DocIdSet getDocIdSet(IndexReader reader) throws IOException { + return new RangeMultiFilterDocIdSet(getFieldCache().getStringIndex(reader, field)); + } + + public String toString() { + StringBuffer buffer = new StringBuffer(); + buffer.append(field); + buffer.append(":"); + buffer.append(includeLower ? "[" : "{"); + if (null != lowerVal) { + buffer.append(lowerVal); + } + buffer.append("-"); + if (null != upperVal) { + buffer.append(upperVal); + } + buffer.append(includeUpper ? "]" : "}"); + return buffer.toString(); + } + + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof FieldCacheRangeFilter)) return false; + FieldCacheRangeFilter other = (FieldCacheRangeFilter) o; + + if (!this.field.equals(other.field) + || this.includeLower != other.includeLower + || this.includeUpper != other.includeUpper + ) { return false; } + if (this.lowerVal != null ? !this.lowerVal.equals(other.lowerVal) : other.lowerVal != null) return false; + if (this.upperVal != null ? !this.upperVal.equals(other.upperVal) : other.upperVal != null) return false; + return true; + } + + public int hashCode() { + int h = field.hashCode(); + h ^= lowerVal != null ? lowerVal.hashCode() : 550356204; + h = (h << 1) | (h >>> 31); // rotate to distinguish lower from upper + h ^= (upperVal != null ? (upperVal.hashCode()) : -1674416163); + h ^= (includeLower ? 1549299360 : -365038026) + ^ (includeUpper ? 1721088258 : 1948649653); + + return h; + } + + + protected class RangeMultiFilterDocIdSet extends DocIdSet { + private int inclusiveLowerPoint; + private int inclusiveUpperPoint; + private FieldCache.StringIndex fcsi; + + public RangeMultiFilterDocIdSet(FieldCache.StringIndex fcsi) { + this.fcsi = fcsi; + initialize(); + } + + private void initialize() { + int lowerPoint = fcsi.binarySearchLookup(lowerVal); + int upperPoint = fcsi.binarySearchLookup(upperVal); + + if (lowerPoint == 0 && upperPoint == 0) { + throw new IllegalArgumentException("At least one value must be non-null"); + } + + if (includeLower && lowerPoint == 0) { + throw new IllegalArgumentException("The lower bound must be non-null to be inclusive"); + } else if (includeLower && lowerPoint > 0) { + inclusiveLowerPoint = lowerPoint; + } else if (lowerPoint >= 0) { + inclusiveLowerPoint = lowerPoint+1; + } else { + inclusiveLowerPoint = -lowerPoint-1; + } + + if (includeUpper && upperPoint == 0) { + throw new IllegalArgumentException("The upper bound must be non-null to be inclusive"); + } else if (upperPoint == 0) { + inclusiveUpperPoint = Integer.MAX_VALUE; + } else if (includeUpper && upperPoint > 0) { + inclusiveUpperPoint = upperPoint; + } else if (upperPoint >= 0) { + inclusiveUpperPoint = upperPoint - 1; + } else { + inclusiveUpperPoint = -upperPoint - 2; + } + } + + public DocIdSetIterator iterator() { + return new RangeMultiFilterIterator(); + } + + protected class RangeMultiFilterIterator extends DocIdSetIterator { + private int doc = -1; + + public int doc() { + return doc; + } + + public boolean next() { + try { + do { + doc++; + } while (fcsi.order[doc] > inclusiveUpperPoint + || fcsi.order[doc] < inclusiveLowerPoint); + return true; + } catch (ArrayIndexOutOfBoundsException e) { + doc = Integer.MAX_VALUE; + return false; + } + } + + public boolean skipTo(int target) { + try { + doc = target; + while (fcsi.order[doc] > inclusiveUpperPoint + || fcsi.order[doc] < inclusiveLowerPoint) { + doc++; + } + return true; + } catch (ArrayIndexOutOfBoundsException e) { + doc = Integer.MAX_VALUE; + return false; + } + } + } + } +} diff -ru --unidirectional-new-file ../lucene-2.4.0-orig/src/java/org/apache/lucene/search/RangeFilter.java ./src/java/org/apache/lucene/search/RangeFilter.java --- ../lucene-2.4.0-orig/src/java/org/apache/lucene/search/RangeFilter.java 2008-11-25 11:13:38.000000000 -0800 +++ ./src/java/org/apache/lucene/search/RangeFilter.java 2008-11-25 14:33:01.000000000 -0800 @@ -35,6 +35,9 @@ * This code borrows heavily from {@link RangeQuery}, but is implemented as a Filter * *

+ * + * If you construct a large number of range filters with different ranges but on the + * same field, {@link FieldCacheRangeFilter} may have significantly better performance. */ public class RangeFilter extends Filter { diff -ru --unidirectional-new-file ../lucene-2.4.0-orig/src/test/org/apache/lucene/search/TestFieldCacheRangeFilter.java ./src/test/org/apache/lucene/search/TestFieldCacheRangeFilter.java --- ../lucene-2.4.0-orig/src/test/org/apache/lucene/search/TestFieldCacheRangeFilter.java 1969-12-31 16:00:00.000000000 -0800 +++ ./src/test/org/apache/lucene/search/TestFieldCacheRangeFilter.java 2008-12-01 11:03:57.000000000 -0800 @@ -0,0 +1,194 @@ +package org.apache.lucene.search; + +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.IOException; +import java.text.Collator; +import java.util.Locale; + +import org.apache.lucene.index.IndexReader; +import org.apache.lucene.index.Term; +import org.apache.lucene.index.IndexWriter; +import org.apache.lucene.analysis.SimpleAnalyzer; +import org.apache.lucene.document.Document; +import org.apache.lucene.document.Field; +import org.apache.lucene.store.RAMDirectory; + +/** + * A basic 'positive' Unit test class for the RangeFilter class. + * + *

+ * NOTE: at the moment, this class only tests for 'positive' results, + * it does not verify the results to ensure there are no 'false positives', + * nor does it adequately test 'negative' results. It also does not test + * that garbage in results in an Exception. + */ +public class TestFieldCacheRangeFilter extends BaseTestRangeFilter { + + public TestFieldCacheRangeFilter(String name) { + super(name); + } + public TestFieldCacheRangeFilter() { + super(); + } + + public void testRangeFilterId() throws IOException { + + IndexReader reader = IndexReader.open(signedIndex.index); + IndexSearcher search = new IndexSearcher(reader); + + int medId = ((maxId - minId) / 2); + + String minIP = pad(minId); + String maxIP = pad(maxId); + String medIP = pad(medId); + + int numDocs = reader.numDocs(); + + assertEquals("num of docs", numDocs, 1+ maxId - minId); + + ScoreDoc[] result; + Query q = new TermQuery(new Term("body","body")); + + // test id, bounded on both ends + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,maxIP,T,T), numDocs).scoreDocs; + assertEquals("find all", numDocs, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,maxIP,T,F), numDocs).scoreDocs; + assertEquals("all but last", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,maxIP,F,T), numDocs).scoreDocs; + assertEquals("all but first", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,maxIP,F,F), numDocs).scoreDocs; + assertEquals("all but ends", numDocs-2, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",medIP,maxIP,T,T), numDocs).scoreDocs; + assertEquals("med and up", 1+ maxId-medId, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,medIP,T,T), numDocs).scoreDocs; + assertEquals("up to med", 1+ medId-minId, result.length); + + // unbounded id + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,null,T,F), numDocs).scoreDocs; + assertEquals("min and up", numDocs, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",null,maxIP,F,T), numDocs).scoreDocs; + assertEquals("max and down", numDocs, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,null,F,F), numDocs).scoreDocs; + assertEquals("not min, but up", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",null,maxIP,F,F), numDocs).scoreDocs; + assertEquals("not max, but down", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",medIP,maxIP,T,F), numDocs).scoreDocs; + assertEquals("med and up, not max", maxId-medId, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,medIP,F,T), numDocs).scoreDocs; + assertEquals("not min, up to med", medId-minId, result.length); + + // very small sets + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,minIP,F,F), numDocs).scoreDocs; + assertEquals("min,min,F,F", 0, result.length); + result = search.search(q,new FieldCacheRangeFilter("id",medIP,medIP,F,F), numDocs).scoreDocs; + assertEquals("med,med,F,F", 0, result.length); + result = search.search(q,new FieldCacheRangeFilter("id",maxIP,maxIP,F,F), numDocs).scoreDocs; + assertEquals("max,max,F,F", 0, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",minIP,minIP,T,T), numDocs).scoreDocs; + assertEquals("min,min,T,T", 1, result.length); + result = search.search(q,new FieldCacheRangeFilter("id",null,minIP,F,T), numDocs).scoreDocs; + assertEquals("nul,min,F,T", 1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",maxIP,maxIP,T,T), numDocs).scoreDocs; + assertEquals("max,max,T,T", 1, result.length); + result = search.search(q,new FieldCacheRangeFilter("id",maxIP,null,T,F), numDocs).scoreDocs; + assertEquals("max,nul,T,T", 1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("id",medIP,medIP,T,T), numDocs).scoreDocs; + assertEquals("med,med,T,T", 1, result.length); + + } + + public void testFieldCacheRangeFilterRand() throws IOException { + + IndexReader reader = IndexReader.open(signedIndex.index); + IndexSearcher search = new IndexSearcher(reader); + + String minRP = pad(signedIndex.minR); + String maxRP = pad(signedIndex.maxR); + + int numDocs = reader.numDocs(); + + assertEquals("num of docs", numDocs, 1+ maxId - minId); + + ScoreDoc[] result; + Query q = new TermQuery(new Term("body","body")); + + // test extremes, bounded on both ends + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,maxRP,T,T), numDocs).scoreDocs; + assertEquals("find all", numDocs, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,maxRP,T,F), numDocs).scoreDocs; + assertEquals("all but biggest", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,maxRP,F,T), numDocs).scoreDocs; + assertEquals("all but smallest", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,maxRP,F,F), numDocs).scoreDocs; + assertEquals("all but extremes", numDocs-2, result.length); + + // unbounded + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,null,T,F), numDocs).scoreDocs; + assertEquals("smallest and up", numDocs, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",null,maxRP,F,T), numDocs).scoreDocs; + assertEquals("biggest and down", numDocs, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,null,F,F), numDocs).scoreDocs; + assertEquals("not smallest, but up", numDocs-1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",null,maxRP,F,F), numDocs).scoreDocs; + assertEquals("not biggest, but down", numDocs-1, result.length); + + // very small sets + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,minRP,F,F), numDocs).scoreDocs; + assertEquals("min,min,F,F", 0, result.length); + result = search.search(q,new FieldCacheRangeFilter("rand",maxRP,maxRP,F,F), numDocs).scoreDocs; + assertEquals("max,max,F,F", 0, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",minRP,minRP,T,T), numDocs).scoreDocs; + assertEquals("min,min,T,T", 1, result.length); + result = search.search(q,new FieldCacheRangeFilter("rand",null,minRP,F,T), numDocs).scoreDocs; + assertEquals("nul,min,F,T", 1, result.length); + + result = search.search(q,new FieldCacheRangeFilter("rand",maxRP,maxRP,T,T), numDocs).scoreDocs; + assertEquals("max,max,T,T", 1, result.length); + result = search.search(q,new FieldCacheRangeFilter("rand",maxRP,null,T,F), numDocs).scoreDocs; + assertEquals("max,nul,T,T", 1, result.length); + + } + +}