Package adams.data.report

Class FilteredReportFilter<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.report.AbstractReportFilter<T>

adams.data.report.AbstractDatabaseConnectionReportFilter<T>

adams.data.report.FilteredReportFilter<T>

Type Parameters:

T - the type of data to pass through the filter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractReportFilter>, SizeOfHandler, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, Serializable, Comparable

public class FilteredReportFilter<T extends DataContainer>
extends AbstractDatabaseConnectionReportFilter<T>

This filter first pushes the data through the provided data filter before applying the actual report filter. The updated filter obtained from the report filter is then replaces the report of the original data container.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-data-filter <adams.data.filter.AbstractFilter [options]> (property: dataFilter)
    The filter to apply to the data before pushing it through the report filter.
    default: adams.data.filter.PassThrough
 

-report-filter <adams.data.report.AbstractReportFilter [options]> (property: reportFilter)
    The report filter to apply to the report.
    default: adams.data.report.PassThrough
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Filter	m_DataFilter	the pre-filter for filtering the data.
protected AbstractReportFilter	m_ReportFilter	the post-filter for filtering the report.

Fields inherited from class adams.data.report.AbstractDatabaseConnectionReportFilter

m_DatabaseConnection

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
FilteredReportFilter()

Method Summary

Modifier and Type	Method	Description
String	dataFilterTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
Filter	getDataFilter()	Returns the data filter.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection()	Returns the default database connection.
AbstractReportFilter	getReportFilter()	Returns the report filter.
String	globalInfo()	Returns a string describing the object.
protected T	processData(T data)	Processes the data/report.
String	reportFilterTipText()	Returns the tip text for this property.
void	setDataFilter(Filter value)	Sets the data filter.
void	setReportFilter(AbstractReportFilter value)	Sets the report filter.
protected void	updateDatabaseConnection()	Updates the database connection in dependent schemes.

Methods inherited from class adams.data.report.AbstractDatabaseConnectionReportFilter

getDatabaseConnection, initialize, setDatabaseConnection

Methods inherited from class adams.data.report.AbstractReportFilter

checkData, cleanUp, compareTo, equals, filter, forCommandLine, forName, getFilters, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, 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

Field Detail

m_DataFilter

protected Filter m_DataFilter

the pre-filter for filtering the data.

m_ReportFilter

protected AbstractReportFilter m_ReportFilter

the post-filter for filtering the report.

Constructor Detail

FilteredReportFilter

public FilteredReportFilter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class AbstractDatabaseConnectionReportFilter<T extends DataContainer>

Returns:

the default database connection

setDataFilter

public void setDataFilter(Filter value)

Sets the data filter.

Parameters:

value - the data filter

getDataFilter

public Filter getDataFilter()

Returns the data filter.

Returns:

the data filter

dataFilterTipText

public String dataFilterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setReportFilter

public void setReportFilter(AbstractReportFilter value)

Sets the report filter.

Parameters:

value - the report filter

getReportFilter

public AbstractReportFilter getReportFilter()

Returns the report filter.

Returns:

the report filter

reportFilterTipText

public String reportFilterTipText()

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 dependent schemes.

Overrides:

updateDatabaseConnection in class AbstractDatabaseConnectionReportFilter<T extends DataContainer>

processData

protected T processData(T data)

Processes the data/report.

Specified by:

processData in class AbstractReportFilter<T extends DataContainer>

Parameters:

data - the data to filter

Returns:

the filtered data