PeakInvestigator Java SDK

PeakInvestigator™ is advanced centroiding and deconvolution software services for mass spectrometry. This library provides an object-oriented interface to its public API.

License

License

GroupId

GroupId

com.veritomyx
ArtifactId

ArtifactId

peakinvestigator-sdk
Last Version

Last Version

5.4
Release Date

Release Date

Type

Type

jar
Description

Description

PeakInvestigator Java SDK
PeakInvestigator™ is advanced centroiding and deconvolution software services for mass spectrometry. This library provides an object-oriented interface to its public API.
Source Code Management

Source Code Management

https://github.com/Veritomyx/PeakInvestigator-Java-SDK

Download peakinvestigator-sdk

How to add to project

<!-- https://jarcasting.com/artifacts/com.veritomyx/peakinvestigator-sdk/ -->
<dependency>
    <groupId>com.veritomyx</groupId>
    <artifactId>peakinvestigator-sdk</artifactId>
    <version>5.4</version>
</dependency>
// https://jarcasting.com/artifacts/com.veritomyx/peakinvestigator-sdk/
implementation 'com.veritomyx:peakinvestigator-sdk:5.4'
// https://jarcasting.com/artifacts/com.veritomyx/peakinvestigator-sdk/
implementation ("com.veritomyx:peakinvestigator-sdk:5.4")
'com.veritomyx:peakinvestigator-sdk:jar:5.4'
<dependency org="com.veritomyx" name="peakinvestigator-sdk" rev="5.4">
  <artifact name="peakinvestigator-sdk" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.veritomyx', module='peakinvestigator-sdk', version='5.4')
)
libraryDependencies += "com.veritomyx" % "peakinvestigator-sdk" % "5.4"
[com.veritomyx/peakinvestigator-sdk "5.4"]

Dependencies

compile (4)

Group / Artifact Type Version
org.slf4j : slf4j-api jar 1.7.14
org.xeustechnologies : jtar jar 1.1
com.jcraft : jsch jar 0.1.53
com.googlecode.json-simple : json-simple jar 1.1.1

test (2)

Group / Artifact Type Version
junit : junit jar 4.12
org.mockito : mockito-core jar 1.10.19

Project Modules

There are no modules declared in this project.

PeakInvestigator-Java-SDK

A Java library for interacting with the PeakInvestigator™ public API (https://peakinvestigator.veritomyx.com/api).

Using the PeakInvestigatorSaaS library

The easiest way to add this library to your project is to pull it in via Maven:

<dependency>
  <groupId>com.veritomyx</groupId>
  <artifactId>peakinvestigator-sdk</artifactId>
  <version>5.4</version>
</dependency>

The general use is to create an instance of PeakInvestigatorSaaS, as well as instances of various "Actions" corresponding to the desired API calls to PeakInvestigator (see https://peakinvestigator.veritomyx.com/api for complete list), and call executeAction() on the desired action. For example, making a call to the PI_VERSIONS API can be accomplished with the following code:


import com.veritomyx.PeakInvestigatorSaaS;
import com.veritomyx.actions.*;

...

PeakInvestigatorSaaS webService = new PeakInvestigatorSaaS("peakinvestigator.veritomyx.com");
PiVersionsAction action = new PiVersionsAction("3.6", "username", "password");
String response = webService.executeAction(action);
action.processResponse(response);
String[] versions = action.getVersions();

...

Building

Maven is used for satisfying depdendencies and packaging a jar. This is as simple as executing the following command:

mvn package

Additional Information

For more information, including additional help with building and using the PeakInvestigtorSaaS library, contact [email protected].

com.veritomyx

Versions

Version
5.4
4.0