io.github.msdk.spectra.peakinvestigator

Class PeakInvestigatorScanBundlingMethod

java.lang.Object

io.github.msdk.spectra.peakinvestigator.PeakInvestigatorScanBundlingMethod

All Implemented Interfaces:

MSDKMethod<File>

public class PeakInvestigatorScanBundlingMethod
extends Object
implements MSDKMethod<File>

This class represents a method for bundling scans for upload to PeakInvestigator software services.

Constructor Summary

Constructors

Constructor and Description
PeakInvestigatorScanBundlingMethod(RawDataFile rawDataFile) Constructor for PeakInvestigatorScanBundlingMethod.
PeakInvestigatorScanBundlingMethod(RawDataFile rawDataFile, File file) Constructor for PeakInvestigatorScanBundlingMethod.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a running algorithm.
File	execute() Performs the algorithm.
Float	getFinishedPercentage() Returns a number in the interval 0 to 1.0, representing the portion of the task that has completed, or null if the algorithm has not yet started.
File	getResult() Returns the result of this algorithm, or null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeakInvestigatorScanBundlingMethod

public PeakInvestigatorScanBundlingMethod(@Nonnull
                                          RawDataFile rawDataFile)
                                   throws IOException

Constructor for PeakInvestigatorScanBundlingMethod. A temporary file is created, which will be deleted on JVM exit.

Parameters:

rawDataFile - a RawDataFile object.

Throws:

IOException - if any.

PeakInvestigatorScanBundlingMethod

public PeakInvestigatorScanBundlingMethod(@Nonnull
                                          RawDataFile rawDataFile,
                                          @Nonnull
                                          File file)

Constructor for PeakInvestigatorScanBundlingMethod.

Parameters:

rawDataFile - a RawDataFile object.

file - a File object.

Method Detail

getFinishedPercentage

public Float getFinishedPercentage()

Returns a number in the interval 0 to 1.0, representing the portion of the task that has completed, or null if the algorithm has not yet started.

Specified by:

getFinishedPercentage in interface MSDKMethod<File>

Returns:

Finished percentage (0.0 to 1.0, inclusive), or null.

execute

public File execute()
             throws MSDKException

Performs the algorithm. This method may throw MSDKException or MSDKRuntimeException if error occurs.

Specified by:

execute in interface MSDKMethod<File>

Returns:

the result of this algorithm, or null

Throws:

MSDKException - On any error

getResult

public File getResult()

Returns the result of this algorithm, or null.

Specified by:

getResult in interface MSDKMethod<File>

Returns:

a ResultType object.

cancel

public void cancel()

Cancel a running algorithm. This method can be called from any thread.

Specified by:

cancel in interface MSDKMethod<File>