Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

LUCENE-9558: Clean up package name conflicts for analyzers-icu. (#1946)

Tomoko Uchidab70eaeee5acd
diff --git a/gradle/documentation/render-javadoc.gradle b/gradle/documentation/render-javadoc.gradle
index d3c93106a2b..914fd8be58b 100644
--- a/gradle/documentation/render-javadoc.gradle
+++ b/gradle/documentation/render-javadoc.gradle
@@ -146,16 +146,6 @@ configure([
}
}
-configure(project(":lucene:analysis:icu")) {
- project.tasks.withType(RenderJavadocTask) {
- // TODO: clean up split packages
- javadocMissingIgnore = [
- "org.apache.lucene.collation",
- "org.apache.lucene.collation.tokenattributes"
- ]
- }
-}
-
configure(project(":lucene:backward-codecs")) {
project.tasks.withType(RenderJavadocTask) {
// TODO: fix missing @param tags
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index dd2f012f2d8..e2be6ee5eb3 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -12,9 +12,6 @@ System Requirements
API Changes
-* LUCENE-9317: Clean up package name conflicts between core and analyzers-common.
- See MIGRATE.md for details. (David Ryan, Tomoko Uchida, Uwe Schindler, Dawid Weiss)
-
* LUCENE-8474: RAMDirectory and associated deprecated classes have been
removed. (Dawid Weiss)
@@ -68,6 +65,9 @@ API Changes
in Lucenes IndexWriter. The interface is not sufficient to efficiently
replace the functionality with reasonable efforts. (Simon Willnauer)
+* LUCENE-9317 LUCENE-9558: Clean up package name conflicts between modules.
+ See MIGRATE.md for details. (David Ryan, Tomoko Uchida, Uwe Schindler, Dawid Weiss)
+
Improvements
* LUCENE-9463: Query match region retrieval component, passage scoring and formatting
diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.md
index d215c5d92fb..e66470834ac 100644
--- a/lucene/MIGRATE.md
+++ b/lucene/MIGRATE.md
@@ -1,5 +1,10 @@
# Apache Lucene Migration Guide
+## ICUCollationKeyAnalyzer is renamed (LUCENE-9558)
+
+o.a.l.collation.ICUCollationAnalyzer is renamed to o.a.l.a.icu.ICUCollationKeyAnalyzer.
+Also, its dependant classes are renamed in the same way.
+
## Base and concrete analysis factories are moved / package renamed (LUCENE-9317)
1. Base analysis factories are moved to `lucene-core`, also their package names are renamed.
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationAttributeFactory.java b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationAttributeFactory.java
similarity index 94%
rename from lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationAttributeFactory.java
rename to lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationAttributeFactory.java
index 5ad9209f3c3..3b29cb17342 100644
--- a/lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationAttributeFactory.java
+++ b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationAttributeFactory.java
@@ -14,11 +14,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.lucene.collation;
+package org.apache.lucene.analysis.icu;
import org.apache.lucene.analysis.TokenStream;
-import org.apache.lucene.collation.tokenattributes.ICUCollatedTermAttributeImpl;
+import org.apache.lucene.collation.CollationAttributeFactory;
+import org.apache.lucene.analysis.icu.tokenattributes.ICUCollatedTermAttributeImpl;
import org.apache.lucene.util.AttributeFactory;
import com.ibm.icu.text.Collator;
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationDocValuesField.java b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationDocValuesField.java
similarity index 98%
rename from lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationDocValuesField.java
rename to lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationDocValuesField.java
index 9ae46851b0f..a7901cceac1 100644
--- a/lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationDocValuesField.java
+++ b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationDocValuesField.java
@@ -14,7 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.lucene.collation;
+package org.apache.lucene.analysis.icu;
import org.apache.lucene.document.Field;
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationKeyAnalyzer.java b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationKeyAnalyzer.java
similarity index 97%
rename from lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationKeyAnalyzer.java
rename to lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationKeyAnalyzer.java
index 1c5436c68ab..dff569917d9 100644
--- a/lucene/analysis/icu/src/java/org/apache/lucene/collation/ICUCollationKeyAnalyzer.java
+++ b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/ICUCollationKeyAnalyzer.java
@@ -14,13 +14,14 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.lucene.collation;
+package org.apache.lucene.analysis.icu;
import com.ibm.icu.text.Collator;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.core.KeywordTokenizer;
+import org.apache.lucene.collation.CollationKeyAnalyzer;
/**
* <p>
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/collation/tokenattributes/ICUCollatedTermAttributeImpl.java b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/tokenattributes/ICUCollatedTermAttributeImpl.java
similarity index 97%
rename from lucene/analysis/icu/src/java/org/apache/lucene/collation/tokenattributes/ICUCollatedTermAttributeImpl.java
rename to lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/tokenattributes/ICUCollatedTermAttributeImpl.java
index 793dec2ce1a..0e5c98ef0a5 100644
--- a/lucene/analysis/icu/src/java/org/apache/lucene/collation/tokenattributes/ICUCollatedTermAttributeImpl.java
+++ b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/tokenattributes/ICUCollatedTermAttributeImpl.java
@@ -14,7 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.lucene.collation.tokenattributes;
+package org.apache.lucene.analysis.icu.tokenattributes;
import org.apache.lucene.analysis.tokenattributes.CharTermAttributeImpl;
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/collation/package.html b/lucene/analysis/icu/src/java/org/apache/lucene/collation/package.html
deleted file mode 100644
index 2c81f4a5825..00000000000
--- a/lucene/analysis/icu/src/java/org/apache/lucene/collation/package.html
+++ /dev/null
@@ -1,23 +0,0 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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.
--->
-<!-- not a package-info.java, because we already defined this package in common/ -->
-<html>
-<body>
-Unicode Collation support.
-</body>
-</html>
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/collation/tokenattributes/package.html b/lucene/analysis/icu/src/java/org/apache/lucene/collation/tokenattributes/package.html
deleted file mode 100644
index 6f211170e1b..00000000000
--- a/lucene/analysis/icu/src/java/org/apache/lucene/collation/tokenattributes/package.html
+++ /dev/null
@@ -1,23 +0,0 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<!--
- 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.
--->
-<!-- not a package-info.java, because we already defined this package in common/ -->
-<html>
-<body>
-Custom {@link org.apache.lucene.util.AttributeImpl} for indexing collation keys as index terms.
-</body>
-</html>
diff --git a/lucene/analysis/icu/src/test/org/apache/lucene/collation/TestICUCollationDocValuesField.java b/lucene/analysis/icu/src/test/org/apache/lucene/analysis/icu/TestICUCollationDocValuesField.java
similarity index 99%
rename from lucene/analysis/icu/src/test/org/apache/lucene/collation/TestICUCollationDocValuesField.java
rename to lucene/analysis/icu/src/test/org/apache/lucene/analysis/icu/TestICUCollationDocValuesField.java
index 24862c4fc4f..4e90a4822d2 100644
--- a/lucene/analysis/icu/src/test/org/apache/lucene/collation/TestICUCollationDocValuesField.java
+++ b/lucene/analysis/icu/src/test/org/apache/lucene/analysis/icu/TestICUCollationDocValuesField.java
@@ -14,7 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.lucene.collation;
+package org.apache.lucene.analysis.icu;
import org.apache.lucene.document.Document;
diff --git a/lucene/analysis/icu/src/test/org/apache/lucene/collation/TestICUCollationKeyAnalyzer.java b/lucene/analysis/icu/src/test/org/apache/lucene/analysis/icu/TestICUCollationKeyAnalyzer.java
similarity index 98%
rename from lucene/analysis/icu/src/test/org/apache/lucene/collation/TestICUCollationKeyAnalyzer.java
rename to lucene/analysis/icu/src/test/org/apache/lucene/analysis/icu/TestICUCollationKeyAnalyzer.java
index 91f8aed87c4..a85d583c81d 100644
--- a/lucene/analysis/icu/src/test/org/apache/lucene/collation/TestICUCollationKeyAnalyzer.java
+++ b/lucene/analysis/icu/src/test/org/apache/lucene/analysis/icu/TestICUCollationKeyAnalyzer.java
@@ -14,8 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.lucene.collation;
-
+package org.apache.lucene.analysis.icu;
import com.ibm.icu.text.Collator;
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/NewCollationAnalyzerTask.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/NewCollationAnalyzerTask.java
index 95cf8b285cd..56e9f751ff8 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/NewCollationAnalyzerTask.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/NewCollationAnalyzerTask.java
@@ -44,7 +44,7 @@ public class NewCollationAnalyzerTask extends PerfTask {
public enum Implementation {
JDK("org.apache.lucene.collation.CollationKeyAnalyzer",
"java.text.Collator"),
- ICU("org.apache.lucene.collation.ICUCollationKeyAnalyzer",
+ ICU("org.apache.lucene.analysis.icu.ICUCollationKeyAnalyzer",
"com.ibm.icu.text.Collator");
String className;
diff --git a/solr/contrib/analysis-extras/src/java/org/apache/solr/schema/ICUCollationField.java b/solr/contrib/analysis-extras/src/java/org/apache/solr/schema/ICUCollationField.java
index 6fd464f54e1..dc01d32eb97 100644
--- a/solr/contrib/analysis-extras/src/java/org/apache/solr/schema/ICUCollationField.java
+++ b/solr/contrib/analysis-extras/src/java/org/apache/solr/schema/ICUCollationField.java
@@ -28,7 +28,7 @@ import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.tokenattributes.TermToBytesRefAttribute;
import org.apache.lucene.util.ResourceLoader;
-import org.apache.lucene.collation.ICUCollationKeyAnalyzer;
+import org.apache.lucene.analysis.icu.ICUCollationKeyAnalyzer;
import org.apache.lucene.document.SortedDocValuesField;
import org.apache.lucene.document.SortedSetDocValuesField;
import org.apache.lucene.index.IndexableField;