Version 2.5.6 of xml-db-reader. Updated parameter description.

JULIELab · Feb 23, 2024 · a682d76 · a682d76
1 parent 4c39381
commit a682d76
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/jcore-xml-db-reader/pom.xml b/jcore-xml-db-reader/pom.xml
@@ -18,7 +18,7 @@
         <version>2.6.3</version>
         <relativePath>../jedis-parent</relativePath>
     </parent>
-    <version>2.6.4</version>
+    <version>2.6.5</version>
     <dependencies>
         <dependency>
             <groupId>de.julielab</groupId>

diff --git a/jcore-xml-db-reader/src/main/java/de/julielab/jcore/reader/xml/XMLDBMultiplier.java b/jcore-xml-db-reader/src/main/java/de/julielab/jcore/reader/xml/XMLDBMultiplier.java
@@ -67,7 +67,7 @@ public class XMLDBMultiplier extends DBMultiplier {
     private String xmiStorageDataTable;
     @ConfigurationParameter(name = PARAM_TABLE_DOCUMENT_SCHEMA, mandatory = false, description = "For use with AnnotationDefinedFlowController. The name of the schema that the document table - given with the " + PARAM_TABLE_DOCUMENT + " parameter - adheres to. Only the primary key part is required for hash value retrieval.")
     private String xmiStorageDataTableSchema;
-    @ConfigurationParameter(name = PARAM_TO_VISIT_KEYS, mandatory = false, description = "For use with AnnotationDefinedFlowController. Specifies the delegate AE keys of the AEs this CAS should still applied on although the hash has not changed. Can be null or empty indicating that no component should be applied to the CAS. The task of the AnnotationDefinedFlowController is then to read those annotations and route the CAS accordingly.")
+    @ConfigurationParameter(name = PARAM_TO_VISIT_KEYS, mandatory = false, description = "For use with AnnotationDefinedFlowController. Specifies the delegate AE keys of the AEs this CAS should still applied on although the hash has not changed. Can be null or empty indicating that no component should be applied to the CAS. The task of the AnnotationDefinedFlowController is then to read those annotations and route the CAS accordingly. The parameter values will only be added to the CAS if " + PARAM_ADD_TO_VISIT_KEYS + " is set to true, the document text hash is available in the database (see the " + PARAM_ADD_SHA_HASH + " parameter) and the hash in the database equals to the hash of the current document in the pipeline.")
     private String[] toVisitKeys;
     @ConfigurationParameter(name = PARAM_ADD_TO_VISIT_KEYS, mandatory = false, description = "Toggles the creation of annotations for the AnnotationDefinedFlowController. Only needed when such a flow controller is used in the pipeline. For details, see the description of " + PARAM_TO_VISIT_KEYS + ".")
     private boolean addToVisitKeys;