Canadensys / narwhal-processor

Basic data processing library aiming to normalize similar values ​​in a known format.
MIT License
6 stars 7 forks source link

narwhal-processor

narwhal-processor is a processing library that normalizes data of a known type. Current and proposed data types that can be normalized include date, country name, continent, state and province, coordinates and numeric range (altitude, depth).

Comments, contributions, reviews and help are welcomed.

Code Status

Build Status

Note

This library is still under active development. Some parts may change based on the reviews, comments and usage. Do not hesitate to enter an Issue if you have any problems or questions.

Goal

The goal of this library is to provide a set of processing functions through a common Java interface that supports JavaBeans. This will ease the integration of the library in various biodiversity projects by providing a uniform way to access processing functions.

Scope

The narwhal-processor is meant to be used as a low-level processing library with few secondary or contextual validations. For example, given a date such as 1999-01-16, the output (if successful) will be parsed into day (16), month (01), and year (1999). However, if this date represents the date of collection, it is out of scope to determine the biological validity of Jan 16, 1999. The narwhal-processor only produces results from data that are without uncertainty.

Documentation and Usage

See our wiki for all the information.

Dependencies

Optional

Tested with Maven 3

Build

mvn clean package

Tests

Unit tests

mvn clean test

Setup in Eclipse

After a git clone

mvn eclipse:eclipse

In Eclipse : File/Import/Existing Projects into Workspace

You may need to add the maven repository to Eclipse's Build Path via Preferences > Java > Build Path > Classpath Variables by clicking the New button and adding the name M2_REPO and the directory. On a Mac, this is usually /Users/\<User>/.m2/repository.

Contributors

Narwhal Mythology

From Wikipedia: Some medieval Europeans believed narwhal tusks to be the horns from the legendary unicorn. As these horns were considered to have magic powers, such as the ability to cure poison and melancholia