Package com.dnanexus

Class DXAnalysis

java.lang.Object

com.dnanexus.DXObject

com.dnanexus.DXExecution

com.dnanexus.DXAnalysis

public final class DXAnalysis
extends DXExecution

An analysis object (a specific instantiation of a workflow).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DXAnalysis.Describe	Contains metadata about an analysis.

Field Summary

Fields inherited from class com.dnanexus.DXExecution

cachedDescribe

Fields inherited from class com.dnanexus.DXObject

dxId, env, MAPPER

Method Summary

Modifier and Type	Method	Description
DXAnalysis.Describe	describe()	Obtains metadata about the execution.
DXAnalysis.Describe	getCachedDescribe()	Returns metadata about the data object, like DXExecution.describe(), but without making an API call.
static DXAnalysis	getInstance(String analysisId)	Returns a DXAnalysis representing the specified analysis.
static DXAnalysis	getInstanceWithEnvironment(String analysisId, DXEnvironment env)	Returns a DXAnalysis representing the specified analysis using the specified environment.
<T> T	getOutput(Class<T> outputClass)	Returns the output of the execution, deserialized to the specified class.
void	terminate()	Terminates the execution.
DXAnalysis	waitUntilDone()	Waits until the analysis has successfully completed and is in the DONE state.

Methods inherited from class com.dnanexus.DXExecution

checkCachedDescribeAvailable

Methods inherited from class com.dnanexus.DXObject

apiCallOnObject, apiCallOnObject, equals, getId, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static DXAnalysis getInstance(String analysisId)

Returns a DXAnalysis representing the specified analysis.

Parameters:

analysisId - Analysis ID, of the form "analysis-xxxx"

Returns:

a DXAnalysis

Throws:

NullPointerException - If analysisId is null

getInstanceWithEnvironment

public static DXAnalysis getInstanceWithEnvironment(String analysisId,
                                                    DXEnvironment env)

Returns a DXAnalysis representing the specified analysis using the specified environment.

Parameters:

analysisId - Analysis ID, of the form "analysis-xxxx"

env - environment to use for making subsequent API calls

Returns:

a DXAnalysis

Throws:

NullPointerException - If analysisId or env is null

describe

public DXAnalysis.Describe describe()

Description copied from class: DXExecution

Obtains metadata about the execution.

Specified by:

describe in class DXExecution

Returns:

a Describe containing execution metadata

getCachedDescribe

public DXAnalysis.Describe getCachedDescribe()

Description copied from class: DXExecution

Returns metadata about the data object, like DXExecution.describe(), but without making an API call.

This cached describe info is only available if this object appears in the result of a DXSearch.findExecutions() call that specified DXSearch.FindExecutionsRequestBuilder.includeDescribeOutput(). The describe info that is returned reflects the state of the object at the time that the search was performed.

Specified by:

getCachedDescribe in class DXExecution

Returns:

a Describe containing the execution's metadata

getOutput

public <T> T getOutput(Class<T> outputClass)
                throws IllegalStateException

Description copied from class: DXExecution

Returns the output of the execution, deserialized to the specified class.

Specified by:

getOutput in class DXExecution

Parameters:

outputClass - class to deserialize to

Returns:

execution output

Throws:

IllegalStateException - if the execution is not in the DONE state.

terminate

public void terminate()

Description copied from class: DXExecution

Terminates the execution.

Specified by:

terminate in class DXExecution

waitUntilDone

public DXAnalysis waitUntilDone()
                         throws IllegalStateException

Waits until the analysis has successfully completed and is in the DONE state.

Specified by:

waitUntilDone in class DXExecution

Returns:

the same DXAnalysis object

Throws:

IllegalStateException - if the analysis reaches the FAILED or TERMINATED state