AbstractMapFilter (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.mapfilter.AbstractMapFilter

All Implemented Interfaces:

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

Direct Known Subclasses:

PassThrough, RemoveByName
```
public abstract class AbstractMapFilter
extends AbstractOptionHandler
```
Ancestor for map filters.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- 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

AbstractMapFilter()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(Map map)`	Hook method for checking the map before filtering it.
`protected abstract Map`	`doFilterMap(Map map)`	Filters the map.
`Map`	`filterMap(Map map)`	Filters the map.

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

- Constructor Detail
  - AbstractMapFilter
```
public AbstractMapFilter()
```
- Method Detail
  - check
```
protected String check(Map map)
```
    Hook method for checking the map before filtering it.
    
    Parameters:
    
    map - the map to check
    
    Returns:
    
    null if checks passed, otherwise error message
  - doFilterMap
```
protected abstract Map doFilterMap(Map map)
```
    Filters the map.
    
    Parameters:
    
    map - the map to filter
    
    Returns:
    
    the filtered map
  - filterMap
```
public Map filterMap(Map map)
```
    Filters the map.
    
    Parameters:
    
    map - the map to filter
    
    Returns:
    
    the filtered map