AbstractThreeWayDataTrainPostProcessor (adams-spectral-base-pom 25.9.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.threewaydatatrain.AbstractThreeWayDataTrainPostProcessor

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

ParafacLossHistory, PassThrough
```
public abstract class AbstractThreeWayDataTrainPostProcessor
extends adams.core.option.AbstractOptionHandler
```
Ancestor for post-processors of a model generated by ThreeWayDataTrain.

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

AbstractThreeWayDataTrainPostProcessor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract boolean`	`canHandle(nz.ac.waikato.cms.adams.multiway.algorithm.api.AbstractAlgorithm algorithm)`	Returns whether the algorithm can be handle.
`protected String`	`check(ThreeWayDataModelContainer cont)`	Hook method for checking container before post-processing it.
`protected abstract String`	`doPostProcess(ThreeWayDataModelContainer cont)`	Post-processes the container.
`String`	`postProcess(ThreeWayDataModelContainer cont)`	Post-processes the container.

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
  - AbstractThreeWayDataTrainPostProcessor
```
public AbstractThreeWayDataTrainPostProcessor()
```
- Method Detail
  - canHandle
```
public abstract boolean canHandle(nz.ac.waikato.cms.adams.multiway.algorithm.api.AbstractAlgorithm algorithm)
```
    Returns whether the algorithm can be handle.
    
    Parameters:
    
    algorithm - the algorithm to check
    
    Returns:
    
    true if handled
  - check
```
protected String check(ThreeWayDataModelContainer cont)
```
    Hook method for checking container before post-processing it.
    
    Parameters:
    
    cont - the container to check
    
    Returns:
    
    null if successful, otherwise error message
  - doPostProcess
```
protected abstract String doPostProcess(ThreeWayDataModelContainer cont)
```
    Post-processes the container.
    
    Parameters:
    
    cont - the container to post-process
    
    Returns:
    
    null if successful, otherwise error message
  - postProcess
```
public String postProcess(ThreeWayDataModelContainer cont)
```
    Post-processes the container.
    
    Parameters:
    
    cont - the container to post-process
    
    Returns:
    
    null if successful, otherwise error message