Package adams.data.report

Class AbstractFilteredReportFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.report.AbstractReportFilter

adams.data.report.AbstractFilteredReportFilter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter, SizeOfHandler, Serializable, Comparable

public abstract class AbstractFilteredReportFilter
extends AbstractReportFilter

Ancestor for report filters that ensure that certain fields are retained in the output when applying a report filter.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractReportFilter	m_Filter	the report filter to apply.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
abstract String	filterTipText()	Returns the tip text for this property.
protected abstract AbstractField[]	getFields()	Returns the fields to keep.
AbstractReportFilter	getFilter()	Returns the filter to apply to the report.
abstract String	globalInfo()	Returns a string describing the object.
protected DataContainer	processData(DataContainer data)	Performs the actual filtering.
void	setFilter(AbstractReportFilter value)	Sets the filter to apply to the report.

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, initialize, 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_Filter

protected AbstractReportFilter m_Filter

the report filter to apply.

Constructor Detail

AbstractFilteredReportFilter

public AbstractFilteredReportFilter()

Method Detail

globalInfo

public abstract 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

setFilter

public void setFilter(AbstractReportFilter value)

Sets the filter to apply to the report.

Parameters:

value - the filter

getFilter

public AbstractReportFilter getFilter()

Returns the filter to apply to the report.

Returns:

the filter

filterTipText

public abstract String filterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getFields

protected abstract AbstractField[] getFields()

Returns the fields to keep.

processData

protected DataContainer processData(DataContainer data)

Performs the actual filtering.

Specified by:

processData in class AbstractReportFilter

Parameters:

data - the data to filter

Returns:

the filtered data