io.github.msdk.id.localdatabase

Class LocalDatabaseSearchMethod

java.lang.Object

io.github.msdk.id.localdatabase.LocalDatabaseSearchMethod

All Implemented Interfaces:

MSDKMethod<Void>

public class LocalDatabaseSearchMethod
extends Object
implements MSDKMethod<Void>

This class searches through a feature table to find hits in a local database using m/z and retention time values.

Constructor Summary

Constructors

Constructor and Description
LocalDatabaseSearchMethod(FeatureTable featureTable, List<SimpleIonAnnotation> ionAnnotations, MzTolerance mzTolerance, RTTolerance rtTolerance) Constructor for LocalDatabaseSearchMethod.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a running algorithm.
Void	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.
Void	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

LocalDatabaseSearchMethod

public LocalDatabaseSearchMethod(@Nonnull
                                 FeatureTable featureTable,
                                 @Nonnull
                                 List<SimpleIonAnnotation> ionAnnotations,
                                 @Nonnull
                                 MzTolerance mzTolerance,
                                 @Nonnull
                                 RTTolerance rtTolerance)

Constructor for LocalDatabaseSearchMethod.

Parameters:

featureTable - a FeatureTable object.

ionAnnotations - a List of IonAnnotation objects.

mzTolerance - an object

rtTolerance - a RTTolerance object.

Method Detail

execute

public Void execute()
             throws MSDKException

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

Specified by:

execute in interface MSDKMethod<Void>

Returns:

the result of this algorithm, or null

Throws:

MSDKException - On any error

getFinishedPercentage

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

Returns:

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

getResult

@Nullable
public Void getResult()

Returns the result of this algorithm, or null.

Specified by:

getResult in interface MSDKMethod<Void>

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<Void>