Package adams.data.outlier

Class Scripted

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.outlier.AbstractOutlierDetector

adams.data.outlier.AbstractScriptedOutlierDetector

adams.data.outlier.Scripted

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, FileBasedScripting, FileBasedScriptingWithOptions, ShallowCopySupporter, SizeOfHandler, OutlierDetector, Serializable, Comparable

public class Scripted
extends AbstractScriptedOutlierDetector

An outlier detector that uses any scripting handler for processing the data with a script located in the specified file.

Valid options are:

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-script <adams.core.io.PlaceholderFile> (property: scriptFile)
    The script file to load and execute.
    default: ${CWD}
 

-options <java.lang.String> (property: scriptOptions)
    The options for the script; must consist of 'key=value' pairs separated 
    by blanks; the value of 'key' can be accessed via the 'getAdditionalOptions
    ().getXYZ("key")' method in the script actor.
    default: 
 

-handler <adams.core.scripting.AbstractScriptingHandler> (property: handler)
    The handler to use for scripting.
    default: adams.core.scripting.Dummy
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.outlier.AbstractOutlierDetector

AbstractOutlierDetector.DetectorJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractScriptingHandler	m_Handler	the scripting handler to use.
protected AbstractOutlierDetector	m_OutlierDetectorObject	the loaded script object.

Fields inherited from class adams.data.outlier.AbstractScriptedOutlierDetector

m_ScriptFile, m_ScriptObject, m_ScriptOptions

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

Method Summary

Modifier and Type	Method	Description
protected void	checkData(DataContainer data)	The default implementation only checks whether there is any data set.
protected String	checkScriptObject()	Checks the script object.
void	defineOptions()	Adds options to the internal list of options.
void	destroy()	Frees up memory in a "destructive" non-reversible way.
AbstractScriptingHandler	getHandler()	Gets the handler to use for scripting.
String	globalInfo()	Returns a string describing the object.
String	handlerTipText()	Returns the tip text for this property.
protected String	loadScriptObject()	Loads the scripts object and sets its options.
protected List<String>	processData(DataContainer data)	Performs the actual filtering.
String	scriptOptionsTipText()	Returns the tip text for this property.
void	setHandler(AbstractScriptingHandler value)	Sets the handler to use for scripting.

Methods inherited from class adams.data.outlier.AbstractScriptedOutlierDetector

getScriptFile, getScriptOptions, initScriptObject, reset, scriptFileTipText, setScriptFile, setScriptOptions

Methods inherited from class adams.data.outlier.AbstractOutlierDetector

cleanUp, compareTo, detect, equals, forCommandLine, forName, getOutlierDetectors, getQuickInfo, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

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

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_OutlierDetectorObject

protected transient AbstractOutlierDetector m_OutlierDetectorObject

the loaded script object.

m_Handler

protected AbstractScriptingHandler m_Handler

the scripting handler to use.

Constructor Detail

Scripted

public Scripted()

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 AbstractScriptedOutlierDetector

scriptOptionsTipText

public String scriptOptionsTipText()

Returns the tip text for this property.

Specified by:

scriptOptionsTipText in interface FileBasedScriptingWithOptions

Overrides:

scriptOptionsTipText in class AbstractScriptedOutlierDetector

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setHandler

public void setHandler(AbstractScriptingHandler value)

Sets the handler to use for scripting.

Parameters:

value - the handler

getHandler

public AbstractScriptingHandler getHandler()

Gets the handler to use for scripting.

Returns:

the handler

handlerTipText

public String handlerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

loadScriptObject

protected String loadScriptObject()

Loads the scripts object and sets its options.

Specified by:

loadScriptObject in class AbstractScriptedOutlierDetector

Returns:

null if OK, otherwise the error message

checkScriptObject

protected String checkScriptObject()

Checks the script object.

Specified by:

checkScriptObject in class AbstractScriptedOutlierDetector

Returns:

null if OK, otherwise the error message

checkData

protected void checkData(DataContainer data)

The default implementation only checks whether there is any data set.

Overrides:

checkData in class AbstractScriptedOutlierDetector

Parameters:

data - the data to filter

processData

protected List<String> processData(DataContainer data)

Performs the actual filtering.

Specified by:

processData in class AbstractOutlierDetector

Parameters:

data - the data to filter

Returns:

the filtered data

destroy

public void destroy()

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

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class AbstractScriptedOutlierDetector

See Also:

AbstractOptionHandler.cleanUpOptions()