Skip to content

Commit

Permalink
Version 2.6.9 of gnormplus-ae. Use updated parameter description.
Browse files Browse the repository at this point in the history
And setting dependency version ranges.
  • Loading branch information
khituras committed Feb 23, 2024
1 parent a682d76 commit f26e26b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
8 changes: 6 additions & 2 deletions jcore-gnormplus-ae/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ Wrapper for the JULIE Lab variant of the GNormPlus gene ID mapper.

**1. Parameters**

Note that these are not all parameters but just those that are the least self-explanatory.

| Parameter Name | Parameter Type | Mandatory | Multivalued | Description |
|----------------|----------------|-----------|-------------|-------------|
| param1 | UIMA-Type | Boolean | Boolean | Description |
| param2 | UIMA-Type | Boolean | Boolean | Description |
| SkipUnchangedDocuments | Boolean | false | false | Whether GNormPlus should run on documents that exist in the database and have unchanged text contents. |
| AddToVisitKeys | Boolean | false | false | Whether to add the value of the `ToVisitKeys` parameter to the CAS. See description of `ToVisitKeys` for more details. |
| AddUnchangedDocumentTextFlag | Boolean | false | false | Whether to set a flag in the CAS that stores the information if the document text has changed in comparison to a potentially existing document in the database with the same document ID. Used by downstream components like the XMI DB Writer to manage actions depending on (un)changed text contents. |
| ToVisitKeys | String[] | false | true | The UIMA-aggregate-keys of the pipeline components that should still be visited if the document text is unchanged in comparison to a potentially existing document in the database with the same ID. In CoStoSys pipelines we want to run the DB Checkpoint AE in any way, unchanged document text or not, because we want to keep track of all documents if they have already been processed by the pipeline. |

**2. Predefined Settings**

Expand Down
8 changes: 4 additions & 4 deletions jcore-gnormplus-ae/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<version>2.6.1</version>
</parent>

<version>2.6.8</version>
<version>2.6.9</version>

<dependencies>
<dependency>
Expand All @@ -34,17 +34,17 @@
<dependency>
<groupId>de.julielab</groupId>
<artifactId>jcore-xmi-db-reader</artifactId>
<version>2.6.2</version>
<version>[2.6.2,2.7)</version>
</dependency>
<dependency>
<groupId>de.julielab</groupId>
<artifactId>jcore-xml-db-reader</artifactId>
<version>2.6.2</version>
<version>[2.6.2,2.7)</version>
</dependency>
<dependency>
<groupId>de.julielab</groupId>
<artifactId>jcore-pmc-db-reader</artifactId>
<version>2.6.2</version>
<version>[2.6.2,2.7)</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
</configurationParameter>
<configurationParameter>
<name>ToVisitKeys</name>
<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.</description>
<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 AddToVisitKeys is set to true, the document text hash is available in the database (see the AddShaHash parameter) and the hash in the database equals to the hash of the current document in the pipeline.</description>
<type>String</type>
<multiValued>true</multiValued>
<mandatory>false</mandatory>
Expand Down

0 comments on commit f26e26b

Please sign in to comment.