AbstractReportPreProcessor (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.report.AbstractReportPreProcessor<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

NoPreProcessing
```
public abstract class AbstractReportPreProcessor<T extends Report>
extends AbstractOptionHandler
```
Ancestor for Report pre-processors.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Actor m_Owner
the owning actor.
- 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

AbstractReportPreProcessor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`check(T data)`	Checks the data to pre-process.
`protected abstract T`	`doPreProcess(T data)`	Performs the actual pre-processing.
`Actor`	`getOwner()`	Returns the current owner of this preprocessor.
`T`	`preProcess(T data)`	Pre-processes the data.
`void`	`setOwner(Actor value)`	Sets the owner for this preprocessor.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Owner
```
protected Actor m_Owner
```
    the owning actor.
- Constructor Detail
  - AbstractReportPreProcessor
```
public AbstractReportPreProcessor()
```
- Method Detail
  - setOwner
```
public void setOwner(Actor value)
```
    Sets the owner for this preprocessor.
    
    Parameters:
    
    value - the owning actor
  - getOwner
```
public Actor getOwner()
```
    Returns the current owner of this preprocessor.
    
    Returns:
    
    the owning actor, null if not available
  - check
```
protected void check(T data)
```
    Checks the data to pre-process.
    
    Default implementation only checks whether data is present.
    
    Parameters:
    
    data - the data to check
  - doPreProcess
```
protected abstract T doPreProcess(T data)
```
    Performs the actual pre-processing.
    
    Parameters:
    
    data - the data to process
    
    Returns:
    
    the processed data
  - preProcess
```
public T preProcess(T data)
```
    Pre-processes the data.
    
    Parameters:
    
    data - the data to post-process
    
    Returns:
    
    the processed data