Package adams.core.option

Class AbstractOptionHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractActor, AbstractActorProcessor, AbstractActorSwapSuggestion, AbstractActorTemplate, AbstractAdamsExperimentReader, AbstractAdamsExperimentWriter, AbstractAnalysis, AbstractAnnotationCheck, AbstractAnnotationCleaner, AbstractAnnotationColors, AbstractAnnotationProcessor, AbstractAnnotationsDisplayGenerator, AbstractAnnotator, AbstractArchiveHandler, AbstractArchiveObjectAppender, AbstractAreaOverlap, AbstractArrayStatistic, AbstractArraySubsetGenerator, AbstractAutoCorrelation, AbstractBarcodeDecoder, AbstractBaselineCorrection, AbstractBinningAlgorithm, AbstractBinPostProcessing, AbstractBooleanCondition, AbstractBreakpoint, AbstractBuiltInShutdownHook, AbstractCellFinder, AbstractCellRenderingCustomizer, AbstractChartGenerator, AbstractChartGenerator, AbstractChartGenerator, AbstractClassAttributeHeuristic, AbstractClassifier, AbstractClassifierSetupProcessor, AbstractClipboardData, AbstractClusterer, AbstractClustererPostProcessor, AbstractColorGradientGenerator, AbstractColorProvider, AbstractColumnFinder, AbstractColumnFinder, AbstractColumnStatistic, AbstractCommand, AbstractComparison, AbstractConditions, AbstractConnection, AbstractConsoleApplication, AbstractContentHandler, AbstractControlChart, AbstractConversion, AbstractCropAlgorithm, AbstractDatabaseObjectWithOptionHandling, AbstractDataContainerPostProcessor, AbstractDataContainerPreProcessor, AbstractDataContainerReader, AbstractDataContainerStatistics, AbstractDataContainerWriter, AbstractDataPlotUpdater, AbstractDataPlugin, AbstractDataPoolPostProcessor, AbstractDataPreparation, AbstractDatasetGenerator, AbstractDatasetGenerator, AbstractDataTypeSetup, AbstractDbBackend, AbstractDenoiser, AbstractDetrend, AbstractDiscoveryHandler, AbstractDisplayType, AbstractDrawOperation, AbstractEmailReader, AbstractEmailWriter, AbstractEncloseActor, AbstractErrorPostProcessor, AbstractErrorScaler, AbstractExifTagOperation, AbstractExperiment, AbstractExperimentIO, AbstractExpressionEvaluator, AbstractExternalCommand, AbstractFeatureConverter, AbstractFileBasedDatasetGeneration, AbstractFileBasedDatasetPreparation, AbstractFileChangeMonitor, AbstractFileCompleteCheck, AbstractFilenameGenerator, AbstractFileSearchHandler, AbstractFileSplitter, AbstractFileSystemSearchlet, AbstractFileUseCheck, AbstractFilter, AbstractFilter, AbstractFinalModelGenerator, AbstractFitnessFunction, AbstractFlowExecutionListener, AbstractFlowGenerator, AbstractFlowReader, AbstractFlowRestartManager, AbstractFlowWriter, AbstractForecasterGenerator, AbstractGeneticAlgorithm, AbstractGroupExtractor, AbstractGroupUpdater, AbstractHelpGenerator, AbstractHitDetector, AbstractHostnameVerifier, AbstractIDExtractor, AbstractIDGenerator, AbstractIDUpdater, AbstractImageFeatureGenerator, AbstractImageFilterProvider, AbstractImageOverlay, AbstractImagePreparation, AbstractImageReader, AbstractImageSegmentationAnnotationReader, AbstractImageSegmentationAnnotationWriter, AbstractImageSegmentationContainerFilter, AbstractImageSegmentationContainerLayerOrder, AbstractImageSegmentationContainerOperation, AbstractImageSharpness, AbstractImageTransformer, AbstractImageWriter, AbstractIMAPOperation, AbstractIMAPOperation, AbstractIndexedSplitsRunsCompatibility, AbstractIndexedSplitsRunsEvaluation, AbstractIndexedSplitsRunsGenerator, AbstractIndexedSplitsRunsPredictions, AbstractIndexedSplitsRunsReader, AbstractIndexedSplitsRunsWriter, AbstractInitialSetupsProvider, AbstractInputStreamGenerator, AbstractInstanceEvaluator, AbstractInstanceGenerator, AbstractInteractionLoggingFilter, AbstractJAIWriter, AbstractJobRunner, AbstractKeyboardAction, AbstractLabelPlotter, AbstractLabelSelectorGenerator, AbstractLeftClickProcessor, AbstractListGenerator, AbstractListingOutput, AbstractLogEntryDialog, AbstractLogRecordFilter, AbstractLogRecordProcessor, AbstractLuminanceParameters, AbstractMapFilter, AbstractMarkerGenerator, AbstractMatrixStatistic, AbstractMerge, AbstractMerge, AbstractMetaDataColor, AbstractMetaDataExtractor, AbstractModelLoader, AbstractMoment, AbstractMouseClickAction, AbstractMouseClickAction, AbstractMouseClickProcessor, AbstractMouseMovementTracker, AbstractMultiImageOperation, AbstractMultiMapOperation, AbstractMultiMatrixOperation, AbstractMultiObjectExport, AbstractMultiSpreadSheetOperation, AbstractMultiTargetClassifier, AbstractMultiTargetRegressor, AbstractNegativeRegionsGenerator, AbstractNotesReader, AbstractNotesWriter, AbstractNotification, AbstractNotification, AbstractObjectCompare, AbstractObjectExporter, AbstractObjectFilter, AbstractObjectFinder, AbstractObjectHandler, AbstractObjectLocator, AbstractObjectOverlap, AbstractObjectReader, AbstractObjectWriter, AbstractOptimiser, AbstractOptionGroup, AbstractOptionTraverser, AbstractOutlierDetector, AbstractOutlierDetector, AbstractOutlinePlotter, AbstractOutputFormatter, AbstractOutputGenerator, AbstractOverlappingObjectRemoval, AbstractOverlay, AbstractPaintlet, AbstractPaintlet, AbstractPaintOperation, AbstractParameterMapReader, AbstractParameterMapWriter, AbstractPDFGenerator, AbstractPdfProclet, AbstractPermissionHandler, AbstractPixelSelectorOverlay, AbstractPlotColumn, AbstractPlotColumn, AbstractPlotGenerator, AbstractPlotProcessor, AbstractPlotRow, AbstractPlotRow, AbstractPlotSelectedRows, AbstractPlotSelectedRows, AbstractPLS, AbstractPointPreprocessor, AbstractPostFlowExecution, AbstractProcessCell, AbstractProcessCell, AbstractProcessColumn, AbstractProcessColumn, AbstractProcessRow, AbstractProcessRow, AbstractProcessSelectedRows, AbstractProcessSelectedRows, AbstractRandomization, AbstractRandomNumberGenerator, AbstractReaderGenerator, AbstractRealDistribution, AbstractRegressor, AbstractRelationNameHeuristic, AbstractRemoteCommandHandler, AbstractRemoteCommandProcessor, AbstractReportBasedOverlayHelper, AbstractReportFilter, AbstractReportPostProcessor, AbstractReportPreProcessor, AbstractReportReader, AbstractReportWriter, AbstractRequestHandler, AbstractResponseHandler, AbstractRestartOperation, AbstractResultsHandler, AbstractRowFinder, AbstractRowFinder, AbstractRowScore, AbstractRowStatistic, AbstractScatterPlotOverlay, AbstractScopeRestriction, AbstractScriptingEngine, AbstractScriptingHandler, AbstractSelectionProcessor, AbstractSelectionShapePainter, AbstractSendEmail, AbstractSequencePostProcessor, AbstractSerializedObjectViewer, AbstractSetupUpload, AbstractShapeGenerator, AbstractShapePlotter, AbstractShutdownHook, AbstractSimpleFormat, AbstractSimpleOptionHandler, AbstractSimpleOutput, AbstractSmoother, AbstractSplitGenerator, AbstractSplitGenerator, AbstractSplitter, AbstractSplitter, AbstractSpreadSheetFilter, AbstractSpreadSheetPreview, AbstractSpreadSheetReader, AbstractSpreadSheetWriter, AbstractStamper, AbstractStdErrProcessor, AbstractStdOutProcessor, AbstractStoppingCriterion, AbstractStratification, AbstractSubImagesGenerator, AbstractSubProcessEventTrigger, AbstractSummaryStatistic, AbstractTableCleanUp, AbstractTableUpgrade, AbstractTerminalApplication, AbstractTextReader, AbstractTextRenderer, AbstractTextWriter, AbstractTickGenerator, AbstractTimeseriesFeatureGenerator, AbstractTimeseriesSplitter, AbstractTool, AbstractTrigger, AbstractTrustManager, AbstractTypeMapper, AbstractValueDefinition, AbstractViewPlugin, AbstractViolationFinder, AbstractWatermark, AbstractWebSocketClientGenerator, AbstractWebSocketServerGenerator, AbstractWekaEnsembleGenerator, AbstractWekaEvaluationPostProcessor, AbstractWekaPackageManagerAction, AbstractWekaPackageManagerAction, AbstractWekaPackageManagerAction, AbstractWekaRepeatedCrossValidationOutput, AbstractWhiteBalanceAlgorithm, AbstractZScoreOverlay, ActorUsage, AxisPanelOptions, Binning, Binning, CommandRunner, EmailContact, FlowRunner, FlowSetup, FlowSetupRunner, Histogram, Histogram, JComponentWriter, JFreeChart, JFreeChart, KernelDensityEstimation, Listing, NumericStringCompare, ObjectRetriever, PropertiesToCode, RegExpColorProvider, RgbInNameColorProvider, SftpRemoteDirectorySetup, SimplePlot, SimplePlot, SmbRemoteDirectorySetup, TarArchiveManager, ZipArchiveManager

public abstract class AbstractOptionHandler
extends CustomLoggingLevelObject
implements OptionHandler, GlobalInfoSupporter

Abstract superclass for classes that handle options.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected OptionManager	m_OptionManager	for managing the available options.

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractOptionHandler()	Initializes the object.

Method Summary

Modifier and Type	Method	Description
void	cleanUpOptions()	Cleans up the options.
void	defineOptions()	Adds options to the internal list of options.
void	destroy()	Frees up memory in a "destructive" non-reversible way.
protected void	finishInit()	Finishes the initialization in the constructor.
protected LoggingLevel	getDefaultLoggingLevel()	Returns the default logging level to use.
OptionManager	getOptionManager()	Returns the option manager.
abstract String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	loggingLevelTipText()	Returns the tip text for this property.
protected OptionManager	newOptionManager()	Returns a new instance of the option manager.
protected void	reset()	Resets the scheme.
void	setLoggingLevel(LoggingLevel value)	Sets the logging level.
String	toCommandLine()	Returns the commandline string.
String	toString()	Returns a string representation of the options.

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

Field Detail

m_OptionManager

protected OptionManager m_OptionManager

for managing the available options.

Constructor Detail

AbstractOptionHandler

public AbstractOptionHandler()

Initializes the object.

Method Detail

globalInfo

public abstract String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Returns:

a description suitable for displaying in the gui

initialize

protected void initialize()

Initializes the members.

reset

protected void reset()

Resets the scheme. Derived classes must call this method in set-methods of parameters to assure the invalidation of previously generated data.

newOptionManager

protected OptionManager newOptionManager()

Returns a new instance of the option manager.

Returns:

the manager to use

defineOptions

public void defineOptions()

Adds options to the internal list of options. Derived classes must override this method to add additional options.

Specified by:

defineOptions in interface OptionHandler

finishInit

protected void finishInit()

Finishes the initialization in the constructor.

Initializes the logger again.

getOptionManager

public OptionManager getOptionManager()

Returns the option manager.

Specified by:

getOptionManager in interface OptionHandler

Returns:

the manager

cleanUpOptions

public void cleanUpOptions()

Cleans up the options.

Specified by:

cleanUpOptions in interface OptionHandler

destroy

public void destroy()

Frees up memory in a "destructive" non-reversible way.

Cleans up the options.

Specified by:

destroy in interface Destroyable

See Also:

cleanUpOptions()

getDefaultLoggingLevel

protected LoggingLevel getDefaultLoggingLevel()

Returns the default logging level to use.

Returns:

the logging level

setLoggingLevel

public void setLoggingLevel(LoggingLevel value)

Sets the logging level.

Specified by:

setLoggingLevel in interface LoggingLevelHandler

Overrides:

setLoggingLevel in class CustomLoggingLevelObject

Parameters:

value - the level

loggingLevelTipText

public String loggingLevelTipText()

Returns the tip text for this property.

Returns:

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

toString

public String toString()

Returns a string representation of the options.

Overrides:

toString in class Object

Returns:

a string representation

toCommandLine

public String toCommandLine()

Returns the commandline string.

Specified by:

toCommandLine in interface OptionHandler

Returns:

the commandline