AbstractAnalysis (adams-pom 24.10.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.analysis.AbstractAnalysis<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractInstancesAnalysis
```
public abstract class AbstractAnalysis<T>
extends AbstractOptionHandler
```
Ancestor for data analysis classes.

Version:

$Revision$

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

AbstractAnalysis()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`analyze(T data)`	Performs the data analysis.
`protected void`	`check(T data)`	Hook method for checks.
`protected abstract String`	`doAnalyze(T data)`	Performs the actual analysis.

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
  - AbstractAnalysis
```
public AbstractAnalysis()
```
- Method Detail
  - check
```
protected void check(T data)
```
    Hook method for checks.
    
    Parameters:
    
    data - the data to check
  - doAnalyze
```
protected abstract String doAnalyze(T data)
                             throws Exception
```
    Performs the actual analysis.
    
    Parameters:
    
    data - the data to analyze
    
    Returns:
    
    null if successful, otherwise error message
    
    Throws:
    
    Exception - if analysis fails
  - analyze
```
public String analyze(T data)
```
    Performs the data analysis.
    
    Parameters:
    
    data - the data to analyze
    
    Returns:
    
    null if successful, otherwise error message