io.github.msdk

Interface MSDKMethod<ResultType>

Type Parameters:

ResultType - Type of object that represents the result of this method. If the method has no result, Void can be used as a special case.

All Known Implementing Classes:

ADAP3DFeatureDetectionMethod, ChromaTofFileImportMethod, ChromatogramBuilderMethod, FeatureNormalizationByCompoundMethod, FeatureTableImportMethod, FingerIdWebMethod, GridMassMethod, IsotopeGrouperMethod, JoinAlignerMethod, LocalDatabaseSearchMethod, MgfFileExportMethod, MgfFileImportMethod, MSDKCentroidingMethod, MSDKFilteringMethod, MsMsDetectionMethod, MzDataFileImportMethod, MzDBFileImportMethod, MzMLFileExportMethod, MzMLFileImportMethod, MzTabFileExportMethod, MzTabFileImportMethod, MzXMLFileImportMethod, MzXMLFileParser, NetCDFFileExportMethod, NetCDFFileImportMethod, PeakInvestigatorScanBundlingMethod, PeakInvestigatorScanExtractingMethod, RansacAlignerMethod, RawDataFileImportMethod, SiriusIdentificationMethod, SrmDetectionMethod, TargetedDetectionMethod, ThermoRawImportMethod, WatersRawImportMethod

public interface MSDKMethod<ResultType>

This interface represents a method or algorithm of MSDK.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a running algorithm.
ResultType	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.
ResultType	getResult() Returns the result of this algorithm, or null.

Method Detail

getFinishedPercentage

@Nullable
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.

Returns:

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

execute

@Nullable
ResultType execute()
                      throws MSDKException

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

Returns:

the result of this algorithm, or null

Throws:

MSDKException - On any error

getResult

@Nullable
ResultType getResult()

Returns the result of this algorithm, or null.

Returns:

a ResultType object.

cancel

void cancel()

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