localId -> name. Exclude plugin id from response.

jan-niestadt · jan-niestadt · commit a34093b807b4 · 2026-07-20T11:00:40.000+02:00
diff --git a/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFile.java b/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFile.java
@@ -12,7 +12,7 @@
 public class IndexSourceTypeFile extends IndexSourceType {
 
     @Override
-    public String localId() {
+    public String getName() {
         return "file";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFileInArchive.java b/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeFileInArchive.java
@@ -12,7 +12,7 @@
 public class IndexSourceTypeFileInArchive extends IndexSourceType {
 
     @Override
-    public String localId() {
+    public String getName() {
         return "archive";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeTest.java b/engine/src/main/java/nl/inl/blacklab/index/IndexSourceTypeTest.java
@@ -17,7 +17,7 @@
 public class IndexSourceTypeTest extends IndexSourceType {
 
     @Override
-    public String localId() {
+    public String getName() {
         return "test";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionAppend.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionAppend.java
@@ -31,7 +31,7 @@ public class ProcessingInstructionAppend extends ProcessingInstruction {
     private PluginParam parValue;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "append";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionConcatDate.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionConcatDate.java
@@ -34,7 +34,7 @@ public class ProcessingInstructionConcatDate extends ProcessingInstruction {
     private PluginParam parAutofill;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "concatDate";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIdentity.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIdentity.java
@@ -13,7 +13,7 @@
 public class ProcessingInstructionIdentity extends ProcessingInstruction {
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "identity";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIfEmpty.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionIfEmpty.java
@@ -29,7 +29,7 @@ public class ProcessingInstructionIfEmpty extends ProcessingInstruction {
     private PluginParam parSeparator;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "ifEmpty"; // "default" as well (old name)
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMapValues.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMapValues.java
@@ -18,7 +18,7 @@ public class ProcessingInstructionMapValues extends ProcessingInstruction {
     private PluginParam parTable;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "map";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMultiple.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionMultiple.java
@@ -15,7 +15,7 @@
 public class ProcessingInstructionMultiple extends ProcessingInstruction {
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "stmt-block"; // (not actually used in config files)
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionParsePos.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionParsePos.java
@@ -20,7 +20,7 @@ public class ProcessingInstructionParsePos extends ProcessingInstruction {
     private PluginParam parField;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "parsePos";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionReplace.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionReplace.java
@@ -27,7 +27,7 @@ public class ProcessingInstructionReplace extends ProcessingInstruction {
     private PluginParam parKeep;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "replace";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSort.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSort.java
@@ -14,7 +14,7 @@
 public class ProcessingInstructionSort extends ProcessingInstruction {
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "sort";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSplit.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionSplit.java
@@ -24,7 +24,7 @@ public class ProcessingInstructionSplit extends ProcessingInstruction {
     private PluginParam parKeep;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "split";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionStrip.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionStrip.java
@@ -19,7 +19,7 @@ public class ProcessingInstructionStrip extends ProcessingInstruction {
     private PluginParam parChars;
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "strip";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionUnique.java b/engine/src/main/java/nl/inl/blacklab/indexers/config/process/ProcessingInstructionUnique.java
@@ -13,7 +13,7 @@
 public class ProcessingInstructionUnique extends ProcessingInstruction {
 
     @Override
-    public synchronized String localId() {
+    public synchronized String getName() {
         return "unique";
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/HitGroupScorerType.java b/engine/src/main/java/nl/inl/blacklab/plugins/HitGroupScorerType.java
@@ -56,7 +56,7 @@ public enum Type {
      * @return collocate scorer
      */
     public HitGroupScorer getCollocationScorer(AnnotationSensitivity collocateAnnotation, Query filter, long totalFrequency, long wordFrequency) {
-        throw new PluginException("HitGroupScorerType " + localId() + " does not support collocation scoring");
+        throw new PluginException("HitGroupScorerType " + getName() + " does not support collocation scoring");
     }
 
 }
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/Plugin.java b/engine/src/main/java/nl/inl/blacklab/plugins/Plugin.java
@@ -60,10 +60,13 @@ public void initialize() throws PluginException {
     }
 
     /**
-     * Return the short id for this plugin.
+     * Return the unique id for this plugin.
+     * <p>
+     * No two plugins in the same instance may have the same id.
      * <p>
      * The id can be used to refer to the plugin in configuration files.
-     * You can also use the class name.
+     * You can also use the [full qualified] class name. If no explicit id is set,
+     * the simple class name will be used.
      * <p>
      * Note that we ignore this method for scripted plugins (e.g. Groovy) because
      * they're often returned as anonymous classes, so the default doesn't make sense.
@@ -72,30 +75,34 @@ public void initialize() throws PluginException {
      * Plugins can also be retrieved by their fully qualified class name and their
      * simple class name (if applicable, and in that order, after id has been checked).
      *
-     * @return the short id for this plugin, or null if it has none
+     * @return the unique id for this plugin, or null if it has none
      */
     public String getId() {
         return id;
     }
 
     /**
-     * Local (short) id for this plugin.
-     *
+     * Name for this plugin.
+     * <p>
+     * The plugin name should be unique among plugins of the same type,
+     * but there may be plugins of different types with the same name,
+     * e.g. a processing instruction and a query function with the same
+     * name. These must still have different ids, though.
+     * <p>
      * E.g. local id for QueryFunctionConcat would be "concat".
      * This is the id we can use to refer to the plugin if we
      * know the type of plugin, for example in a BCQL query.
      * If we ask for a QueryFunction "concat", we can resolve
      * this correctly and not accidentally return a
      * ProcessingInstruction "concat".
+     * <p>
+     * By default, returns the id, but either the plugin type base class
+     * (e.g. QueryFunction) or the plugin implementation could override this
+     * method to return an appropriate name.
      *
-     * By default, returns the id, but the plugin type base class
-     * (e.g. QueryFunction) should do something more intelligent, e.g.
-     * try to derive a short id from the id. Plugin implementations can
-     * always override the method to ensure the correct local id.
-     *
-     * @return the local (short) id for this plugin
+     * @return the plugin name
      */
-    public String localId() {
+    public String getName() {
         return getId();
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/PluginsOfType.java b/engine/src/main/java/nl/inl/blacklab/plugins/PluginsOfType.java
@@ -95,8 +95,8 @@ void register(Plugin plugin, BLConfigPlugins configs, String alternateId, boolea
             add(id, data);
         if (!StringUtils.isEmpty(alternateId) && !alternateId.equals(id))
             add(alternateId, data); // e.g. groovy script name without extension
-        if (!plugin.localId().equals(id)) // localId is e.g. function name, so "abs" for QueryFunctionAbs
-            add(plugin.localId(), data);
+        if (!plugin.getName().equals(id)) // e.g. function name, so "abs" for QueryFunctionAbs (unique for this plugin type)
+            add(plugin.getName(), data);
         if (registerClassName && !plugin.getClass().isAnonymousClass()) {
             if (!plugin.getClass().getName().contains("$")) // skip e.g. "Script1$1"
                 add(plugin.getClass().getName(), data);
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/ProcessingInstruction.java b/engine/src/main/java/nl/inl/blacklab/plugins/ProcessingInstruction.java
@@ -49,8 +49,8 @@ public static ProcessingStep fromConfig(ConfigProcessStep configProcessStep) {
     public abstract ProcessingStep get(PluginParams param);
 
     @Override
-    public String localId() {
-        return super.localId().replaceAll("^ProcessingInstruction", "").toLowerCase();
+    public String getName() {
+        return super.getName().replaceAll("^ProcessingInstruction", "").toLowerCase();
     }
 
 }
diff --git a/engine/src/main/java/nl/inl/blacklab/plugins/QueryFunction.java b/engine/src/main/java/nl/inl/blacklab/plugins/QueryFunction.java
@@ -33,8 +33,7 @@ public abstract class QueryFunction extends Plugin implements TextPattern.EvalRe
 
     /** Function name
      * <p>
-     * (this is the plugin's localId; id must be globally unique so cannot just be e.g. "abs"
-     *  or name collision would be likely) */
+     * Must be unique among QueryFunction plugins. The id, on the other hand, must be unique among all plugins. */
     private final String name;
 
     /** Parameter types */
@@ -70,7 +69,7 @@ public String getId() {
     }
 
     @Override
-    public String localId() {
+    public String getName() {
         return name;
     }
 
@@ -197,10 +196,6 @@ public boolean isRelationsFunction() {
         return relationsFunction;
     }
 
-    public String getName() {
-        return name;
-    }
-
     @Override
     public boolean equals(Object o) {
         if (!(o instanceof QueryFunction that))
diff --git a/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerDice.java b/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerDice.java
@@ -11,7 +11,7 @@ public class HitGroupScorerDice extends HitGroupScorerType {
     public static final String TYPE_ID = "coll-dice";
 
     @Override
-    public String localId() {
+    public String getName() {
         return TYPE_ID;
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSalience.java b/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSalience.java
@@ -11,7 +11,7 @@ public class HitGroupScorerSalience extends HitGroupScorerType {
     public static final String TYPE_ID = "coll-salience";
 
     @Override
-    public String localId() {
+    public String getName() {
         return TYPE_ID;
     }
 
diff --git a/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSize.java b/engine/src/main/java/nl/inl/blacklab/search/results/hitresults/HitGroupScorerSize.java
@@ -12,7 +12,7 @@ public class HitGroupScorerSize extends HitGroupScorerType {
     public static final String TYPE_ID = "coll-groupsize";
 
     @Override
-    public String localId() {
+    public String getName() {
         return TYPE_ID;
     }
 
diff --git a/query-parser/src/main/java/nl/inl/blacklab/queryParser/JsonParserProvider.java b/query-parser/src/main/java/nl/inl/blacklab/queryParser/JsonParserProvider.java
@@ -14,7 +14,7 @@
 public class JsonParserProvider extends QueryParserProvider {
 
     @Override
-    public String localId() {
+    public String getName() {
         return "json-bql";
     }
 
diff --git a/query-parser/src/main/java/nl/inl/blacklab/queryParser/contextql/ContextQLParserProvider.java b/query-parser/src/main/java/nl/inl/blacklab/queryParser/contextql/ContextQLParserProvider.java
@@ -8,7 +8,7 @@
 public class ContextQLParserProvider extends QueryParserProvider {
 
     @Override
-    public String localId() {
+    public String getName() {
         return "contextql";
     }
 
diff --git a/query-parser/src/main/java/nl/inl/blacklab/queryParser/corpusql/BcqlParserProvider.java b/query-parser/src/main/java/nl/inl/blacklab/queryParser/corpusql/BcqlParserProvider.java
@@ -9,7 +9,7 @@
 public class BcqlParserProvider extends QueryParserProvider {
 
     @Override
-    public String localId() {
+    public String getName() {
         return "corpusql";
     }
 
diff --git a/test/data/saved-responses/info/Server info page.json b/test/data/saved-responses/info/Server info page.json
diff --git a/test/data/saved-responses/info/server.json b/test/data/saved-responses/info/server.json
diff --git a/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResponseStreamer.java b/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResponseStreamer.java
diff --git a/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResultListPlugins.java b/wslib/src/main/java/nl/inl/blacklab/server/lib/results/ResultListPlugins.java

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`public class IndexSourceTypeFile extends IndexSourceType {`
`13`	`13`
`14`	`14`	`@Override`
`15`		`- public String localId() {`
	`15`	`+ public String getName() {`
`16`	`16`	`return "file";`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`public class IndexSourceTypeTest extends IndexSourceType {`
`18`	`18`
`19`	`19`	`@Override`
`20`		`- public String localId() {`
	`20`	`+ public String getName() {`
`21`	`21`	`return "test";`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public class ProcessingInstructionAppend extends ProcessingInstruction {`
`31`	`31`	`private PluginParam parValue;`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- public synchronized String localId() {`
	`34`	`+ public synchronized String getName() {`
`35`	`35`	`return "append";`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public class ProcessingInstructionConcatDate extends ProcessingInstruction {`
`34`	`34`	`private PluginParam parAutofill;`
`35`	`35`
`36`	`36`	`@Override`
`37`		`- public synchronized String localId() {`
	`37`	`+ public synchronized String getName() {`
`38`	`38`	`return "concatDate";`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`public class ProcessingInstructionIdentity extends ProcessingInstruction {`
`14`	`14`
`15`	`15`	`@Override`
`16`		`- public synchronized String localId() {`
	`16`	`+ public synchronized String getName() {`
`17`	`17`	`return "identity";`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public class ProcessingInstructionIfEmpty extends ProcessingInstruction {`
`29`	`29`	`private PluginParam parSeparator;`
`30`	`30`
`31`	`31`	`@Override`
`32`		`- public synchronized String localId() {`
	`32`	`+ public synchronized String getName() {`
`33`	`33`	`return "ifEmpty"; // "default" as well (old name)`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class ProcessingInstructionMapValues extends ProcessingInstruction {`
`18`	`18`	`private PluginParam parTable;`
`19`	`19`
`20`	`20`	`@Override`
`21`		`- public synchronized String localId() {`
	`21`	`+ public synchronized String getName() {`
`22`	`22`	`return "map";`
`23`	`23`	`}`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`public class ProcessingInstructionMultiple extends ProcessingInstruction {`
`16`	`16`
`17`	`17`	`@Override`
`18`		`- public synchronized String localId() {`
	`18`	`+ public synchronized String getName() {`
`19`	`19`	`return "stmt-block"; // (not actually used in config files)`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public class ProcessingInstructionParsePos extends ProcessingInstruction {`
`20`	`20`	`private PluginParam parField;`
`21`	`21`
`22`	`22`	`@Override`
`23`		`- public synchronized String localId() {`
	`23`	`+ public synchronized String getName() {`
`24`	`24`	`return "parsePos";`
`25`	`25`	`}`
`26`	`26`