Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/averbis/pear-archetype
Template to create PEAR packaged UIMA annotators in Java
https://github.com/averbis/pear-archetype
Last synced: about 1 month ago
JSON representation
Template to create PEAR packaged UIMA annotators in Java
- Host: GitHub
- URL: https://github.com/averbis/pear-archetype
- Owner: averbis
- License: apache-2.0
- Created: 2019-05-22T12:23:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-05T09:48:13.000Z (about 3 years ago)
- Last Synced: 2024-05-07T18:28:15.593Z (8 months ago)
- Language: Java
- Size: 63.5 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pear-archetype [](https://travis-ci.com/averbis/pear-archetype) 
Project template to bootstrap UIMA annotators written in Java and package them as a PEAR package.
## Prerequisites
- JDK 1.8 or later
- Maven
## Generate a new UIMA Java Annotator Project
New Java UIMA annotator projects with PEAR packaging can be generated with the following maven command:
```
mvn archetype:generate -DarchetypeGroupId=de.averbis.textanalysis -DarchetypeArtifactId=pear-archetype -DarchetypeVersion=2.0.2
```
You need to define a [groupId, artifactId and version](https://maven.apache.org/guides/mini/guide-naming-conventions.html) for your UIMA annotator project.
1. Specify a `groupId` for the project. It must follow [Java's package name rules](https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html).
```
Define value for property 'groupId': com.example
```
2. Define an `artifactId` for the project. It should consist of lowercase letters and must not contain special characters or dots.
```
Define value for property 'artifactId': my-annotator
```
3. Define a `version` for your UIMA annotator.
```
Define value for property 'version' 1.0-SNAPSHOT: 1.0
```
4. Define a `package` for your UIMA Java annotator. It must follow [Java's package name rules](https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html).
```
Define value for property 'package': com.example.nlp
```
5. Define a `annotatorClassName` for your annotator. It should always begin with a capital letter and must not contain any special characters or space characters. If there are multiple words in the `annotatorClassName`, then each word should start with a capital letter.
```
Define value for property 'annotatorClassName' Myannotator: MyAnnotator
```
6. Review and confirm the annotator configuration:
```
Confirm properties configuration:
groupId: com.example
artifactId: my-annotator
version: 1.0
package: com.example.nlp
annotatorClassName: MyAnnotator
Y: : y
```
(optional) Likewise the project can be generated in non-interactive mode with the following command:
```
mvn archetype:generate -DgroupId=com.example -DartifactId=my-annotator -Dversion=1.0 -Dpackage=com.example.nlp -DannotatorClassName=MyAnnotator -DarchetypeGroupId=de.averbis.textanalysis -DarchetypeArtifactId=pear-archetype -DarchetypeVersion=2.0.2 -DinteractiveMode=false
```
## Result
This will generate a UIMA annotator project structure within the `my-annotator` directory:
```
my-annotator/
├── pom.xml
└── src
├── main
│ ├── java
│ │ └── com
│ │ └── example
│ │ └── nlp
│ │ └── MyAnnotator.java
│ └── resources
│ ├── com
│ │ └── example
│ │ └── nlp
│ │ └── MyAnnotatorTypesystem.xml
│ └── META-INF
│ └── org.apache.uima.fit
│ └── types.txt
└── test
└── java
└── com
└── example
└── nlp
└── PearPackageIT.java
```
## Build the generated Annotator Project
Navigate into the project directory:
```
cd my-annotator
```
Build the annotator project with maven:
```
mvn clean install
```
This will assemble a PEAR package in the target directory.
```
target/my-annotator-1.0.pear
```