Package fr.ens.biologie.genomique.aozan.tests.sample

Class AbstractSampleTest

java.lang.Object

fr.ens.biologie.genomique.aozan.tests.sample.AbstractSampleTest

All Implemented Interfaces:

AozanTest, SampleTest

Direct Known Subclasses:

AbstractFastQCSampleTest, AbstractSimpleSampleTest, BasePFMeanQualityScoreSampleTest, ClusterRecoveryReportSampleTest, FastQScreenReportSampleTest, InLanePercentSampleTest, PFPercentSampleTest, Q30PercentSampleTest, RecoverablePFClusterPercentSampleTest, RecoverableRawClusterPercentSampleTest

public abstract class AbstractSampleTest
extends Object
implements SampleTest

This class define a abstract sample test.

Since:

0.8

Author:

Laurent Jourdren

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSampleTest(String name, String description, String columnName)	Constructor that set the field of this abstract test.
protected	AbstractSampleTest(String name, String description, String columnName, String unit)	Constructor that set the field of this abstract test.

Method Summary

Modifier and Type	Method	Description
String	getColumnName()	Get the column name of the test in the QC result file.
String	getDescription()	Get the description of the test.
String	getName()	Get the name of the test.
String	getUnit()	Get the unit of the result of the test.
void	init()	Initialize the test.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.ens.biologie.genomique.aozan.tests.AozanTest

configure, getCollectorsNamesRequiered

Methods inherited from interface fr.ens.biologie.genomique.aozan.tests.sample.SampleTest

test

Constructor Detail

AbstractSampleTest

protected AbstractSampleTest(String name,
                             String description,
                             String columnName)

Constructor that set the field of this abstract test.

Parameters:

name - name of the test

description - description of the test

columnName - column name of the test

AbstractSampleTest

protected AbstractSampleTest(String name,
                             String description,
                             String columnName,
                             String unit)

Constructor that set the field of this abstract test.

Parameters:

name - name of the test

description - description of the test

columnName - column name of the test

unit - unit of the test

Method Detail

getName

public String getName()

Description copied from interface: AozanTest

Get the name of the test.

Specified by:

getName in interface AozanTest

Returns:

the name of the test

getDescription

public String getDescription()

Description copied from interface: AozanTest

Get the description of the test.

Specified by:

getDescription in interface AozanTest

Returns:

the description of the test

getColumnName

public String getColumnName()

Description copied from interface: AozanTest

Get the column name of the test in the QC result file.

Specified by:

getColumnName in interface AozanTest

Returns:

the coloumn name of the test

getUnit

public String getUnit()

Description copied from interface: AozanTest

Get the unit of the result of the test.

Specified by:

getUnit in interface AozanTest

Returns:

the unit of the result of the test

init

public void init()

Description copied from interface: AozanTest

Initialize the test.

Specified by:

init in interface AozanTest