Package adams.data.idextraction

Class Manual

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.idextraction.AbstractIDExtractor

adams.data.idextraction.Manual

All Implemented Interfaces:

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

public class Manual
extends AbstractIDExtractor

Just returns the supplied ID.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_ID	the manual ID.

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
Manual()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doExtractID(Object obj)	Extracts the ID from the object.
String	getID()	Returns the ID to use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Object obj)	Checks whether the data type is handled.
String	IDTipText()	Returns the tip text for this property.
void	setID(String value)	Sets the ID to use.

Methods inherited from class adams.data.idextraction.AbstractIDExtractor

check, extractID

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_ID

protected String m_ID

the manual ID.

Constructor Detail

Manual

public Manual()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setID

public void setID(String value)

Sets the ID to use.

Parameters:

value - the ID

getID

public String getID()

Returns the ID to use.

Returns:

the ID

IDTipText

public String IDTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractIDExtractor

Returns:

null if no info available, otherwise short string

handles

public boolean handles(Object obj)

Checks whether the data type is handled.

Parameters:

obj - the object to check

Returns:

true if handled

doExtractID

protected String doExtractID(Object obj)

Extracts the ID from the object.

Specified by:

doExtractID in class AbstractIDExtractor

Parameters:

obj - the object to process

Returns:

the extracted ID