Skip to content

Apache Lucene open-source search software

Remove IOException from LeafReader#getSumDocFreq and LeafReader#getSumTotalTermFreq signatures (#16060)

Ignacio Veradce04adadf2d
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 79d722fb673..c54fc9a987c 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -96,7 +96,8 @@ API Changes
* GITHUB#: Add junit5/jupiter support to the test-framework module. (Dawid Weiss)
* GITHUB#16052: Remove IOException from LeafReader#getPointValues, LeafReader#terms,
- LeafReader#getDocCount signatures. (Ignacio Vera)
+ LeafReader#getDocCount, LeafReader#getSumDocFreq and LeafReader#getSumTotalTermFreq
+ signatures. (Ignacio Vera)
* GITHUB#16388: Remove IOException from LeafReader#getDocValuesSkipper signature.
(Alan Woodward)
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/blockterms/BlockTermsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/blockterms/BlockTermsReader.java
index 2c3767bb616..5404e5aa54a 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/blockterms/BlockTermsReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/blockterms/BlockTermsReader.java
@@ -288,7 +288,7 @@ public class BlockTermsReader extends FieldsProducer {
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return sumDocFreq;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/BloomFilteringPostingsFormat.java b/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/BloomFilteringPostingsFormat.java
index 2e3ef1c0220..86652973062 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/BloomFilteringPostingsFormat.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/BloomFilteringPostingsFormat.java
@@ -236,12 +236,12 @@ public final class BloomFilteringPostingsFormat extends PostingsFormat {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
return delegateTerms.getSumTotalTermFreq();
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return delegateTerms.getSumDocFreq();
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java
index 06c9ab77d03..a46b8be7501 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/memory/FSTTermsReader.java
@@ -247,7 +247,7 @@ public class FSTTermsReader extends FieldsProducer {
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return sumDocFreq;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextFieldsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextFieldsReader.java
index afa82ea2479..b45139d81fd 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextFieldsReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextFieldsReader.java
@@ -770,7 +770,7 @@ class SimpleTextFieldsReader extends FieldsProducer {
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return sumDocFreq;
}
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextTermVectorsReader.java b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextTermVectorsReader.java
index 3fcfea27fd1..114b2142e85 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextTermVectorsReader.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextTermVectorsReader.java
@@ -34,6 +34,7 @@ import static org.apache.lucene.codecs.simpletext.SimpleTextTermVectorsWriter.TE
import static org.apache.lucene.codecs.simpletext.SimpleTextTermVectorsWriter.VECTORS_EXTENSION;
import java.io.IOException;
+import java.io.UncheckedIOException;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
@@ -297,18 +298,22 @@ public class SimpleTextTermVectorsReader extends TermVectorsReader {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
- // TODO: make it constant-time
- long ttf = 0;
- TermsEnum iterator = iterator();
- for (BytesRef b = iterator.next(); b != null; b = iterator.next()) {
- ttf += iterator.totalTermFreq();
+ public long getSumTotalTermFreq() {
+ try {
+ // TODO: make it constant-time by pre-computing during indexing
+ long ttf = 0;
+ TermsEnum iterator = iterator();
+ for (BytesRef b = iterator.next(); b != null; b = iterator.next()) {
+ ttf += iterator.totalTermFreq();
+ }
+ return ttf;
+ } catch (IOException e) {
+ throw new UncheckedIOException(e);
}
- return ttf;
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return terms.size();
}
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java
index 05774f803b3..fd058ed5c83 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsReader.java
@@ -1018,12 +1018,12 @@ public final class Lucene90CompressingTermVectorsReader extends TermVectorsReade
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
return totalTermFreq;
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return numTerms;
}
diff --git a/lucene/core/src/java/org/apache/lucene/index/FilterLeafReader.java b/lucene/core/src/java/org/apache/lucene/index/FilterLeafReader.java
index 88a89bef3c8..0e0e76921da 100644
--- a/lucene/core/src/java/org/apache/lucene/index/FilterLeafReader.java
+++ b/lucene/core/src/java/org/apache/lucene/index/FilterLeafReader.java
@@ -121,12 +121,12 @@ public abstract class FilterLeafReader extends LeafReader {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
return in.getSumTotalTermFreq();
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return in.getSumDocFreq();
}
diff --git a/lucene/core/src/java/org/apache/lucene/index/LeafReader.java b/lucene/core/src/java/org/apache/lucene/index/LeafReader.java
index 7d746561461..e55ab27afc2 100644
--- a/lucene/core/src/java/org/apache/lucene/index/LeafReader.java
+++ b/lucene/core/src/java/org/apache/lucene/index/LeafReader.java
@@ -104,7 +104,7 @@ public abstract non-sealed class LeafReader extends IndexReader {
}
@Override
- public final long getSumDocFreq(String field) throws IOException {
+ public final long getSumDocFreq(String field) {
final Terms terms = terms(field);
if (terms == null) {
return 0;
@@ -122,7 +122,7 @@ public abstract non-sealed class LeafReader extends IndexReader {
}
@Override
- public final long getSumTotalTermFreq(String field) throws IOException {
+ public final long getSumTotalTermFreq(String field) {
final Terms terms = terms(field);
if (terms == null) {
return 0;
diff --git a/lucene/core/src/java/org/apache/lucene/index/MappedMultiFields.java b/lucene/core/src/java/org/apache/lucene/index/MappedMultiFields.java
index fb87b54e171..5978d63e7cb 100644
--- a/lucene/core/src/java/org/apache/lucene/index/MappedMultiFields.java
+++ b/lucene/core/src/java/org/apache/lucene/index/MappedMultiFields.java
@@ -77,12 +77,12 @@ public class MappedMultiFields extends FilterFields {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
throw new UnsupportedOperationException();
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
throw new UnsupportedOperationException();
}
diff --git a/lucene/core/src/java/org/apache/lucene/index/MultiTerms.java b/lucene/core/src/java/org/apache/lucene/index/MultiTerms.java
index 9b4f6c48828..819033df0cd 100644
--- a/lucene/core/src/java/org/apache/lucene/index/MultiTerms.java
+++ b/lucene/core/src/java/org/apache/lucene/index/MultiTerms.java
@@ -200,7 +200,7 @@ public final class MultiTerms extends Terms {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
long sum = 0;
for (Terms terms : subs) {
final long v = terms.getSumTotalTermFreq();
@@ -211,7 +211,7 @@ public final class MultiTerms extends Terms {
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
long sum = 0;
for (Terms terms : subs) {
final long v = terms.getSumDocFreq();
diff --git a/lucene/core/src/java/org/apache/lucene/index/Terms.java b/lucene/core/src/java/org/apache/lucene/index/Terms.java
index 3f3b5bc3802..e532ff4583d 100644
--- a/lucene/core/src/java/org/apache/lucene/index/Terms.java
+++ b/lucene/core/src/java/org/apache/lucene/index/Terms.java
@@ -106,13 +106,13 @@ public abstract class Terms {
* Returns the sum of {@link TermsEnum#totalTermFreq} for all terms in this field. Note that, just
* like other term measures, this measure does not take deleted documents into account.
*/
- public abstract long getSumTotalTermFreq() throws IOException;
+ public abstract long getSumTotalTermFreq();
/**
* Returns the sum of {@link TermsEnum#docFreq()} for all terms in this field. Note that, just
* like other term measures, this measure does not take deleted documents into account.
*/
- public abstract long getSumDocFreq() throws IOException;
+ public abstract long getSumDocFreq();
/**
* Returns the number of documents that have at least one term for this field. Note that, just
@@ -237,12 +237,12 @@ public abstract class Terms {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
return 0;
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return 0;
}
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestMultiTermsEnum.java b/lucene/core/src/test/org/apache/lucene/index/TestMultiTermsEnum.java
index f6c8f8f53f5..4b5106864ab 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestMultiTermsEnum.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestMultiTermsEnum.java
@@ -139,12 +139,12 @@ public class TestMultiTermsEnum extends LuceneTestCase {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
throw new UnsupportedOperationException();
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
throw new UnsupportedOperationException();
}
diff --git a/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java b/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java
index d5b5cdb28ce..284942f5151 100644
--- a/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java
+++ b/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java
@@ -283,12 +283,12 @@ public class TestDocIdSetBuilder extends LuceneTestCase {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
throw new UnsupportedOperationException();
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return numValues;
}
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/ramonly/RAMOnlyPostingsFormat.java b/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/ramonly/RAMOnlyPostingsFormat.java
index 7c76d16fdf4..bf1c6e00647 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/ramonly/RAMOnlyPostingsFormat.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/codecs/ramonly/RAMOnlyPostingsFormat.java
@@ -115,7 +115,7 @@ public final class RAMOnlyPostingsFormat extends PostingsFormat {
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
return sumDocFreq;
}
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/index/AssertingLeafReader.java b/lucene/test-framework/src/java/org/apache/lucene/tests/index/AssertingLeafReader.java
index 98417d47d82..9ab56dc17da 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/index/AssertingLeafReader.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/index/AssertingLeafReader.java
@@ -239,7 +239,7 @@ public class AssertingLeafReader extends FilterLeafReader {
}
@Override
- public long getSumDocFreq() throws IOException {
+ public long getSumDocFreq() {
assertThread("Terms", creationThread);
final long sumDf = in.getSumDocFreq();
assert sumDf >= getDocCount();
@@ -247,7 +247,7 @@ public class AssertingLeafReader extends FilterLeafReader {
}
@Override
- public long getSumTotalTermFreq() throws IOException {
+ public long getSumTotalTermFreq() {
assertThread("Terms", creationThread);
final long sumTtf = in.getSumTotalTermFreq();
if (hasFreqs() == false) {