https://github.com/averbis/hello-world-aggregated-pear

Hello World example of an aggregated annotator bundled as a PEAR package
https://github.com/averbis/hello-world-aggregated-pear

example pear uima

Last synced: 23 days ago
JSON representation

Hello World example of an aggregated annotator bundled as a PEAR package

• Host: GitHub
• URL: https://github.com/averbis/hello-world-aggregated-pear
• Owner: averbis
• License: apache-2.0
• Created: 2020-01-13T14:26:48.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2022-02-21T10:22:01.000Z (almost 3 years ago)
• Last Synced: 2024-05-07T18:28:15.148Z (8 months ago)
• Topics: example, pear, uima
• Language: Java
• Size: 46.9 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# hello-world-aggregated-pear [![Build Status](https://travis-ci.com/averbis/hello-world-aggregated-pear.svg?branch=master)](https://travis-ci.com/averbis/hello-world-aggregated-pear)

An Apache UIMA Hello World Annotator aggregating two annotators bundled as a PEAR package.

A PEAR package is a way of packaging text analysis components and their resources for use with the Apache UIMA

framework. Every PEAR can contain additional Java libraries and UIMA knows how to keep PEARs separate from each

other such that there are no problems if two different PEARs use incompatible versions of some library.

This project provides a minimal example how to build an aggregated analysis engine and how to bundle it as a self 

contained UIMA PEAR package.

## Build prerequisites

- JDK 1.8 or later

- Maven 

## Build instructions

    mvn clean install

The Maven build process performs of the following steps:

- Compile the two UIMA components `SimpleSentenceAnnotator` and SimpleTokenAnnotator` included in this project.

- Generate a UIMA aggregate analysis engine descriptor (pipeline) using the `GenerateAggregateAnalysisDescriptor` class

  included in this project. This pipeline becomes the top-level analysis component of the PEAR - i.e. what is executed

  when the PEAR is invoked by UIMA.

- Uses the Apache UIMA `PearPackagingMavenPlugin` to generate a PEAR file consisting of the two UIMA components included in this 

  project, all required dependencies (in particular the Averbis type system which is used by the components) and the 

  UIMA aggregate analysis engine descriptor generated in the previous step. The file is written to the `target` folder. 

- Executes the `PearPackageIntegrationTest` which uses Apache UIMA which temporarily installs the PEAR file, uses it to 

  process a sample document, and verifies that the expected `Token` and `Sentence` annotations have been created.