You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by gs...@apache.org on 2022/01/24 14:49:53 UTC
[lucene] branch branch_9x updated: LUCENE-10381: Require users to provide FacetsConfig for SSDV faceting (#614)
This is an automated email from the ASF dual-hosted git repository.
gsmiller pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/lucene.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new fa63c68 LUCENE-10381: Require users to provide FacetsConfig for SSDV faceting (#614)
fa63c68 is described below
commit fa63c68857ea40cc8fe35055e6e97fefa0342b2e
Author: Greg Miller <gs...@gmail.com>
AuthorDate: Mon Jan 24 06:46:10 2022 -0800
LUCENE-10381: Require users to provide FacetsConfig for SSDV faceting (#614)
---
lucene/CHANGES.txt | 2 ++
.../lucene/demo/facet/SimpleSortedSetFacetsExample.java | 6 ++++--
.../sortedset/DefaultSortedSetDocValuesReaderState.java | 16 +++++++++++++++-
.../test/org/apache/lucene/facet/TestDrillSideways.java | 2 +-
.../facet/sortedset/TestSortedSetDocValuesFacets.java | 16 ++++++++--------
5 files changed, 30 insertions(+), 12 deletions(-)
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index f312b1f..c845b52 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -32,6 +32,8 @@ API Changes
a boolean indicating whether or not skipping should be enabled on the comparator.
(Alan Woodward)
+* LUCENE-10381: Require users to provide FacetsConfig for SSDV faceting. (Greg Miller)
+
New Features
---------------------
diff --git a/lucene/demo/src/java/org/apache/lucene/demo/facet/SimpleSortedSetFacetsExample.java b/lucene/demo/src/java/org/apache/lucene/demo/facet/SimpleSortedSetFacetsExample.java
index 63b3240..32b7545 100644
--- a/lucene/demo/src/java/org/apache/lucene/demo/facet/SimpleSortedSetFacetsExample.java
+++ b/lucene/demo/src/java/org/apache/lucene/demo/facet/SimpleSortedSetFacetsExample.java
@@ -88,7 +88,8 @@ public class SimpleSortedSetFacetsExample {
private List<FacetResult> search() throws IOException {
DirectoryReader indexReader = DirectoryReader.open(indexDir);
IndexSearcher searcher = new IndexSearcher(indexReader);
- SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(indexReader);
+ SortedSetDocValuesReaderState state =
+ new DefaultSortedSetDocValuesReaderState(indexReader, config);
// Aggregatses the facet counts
FacetsCollector fc = new FacetsCollector();
@@ -113,7 +114,8 @@ public class SimpleSortedSetFacetsExample {
private FacetResult drillDown() throws IOException {
DirectoryReader indexReader = DirectoryReader.open(indexDir);
IndexSearcher searcher = new IndexSearcher(indexReader);
- SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(indexReader);
+ SortedSetDocValuesReaderState state =
+ new DefaultSortedSetDocValuesReaderState(indexReader, config);
// Now user drills down on Publish Year/2010:
DrillDownQuery q = new DrillDownQuery(config);
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/sortedset/DefaultSortedSetDocValuesReaderState.java b/lucene/facet/src/java/org/apache/lucene/facet/sortedset/DefaultSortedSetDocValuesReaderState.java
index 2642280..d413cd5 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/sortedset/DefaultSortedSetDocValuesReaderState.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/sortedset/DefaultSortedSetDocValuesReaderState.java
@@ -74,12 +74,26 @@ public class DefaultSortedSetDocValuesReaderState extends SortedSetDocValuesRead
/**
* Creates this without a config, pulling doc values from the default {@link
* FacetsConfig#DEFAULT_INDEX_FIELD_NAME}.
+ *
+ * @deprecated Users should explicitly provide facet configuration during instantiation. See
+ * {@link #DefaultSortedSetDocValuesReaderState(IndexReader, FacetsConfig)}. To maintain all
+ * existing behavior, a "default" facet configuration can be provided with {@link
+ * FacetsConfig#FacetsConfig()}.
*/
+ @Deprecated
public DefaultSortedSetDocValuesReaderState(IndexReader reader) throws IOException {
this(reader, FacetsConfig.DEFAULT_INDEX_FIELD_NAME, null);
}
- /** Creates this without a config, pulling doc values from the specified field. */
+ /**
+ * Creates this without a config, pulling doc values from the specified field.
+ *
+ * @deprecated Users should explicitly provide facet configuration during instantiation. See
+ * {@link #DefaultSortedSetDocValuesReaderState(IndexReader, String, FacetsConfig)}. To
+ * maintain all existing behavior, a "default" facet configuration can be provided with {@link
+ * FacetsConfig#FacetsConfig()}.
+ */
+ @Deprecated
public DefaultSortedSetDocValuesReaderState(IndexReader reader, String field) throws IOException {
this(reader, field, null);
}
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/TestDrillSideways.java b/lucene/facet/src/test/org/apache/lucene/facet/TestDrillSideways.java
index b721f9c..dfcc9ff 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/TestDrillSideways.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/TestDrillSideways.java
@@ -1068,7 +1068,7 @@ public class TestDrillSideways extends FacetTestCase {
IndexSearcher s = getNewSearcher(r);
if (doUseDV) {
- sortedSetDVState = new DefaultSortedSetDocValuesReaderState(s.getIndexReader());
+ sortedSetDVState = new DefaultSortedSetDocValuesReaderState(s.getIndexReader(), config);
} else {
sortedSetDVState = null;
}
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/sortedset/TestSortedSetDocValuesFacets.java b/lucene/facet/src/test/org/apache/lucene/facet/sortedset/TestSortedSetDocValuesFacets.java
index 3f72a76..28088ef 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/sortedset/TestSortedSetDocValuesFacets.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/sortedset/TestSortedSetDocValuesFacets.java
@@ -85,7 +85,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
// Per-top-reader state:
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
ExecutorService exec = randomExecutorServiceOrNull();
try {
@@ -214,7 +214,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
// Per-top-reader state:
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
Facets facets = new SortedSetDocValuesFacetCounts(state);
@@ -330,7 +330,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
// Per-top-reader state:
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
ExecutorService exec = randomExecutorServiceOrNull();
try {
@@ -641,7 +641,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
writer.addDocument(config.build(doc));
try (IndexReader r = writer.getReader()) {
- SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(r);
+ SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(r, config);
doc = new Document();
doc.add(new SortedSetDocValuesFacetField("a", "bar"));
@@ -704,7 +704,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
// Per-top-reader state:
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
ExecutorService exec = randomExecutorServiceOrNull();
try {
@@ -832,7 +832,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
// Per-top-reader state:
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
ExecutorService exec = randomExecutorServiceOrNull();
try {
@@ -936,7 +936,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
// Per-top-reader state:
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
ExecutorService exec = randomExecutorServiceOrNull();
try {
int iters = atLeast(100);
@@ -1297,7 +1297,7 @@ public class TestSortedSetDocValuesFacets extends FacetTestCase {
IndexSearcher searcher = newSearcher(r);
SortedSetDocValuesReaderState state =
- new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+ new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
ExecutorService exec = randomExecutorServiceOrNull();
try {