Ikey+: Identification key generator

Build Status master

Build Status develop

Authors :

• Thomas Burguiere ([email protected])
• Florian Causse ([email protected])
• Visotheary Ung ([email protected])
• Régine Vignes-Lebbe ([email protected])

Disclaimer

This is a fork of one of the app I worked on during my days at Laboratoire d'Informatique et Systématique (LIS) at Université Pierre et Marie Curie, Paris, France, from 2011 to 2013. The original source code is publicly available here and the corresponding publication is available there. This is still a work in progress on many aspects, the code is a bug-ridden mess, but it does work :).

What is this app doing?

This app generates single access identification keys, using SDD formatted file as input. SDD is an XML standard used in systematic biology to store descriptive data.

If your descriptive data is stored in the delta format you can convert it to sdd using the deltaToSdd webservice.

Building the ap

To build and use the app, you will need Apache Maven. Once you have maven installed, go to the root of the project, and run mvn package.

Usage

Java API

// setup generator config with default values
IkeyConfig config = IkeyConfig.builder().build();

// initialize SDD parser
SDDParser parser = new SDDSaxParser();
DataSet dataset = sddParser.parseDataset(sddURL, config);

// get key
IdentificationKeyGenerator generator = new IdentificationKeyGeneratorImpl();
SingleAccessKeyTree key = generator.getIdentificationKey(dataset, config);

// dump key to a file
boolean statisticsEnabled = true or false;
File resultFile = SingleAccessKeyTreeDumper
					.dumpFlatHtmlFile("result file header", key, statisticsEnabled, outputFolder);

REST API

Documentation coming soon...

Contributing

Feel free to contribute. If you don't know how, code coverage and code quality can always be improved.