Package adams.flow.processor

Class CheckPlaceholders

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.CheckPlaceholders

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, CheckProcessor, GraphicalOutputProducingProcessor, Serializable, Comparable<ActorProcessor>

public class CheckPlaceholders
extends AbstractActorProcessor
implements GraphicalOutputProducingProcessor, CheckProcessor

Checks whether all placeholder files/dirs can be expanded, i.e., whether all placeholders are actually defined.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	m_Warnings	the invalid placeholders (invalid placeholderfile/dir).

Fields inherited from class adams.flow.processor.AbstractActorProcessor

m_Errors

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

Method Summary

Modifier and Type	Method	Description
Component	getGraphicalOutput()	Returns the graphical output that was generated.
String	getTitle()	Returns the title for the dialog.
String	getWarningHeader()	Returns the string that explains the warnings.
String	getWarnings()	Returns the warnings, if any, resulting from the check.
String	globalInfo()	Returns a string describing the object.
boolean	hasGraphicalOutput()	Returns whether graphical output was generated.
protected void	initialize()	Initializes the members.
protected void	processActor(Actor actor)	Performs the actual processing.

Methods inherited from class adams.flow.processor.AbstractActorProcessor

addError, addError, checkData, compareTo, equals, getErrors, hasErrors, process, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.processor.ActorProcessor

compareTo, getErrors, hasErrors, process, shallowCopy, shallowCopy

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, defineOptions, getOptionManager, toCommandLine

Field Detail

m_Warnings

protected List<String> m_Warnings

the invalid placeholders (invalid placeholderfile/dir).

Constructor Detail

CheckPlaceholders

public CheckPlaceholders()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActorProcessor

processActor

protected void processActor(Actor actor)

Performs the actual processing.

Specified by:

processActor in class AbstractActorProcessor

Parameters:

actor - the actor to process

See Also:

ModifyingProcessor

hasGraphicalOutput

public boolean hasGraphicalOutput()

Returns whether graphical output was generated.

Specified by:

hasGraphicalOutput in interface GraphicalOutputProducingProcessor

Returns:

true if graphical output was generated

getWarningHeader

public String getWarningHeader()

Returns the string that explains the warnings.

Specified by:

getWarningHeader in interface CheckProcessor

Returns:

the heading for the warnings, null if not available

getWarnings

public String getWarnings()

Returns the warnings, if any, resulting from the check.

Specified by:

getWarnings in interface CheckProcessor

Returns:

the warnings, null if no warnings.

getTitle

public String getTitle()

Returns the title for the dialog.

Specified by:

getTitle in interface GraphicalOutputProducingProcessor

Returns:

the title

getGraphicalOutput

public Component getGraphicalOutput()

Returns the graphical output that was generated.

Specified by:

getGraphicalOutput in interface GraphicalOutputProducingProcessor

Returns:

the graphical output