Package adams.data.filter
Class ReportFilter<T extends DataContainer>
-
- Type Parameters:
T- the type of data to filter
- All Implemented Interfaces:
CleanUpHandler,Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,ShallowCopySupporter<Filter>,SizeOfHandler,Filter<T>,DatabaseConnectionHandler,DatabaseConnectionProvider,DatabaseConnectionUser,Serializable,Comparable
public class ReportFilter<T extends DataContainer> extends AbstractDatabaseConnectionFilter<T>
A filter that modifies the reports of data containers being passed through. The supplied report filter updates/modifies the report.
Valid options are:
-D (property: debug) If set to true, scheme may output additional info to the console.-debug-out <java.io.File> (property: debugOutputFilePrefix) If the file is not pointing to a directory, then the filtered data gets dumped to a file with a filename consisting of this prefix, the database ID and the extension 'chrom'. default: .-filter <gcms.data.quantitation.AbstractReportFilter [options]> (property: filter) The filter to use for updating/modifying the quantitation report. default: gcms.data.quantitation.PassThrough -debug-out .Default options for gcms.data.quantitation.PassThrough (-filter/filter):-D (property: debug) If set to true, scheme may output additional info to the console.-debug-out <java.io.File> (property: debugOutputFilePrefix) If the file is not pointing to a directory, then the filtered data gets dumped to a file with a filename consisting of this prefix, the database ID and the extension 'chrom'. default: .- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter
AbstractFilter.FilterJob<T extends DataContainer>
-
-
Field Summary
Fields Modifier and Type Field Description protected AbstractReportFilter<T>m_Filterthe report filter.-
Fields inherited from class adams.data.filter.AbstractDatabaseConnectionFilter
m_DatabaseConnection
-
Fields inherited from class adams.data.filter.AbstractFilter
m_DontUpdateID
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description ReportFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddefineOptions()Adds options to the internal list of options.StringfilterTipText()Returns the tip text for this property.protected AbstractDatabaseConnectiongetDefaultDatabaseConnection()Returns the default database connection.AbstractReportFiltergetFilter()Returns the current filter.StringglobalInfo()Returns a string describing the object.protected TprocessData(T data)Performs the actual filtering.voidsetFilter(AbstractReportFilter value)Sets the filter to use.protected voidupdateDatabaseConnection()Updates the database connection in the filter.-
Methods inherited from class adams.data.filter.AbstractDatabaseConnectionFilter
getDatabaseConnection, initialize, setDatabaseConnection
-
Methods inherited from class adams.data.filter.AbstractFilter
checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel
-
Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine
-
-
-
-
Field Detail
-
m_Filter
protected AbstractReportFilter<T extends DataContainer> m_Filter
the report filter.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractFilter<T extends DataContainer>
-
getDefaultDatabaseConnection
protected AbstractDatabaseConnection getDefaultDatabaseConnection()
Returns the default database connection.- Specified by:
getDefaultDatabaseConnectionin classAbstractDatabaseConnectionFilter<T extends DataContainer>- Returns:
- the default database connection
-
setFilter
public void setFilter(AbstractReportFilter value)
Sets the filter to use.- Parameters:
value- the filter
-
getFilter
public AbstractReportFilter getFilter()
Returns the current filter.- Returns:
- the filter
-
filterTipText
public String filterTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the gui
-
updateDatabaseConnection
protected void updateDatabaseConnection()
Updates the database connection in the filter.- Overrides:
updateDatabaseConnectionin classAbstractDatabaseConnectionFilter<T extends DataContainer>
-
processData
protected T processData(T data)
Performs the actual filtering.- Specified by:
processDatain classAbstractFilter<T extends DataContainer>- Parameters:
data- the data to filter- Returns:
- the filtered data
-
-