rzo1 commented on code in PR #1109: URL: https://github.com/apache/opennlp/pull/1109#discussion_r3488257703
########## opennlp-api/src/main/java/opennlp/tools/util/normalizer/AlignedText.java: ########## @@ -0,0 +1,58 @@ +/* + * 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. + */ +package opennlp.tools.util.normalizer; + +import opennlp.tools.util.Span; + +/** + * The result of a normalization that keeps the original text alongside the normalized form and a + * full {@link Alignment} between them. + * + * <p>The original is the source of truth, the normalized form is the derived view tuned for + * matching and search, and the alignment maps spans between them through deletions, collapses, and + * expansions. Use + * {@link #toOriginalSpan(int, int)} to report a match found in the normalized form against the + * original.</p> + * + * @param original The untouched source text. + * @param normalized The normalized text. + * @param alignment The alignment between the normalized and original text. + */ +public record AlignedText(CharSequence original, String normalized, Alignment alignment) { Review Comment: Why is the original a `CharSequence` and the normalized one a `String`. Shouldn't it also be a `CharSequence`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
