search sentences with (source file) line number

documentation updated

Author: Johannes Heinecke

CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+## Version 2.30.0
+* search sentences with line number
+* new tests
+
 ## Version 2.29.4
 * minor change in CSS (to allow triple click to copy the current sentence)
 

Dockerfile

@@ -1,11 +1,11 @@
 #FROM openjdk:17-alpine
 FROM amazoncorretto:24-jdk
 
-ARG VERSION=2.29.4
-# docker build --build-arg VERSION=2.29.4 -t jheinecke/conllueditor:2.29.4 .
-# docker build --build-arg VERSION=2.29.4 -t jheinecke/conllueditor:latest .
+ARG VERSION=2.30.0
+# docker build --build-arg VERSION=2.30.0 -t jheinecke/conllueditor:2.30.0 .
+# docker build --build-arg VERSION=2.30.0 -t jheinecke/conllueditor:latest .
 # docker run -t --rm --name conllueditor -p 5555:5555 --user 1000:1000  -v </absolute/path/to/datadir>:/data  --env filename=tt.conllu jheinecke/conllueditor:latest
-# docker push jheinecke/conllueditor:2.29.4
+# docker push jheinecke/conllueditor:2.30.0
 # docker push jheinecke/conllueditor:latest
 
 # docker exec -it conllueditor /bin/sh

README.md

@@ -9,23 +9,24 @@ The editor provides the following functionalities:
 * join/split/delete words (to correct tokenization errors)
 * join/split sentences (to correct segmentation errors)
 * undo/redo (partially)
-* search: forms, lemmas, UPOS, XPOS, deprels, sentences IDs and comments, sequences of any of these,
+* [search](#searching): forms, lemmas, UPOS, XPOS, deprels, sentences IDs and comments, sequences of any of these,
       searching for subtrees, importing subtrees from current sentence, sd-parse support
+* [searching by source file line numbers](#search-by-source-file-line-number)
 * edit non-CoNLL-U columns in a subset of [CoNLL-U plus files](http://universaldependencies.org/ext-format.html)
 * create multiword tokens from existing words or add a MWT to contract two ore more existing words
 * git support
 * export of dependency graphs as svg or LaTeX (for the [tikz-dependency](https://ctan.org/pkg/tikz-dependency) package or
   the [doc/deptree.sty](doc/deptree.sty) class, see [documentation](doc/deptree-doc.pdf))
 * prohibits invalid (cyclic) trees
 * Three edit modes: dependency trees, dependency «hedges» and a table edit mode
-* mass editing: modify tokens if a (complex) condition is satisfied
+* [mass editing](#mass-editing): modify tokens if a (complex) condition is satisfied
 * validation (using implications: _if conditions1 true then conditions2 must be true_)
 * sentence metadata editing
 * adding Translit= values to the MISC column (transliterating the FORM column) see section [Transliteration](#transliteration)
 * finding similar or identical sentence in a list of CoNLL-U files, see section [Find Similar Sentences](#find-similar-sentences)
-* configuring the UI on order to hide unneeded functionalities which otherwise clutter the UI
+* [configuring the UI](#ui-configuration) on order to hide unneeded functionalities which otherwise clutter the UI
 
-Current version: 2.29.4 (see [change history](CHANGES.md))
+Current version: 2.30.0 (see [change history](CHANGES.md))
 
 ConlluEditor can also be used as front-end to display the results of dependency parsing in the same way as the editor.
 * dependency tree/dependency hedge
@@ -390,6 +391,16 @@ Other search modes can be chosen with the search select bar (top rop right)
 * match like search (cf. [Grew Match](http://universal.grew.fr/[email protected]))
 * no search (to have less headers on top of the GUI)
 
+## Search by (source file) line number
+
+The search field on the top right permits to search a sentence by givening a line number of the edited `.conlu` file.
+The sentences in which this line number occurs is displayed. If the line number is not a comment line, the word which is on the line is highlighted.
+This can be useful to find lines output by the various UD validators. 
+If sentences are modified at change length (by splitting a word or joining two words, or by adding or deleting comment lines, the line numbers are adapted.
+Type in line number in field on the top right and click `line number`:
+
+![Search by line number](doc/search_line_number.png)
+
 ## Complex search and search and replace
 
 This opens a search and search-and-display field. The search fields provides a simple language to find sentences with one or several nodes (see [Mass Editing](doc/mass_editing.md))

gui/edit.js

@@ -441,25 +441,25 @@ function getServerInfo() {
             } else {
                 $('#save').hide();
             }
-            
+
             // deactivate buttons as defined in uiconfig.json
             console.log("UI", data.uiconfig);
             if (data.uiconfig) {
-                
+
                 if (data.uiconfig.right2left_show === "hidden") {
                     $("#r2l").hide();
-                } 
+                }
                 if (data.uiconfig.right2left_status === "active") {
                     showr2l = true;
                     $("#r2l").addClass('active');
                 } else {
                     showr2l = false;
                     $("#r2l").removeClass('active');
                 }
-                
+
                 if (data.uiconfig.features_show === "hidden") {
                     $("#feat2").hide();
-                } 
+                }
                 if (data.uiconfig.features_status === "active") {
                     showfeats = true;
                     $("#feat2").addClass('active');
@@ -477,7 +477,7 @@ function getServerInfo() {
                     showmisc = false;
                     $("#misc2").removeClass('active');
                 }
-                
+
                 if (data.uiconfig.display === "flat") {
                     graphtype = 2;
                     $("#flat3").val("flat");
@@ -488,7 +488,7 @@ function getServerInfo() {
                     graphtype = 1;
                     $("#flat3").val("tree");
                 }
-                
+
                 if (data.uiconfig.searchmode === "simple") {
                      $("#searchmode").val("simple");
                 }
@@ -503,12 +503,12 @@ function getServerInfo() {
                 }
                 $("#searchmode").click();
 
-                
+
                 if (data.uiconfig.shortcuts === "show") {
                     showshortcuthelp = false;
                     ToggleShortcutHelp();
                 }
-                
+
                 if (data.uiconfig.nodewidth_show === "hidden") {
                     $("#adaptwidth").removeClass('onlyWithTree');
                     $("#adaptwidth").hide();
@@ -521,8 +521,8 @@ function getServerInfo() {
                     $("#adaptwidth").click();
                     //$("#misc2").removeClass('active');
                 }
-                
-                
+
+
                 if (data.uiconfig.latex === "hidden") {
                     $("#latex").removeClass('onlyWithTree');
                     $("#latex").hide();
@@ -539,7 +539,7 @@ function getServerInfo() {
                     $("#json").removeClass('onlyWithTree');
                     $("#json").hide();
                 }
-                
+
             }
             // set version number to logo (shown if mouse hovers on the logo)
             //$('#logo').attr("title", data.version);
@@ -2547,6 +2547,8 @@ $(document).ready(function () {
             inputtext = "read last";
         } else if (this.id === "lire") {
             inputtext = "read " + ($("#sentid").val() - 1);
+        } else if (this.id === "lireln") {
+            inputtext = "line " + ($("#sentid_by_ln").val());
         } else if (this.id === "modifier") {
             var inputtext = "mod " + $("#mods").val();
         } else if (this.id === "valid") {

gui/index.html

@@ -131,6 +131,10 @@
                             <option value="grew">grew match</option>
                             <option value="hide">hide search</option>
                         </select>
+                        </span>
+
+                        <button class="editbuttons mybutton" id="lireln">line number</button>
+                        <input type="text" id="sentid_by_ln" class="inputfield" pattern="[1-9][0-9]*" size="5" value="1" >
                     </td>
                 </tr>
 

pom.xml

@@ -32,13 +32,13 @@
     THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
     author Johannes Heinecke
-    version 2.29.4 as of 21st February 2025
+    version 2.30.0 as of 12th April 2025
     -->
 
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.orange.labs</groupId>
     <artifactId>ConlluEditor</artifactId>
-    <version>2.29.4</version>
+    <version>2.30.0</version>
     <packaging>jar</packaging>
 
     <properties>

src/main/java/com/orange/labs/conllparser/ConllFile.java

@@ -1,6 +1,6 @@
 /* This library is under the 3-Clause BSD License
 
- Copyright (c) 2018-2024, Orange S.A.
+ Copyright (c) 2018-2025, Orange S.A.
 
  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:
@@ -28,7 +28,7 @@
  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
  @author Johannes Heinecke
- @version 2.27.0 as of 28th September 2024
+ @version 2.30.0 as of 12th April 2025
 */
 package com.orange.labs.conllparser;
 
@@ -82,36 +82,23 @@ public class ConllFile {
      * open CoNLL-U File and read its contents
      *
      * @param file CONLL file
-     * @param ignoreSentencesWithoutAnnot ignore sentences which do not have any
-     * information above columns 12
-     * @param ignoreSentencesWithoutTarget ignore sentences which do not have
-     * any target as annotation
      * @throws IOException
-     * @throws com.orange.labs.nlp.conllparser.ConllWord.ConllWordException
+     * @throws ConllException
      */
-    public ConllFile(File file/*, boolean ignoreSentencesWithoutAnnot, boolean ignoreSentencesWithoutTarget*/) throws IOException, ConllException {
+    public ConllFile(File file) throws IOException, ConllException {
         this.file = file;
         FileInputStream fis = new FileInputStream(file);
-        parse(fis /*, ignoreSentencesWithoutAnnot, ignoreSentencesWithoutTarget*/);
+        parse(fis);
         fis.close();
     }
 
     /**
-     *
-     * @param filecontents contenu du fichier COLL
-     * @param ignoreSentencesWithoutAnnot ignore sentences which do not have any
-     * information above columns 12
-     * @param ignoreSentencesWithoutTarget ignore sentences which do not have
-     * any target as annotation
+     * @param file
+     * @param cs class to use instead of ConllSentence (must be a subclass)
+
      * @throws ConllException
      * @throws IOException
      */
-//    public ConllFile(String filecontents/*, boolean ignoreSentencesWithoutAnnot, boolean ignoreSentencesWithoutTarget*/) throws ConllException, IOException {
-//        this.file = new File("__contents__");
-//        InputStream inputStream = new ByteArrayInputStream(filecontents.getBytes(StandardCharsets.UTF_8));
-//        parse(inputStream/*, ignoreSentencesWithoutAnnot, ignoreSentencesWithoutTarget*/);
-//    }
-
     public ConllFile(File file, Class<? extends ConllSentence> cs) throws IOException, ConllException {
         this.file = file;
         conllsentenceSubclass = cs;
@@ -316,6 +303,28 @@ public List<ConllSentence> getSentences() {
         return sentences;
     }
 
+    /** get the sentence which contains the linenumber ln (in the conllu file).
+     * if any sentence is modified we recalculate. For long files this can take some time
+     * @param ln the line number for which we search the sentence
+     * @return an arry of sentence number, position of the given line in the sentence, comments length
+    */
+    public int[] getSentence_with_line(int ln) {
+        int ends_after = 0;
+        int first_line = 1;
+        int sn = 0;
+        for (ConllSentence csent : sentences) {
+            ends_after += csent.get_source_length();
+            if (ends_after >= ln) {
+                int[] sn_offset = {sn, first_line, csent.get_comment_length()};
+
+                return sn_offset;
+            }
+            first_line = ends_after + 1;
+            sn++;
+        }
+        return null;
+    }
+
     public void addSentences(List<ConllSentence> s) {
         sentences.addAll(s);
     }