AbstractIDExtractor (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.idextraction.AbstractIDExtractor

All Implemented Interfaces:

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

Direct Known Subclasses:

Manual, Null, ReportField, SpreadSheetCell
```
public abstract class AbstractIDExtractor
extends AbstractOptionHandler
implements IDExtractor
```
Ancestor for schemes that extract the ID from objects.

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

AbstractIDExtractor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(Object obj)`	Performs checks on the object.
`protected abstract String`	`doExtractID(Object obj)`	Extracts the ID from a object.
`String`	`extractID(Object obj)`	Extracts the ID from a object.
`String`	`getQuickInfo()`	Returns a quick info about the object, which can be displayed in the GUI.

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.Destroyable
destroy

Methods inherited from interface adams.data.idextraction.IDExtractor
handles

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

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Constructor Detail
  - AbstractIDExtractor
```
public AbstractIDExtractor()
```
- Method Detail
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the object, which can be displayed in the GUI.
    Default implementation returns null.
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Returns:
    
    null if no info available, otherwise short string
  - check
```
protected String check(Object obj)
```
    Performs checks on the object.
    
    Parameters:
    
    obj - the object to check
    
    Returns:
    
    null if successful, otherwise error message
  - doExtractID
```
protected abstract String doExtractID(Object obj)
```
    Extracts the ID from a object.
    
    Parameters:
    
    obj - the object to process
    
    Returns:
    
    the extracted ID, null if failed to extract or not handled
  - extractID
```
public String extractID(Object obj)
```
    Extracts the ID from a object.
    
    Specified by:
    
    extractID in interface IDExtractor
    
    Parameters:
    
    obj - the object to process
    
    Returns:
    
    the extracted ID, null if failed to extract or not handled