Package ca.corefacility.bioinformatics.irida.service.impl

Class AnalysisTypesServiceImpl

java.lang.Object

ca.corefacility.bioinformatics.irida.service.impl.AnalysisTypesServiceImpl

All Implemented Interfaces:

AnalysisTypesService

@Component
public class AnalysisTypesServiceImpl
extends java.lang.Object
implements AnalysisTypesService

A service for managing registered AnalysisTypes.

Constructor Summary

Constructors

Constructor	Description
AnalysisTypesServiceImpl()	Builds a new default AnalysisTypesServiceImpl.

Method Summary

Modifier and Type	Method	Description
java.util.Set<AnalysisType>	executableAnalysisTypes()	Gets all executable AnalysisTypes.
AnalysisType	fromString(java.lang.String string)	Gets a AnalysisType from the given string.
java.util.Optional<java.lang.String>	getViewerForAnalysisType(AnalysisType analysisType)	Get the viewer for a given AnalysisType
boolean	isValid(AnalysisType analysisType)	Whether or not this analysis type is valid (has been registered).
void	registerDefaultTypes()	Register some default AnalysisTypes from the BuiltInAnalysisTypes list
void	registerRunnableType(AnalysisType type)	Register a new AnalysisType that can be run as a pipeline
void	registerRunnableType(AnalysisType type, java.lang.String viewer)	Register a new AnalysisType thatcna be run as a pipeline.
void	registerUnrunnableType(AnalysisType type)	Register an AnalysisType that cannot be run as a pipeline
java.util.Collection<AnalysisType>	values()	Gets all AnalysisTypes as a Collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisTypesServiceImpl

public AnalysisTypesServiceImpl()

Builds a new default AnalysisTypesServiceImpl.

Method Detail

executableAnalysisTypes

public java.util.Set<AnalysisType> executableAnalysisTypes()

Gets all executable AnalysisTypes.

Specified by:

executableAnalysisTypes in interface AnalysisTypesService

Returns:

All executable AnalysisTypes.

fromString

public AnalysisType fromString(java.lang.String string)

Gets a AnalysisType from the given string.

Specified by:

fromString in interface AnalysisTypesService

Parameters:

string - The string to match to the AnalysisType.

Returns:

The particular AnalysisType.

values

public java.util.Collection<AnalysisType> values()

Gets all AnalysisTypes as a Collection.

Specified by:

values in interface AnalysisTypesService

Returns:

All AnalysisTypes as a Collection.

isValid

public boolean isValid(AnalysisType analysisType)

Whether or not this analysis type is valid (has been registered).

Specified by:

isValid in interface AnalysisTypesService

Parameters:

analysisType - The AnalysisType.

Returns:

True if valid, false otherwise.

registerRunnableType

public void registerRunnableType(AnalysisType type)

Register a new AnalysisType that can be run as a pipeline

Specified by:

registerRunnableType in interface AnalysisTypesService

Parameters:

type - the AnalysisType to run

registerRunnableType

public void registerRunnableType(AnalysisType type,
                                 java.lang.String viewer)

Register a new AnalysisType thatcna be run as a pipeline. Include the name of a "viewer" that should be used for the results.

Specified by:

registerRunnableType in interface AnalysisTypesService

Parameters:

type - The AnalysisType to register

viewer - the name of the viewer to view results

registerUnrunnableType

public void registerUnrunnableType(AnalysisType type)

Register an AnalysisType that cannot be run as a pipeline

Specified by:

registerUnrunnableType in interface AnalysisTypesService

Parameters:

type - the AnalysisType to register

getViewerForAnalysisType

public java.util.Optional<java.lang.String> getViewerForAnalysisType(AnalysisType analysisType)

Get the viewer for a given AnalysisType

Specified by:

getViewerForAnalysisType in interface AnalysisTypesService

Parameters:

analysisType - the AnalysisType to get a viewer for

Returns:

an optional for the name of the viewer if it's available

registerDefaultTypes

public void registerDefaultTypes()

Register some default AnalysisTypes from the BuiltInAnalysisTypes list

Specified by:

registerDefaultTypes in interface AnalysisTypesService