DataProcessor (Aozan 3.1 API)

All Known Implementing Classes:

AbstractIlluminaDemuxDataProcessor, Aozan2QCDataProcessor, Bcl2FastqIlluminaDemuxDataProcessor, BclConvertIlluminaDemuxDataProcessor, DiscoverNewIlluminaRunDataProcessor, DoradoONTBasecallingDataProcessor, EndIlluminaRunDataProcessor, GuppyONTBasecallingDataProcessor, IlluminaSyncDataProcessor, SyncDataProcessor
```
public interface DataProcessor
```
This interface defines a data processor

Since:

3.0

Author:

Laurent Jourdren

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface DataProcessor.ProcessResult
This interface define a process result

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Set<DataTypeFilter>`	`getInputRequirements()`	Get the input requirements of the processor.
`String`	`getName()`	Get the name of the processor.
`void`	`init(Configuration conf, fr.ens.biologie.genomique.kenetre.log.GenericLogger logger)`	Initialize the processor.
`DataProcessor.ProcessResult`	`process(InputData inputData, RunConfiguration conf)`	Process data.

- Method Detail
  - getName
```
String getName()
```
    Get the name of the processor.
    
    Returns:
    
    the name of the processor
  - init
```
void init(Configuration conf,
          fr.ens.biologie.genomique.kenetre.log.GenericLogger logger)
   throws Aozan3Exception
```
    Initialize the processor.
    
    Parameters:
    
    conf - the configuration of the processor
    
    logger - the logger to use
    
    Throws:
    
    Aozan3Exception - if an error occurs while initialize the processor
  - getInputRequirements
```
Set<DataTypeFilter> getInputRequirements()
```
    Get the input requirements of the processor.
    
    Returns:
    
    a set with input requirements
  - process
```
DataProcessor.ProcessResult process(InputData inputData,
                                    RunConfiguration conf)
                             throws Aozan3Exception
```
    Process data.
    
    Parameters:
    
    inputData - input run data
    
    conf - run configuration
    
    Returns:
    
    a ProcessResult object
    
    Throws:
    
    Aozan3Exception - if an error occurs while processing the data