Interface RunDataProvider
-
- All Known Implementing Classes:
EmptyRunDataProvider
,IlluminaProcessedRunDataProvider
,IlluminaRawRunDataProvider
public interface RunDataProvider
This interface define a run data provider.- Since:
- 3.0
- Author:
- Laurent Jourdren
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
canProvideRunData()
Test if provider can provide RunDataDataStorage
getDataStorage()
Get the data storage of used by the provider.String
getName()
Get the name of the provider.void
init(DataStorage storage, Configuration conf, fr.ens.biologie.genomique.kenetre.log.GenericLogger logger)
Initialize the provider.default List<RunData>
listCompletedRunData()
List available completed runs.List<RunData>
listCompletedRunData(Collection<RunId> excludedRuns)
List available runs in progress.default List<RunData>
listInProgressRunData()
List available runs in progress.List<RunData>
listInProgressRunData(Collection<RunId> excludedRuns)
List available runs in progress.
-
-
-
Method Detail
-
getName
String getName()
Get the name of the provider.- Returns:
- the name of the provider
-
init
void init(DataStorage storage, Configuration conf, fr.ens.biologie.genomique.kenetre.log.GenericLogger logger) throws Aozan3Exception
Initialize the provider.- Parameters:
storage
- used for the sourceconf
- the configuration of the providerlogger
- the logger to use- Throws:
Aozan3Exception
- if an error occurs while initialize the provider
-
canProvideRunData
boolean canProvideRunData()
Test if provider can provide RunData- Returns:
- true if provider can provide RunData
-
listInProgressRunData
List<RunData> listInProgressRunData(Collection<RunId> excludedRuns)
List available runs in progress.- Parameters:
excludedRuns
- runs to exclude- Returns:
- a list of RunData
-
listInProgressRunData
default List<RunData> listInProgressRunData()
List available runs in progress.- Returns:
- a list of RunData
-
listCompletedRunData
List<RunData> listCompletedRunData(Collection<RunId> excludedRuns)
List available runs in progress.- Parameters:
excludedRuns
- runs to exclude- Returns:
- a list of RunData
-
listCompletedRunData
default List<RunData> listCompletedRunData()
List available completed runs.- Returns:
- a list of RunData
-
getDataStorage
DataStorage getDataStorage()
Get the data storage of used by the provider.- Returns:
- the DataStorage used by the provider
-
-