Package adams.flow.standalone

Class ExecSQL

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.standalone.AbstractStandalone

adams.flow.standalone.AbstractDbStandalone

adams.flow.standalone.ExecSQL

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DatabaseConnectionUser, VariableChangeListener, Actor, DryRunSupporter, ErrorHandler, Serializable, Comparable

public class ExecSQL
extends AbstractDbStandalone
implements DryRunSupporter

Executes a SQL statement, which does not return a result set, like INSERT, UPDATE, DELETE, CREATE.

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

-name <java.lang.String> (property: name)
    The name of the actor.
    default: ExecSQL
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 

-sql <adams.db.SQLStatement> (property: SQL)
    The SQL statement to run that generates the IDs.
    default: 
 

-dry-run <boolean> (property: dryRun)
    If enabled, the SQL statement is merely logged but not executed.
    default: false
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_DryRun	whether to simulate the SQL statement.
protected SQLStatement	m_SQL	the SQL statement to execute.

Fields inherited from class adams.flow.standalone.AbstractDbStandalone

m_DatabaseConnection

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
ExecSQL()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	dryRunTipText()	Returns the tip text for this property.
protected AbstractDatabaseConnection	getDatabaseConnection()	Determines the database connection in the flow.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection()	Returns the default database connection.
boolean	getDryRun()	Returns whether the statement is merely simulated.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
SQLStatement	getSQL()	Returns the SQL statement to run.
String	globalInfo()	Returns a string describing the object.
protected String	queryDatabase()	Performs the actual database query.
void	setDryRun(boolean value)	Sets whether to merely simulate the statement.
void	setSQL(SQLStatement value)	Sets the SQL statement to run.
String	SQLTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.AbstractDbStandalone

doExecute, initialize, setUpDatabaseConnection, wrapUp

Methods inherited from class adams.flow.standalone.AbstractStandalone

preExecute

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_SQL

protected SQLStatement m_SQL

the SQL statement to execute.

m_DryRun

protected boolean m_DryRun

whether to simulate the SQL statement.

Constructor Detail

ExecSQL

public ExecSQL()

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 AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setSQL

public void setSQL(SQLStatement value)

Sets the SQL statement to run.

Parameters:

value - the statement

getSQL

public SQLStatement getSQL()

Returns the SQL statement to run.

Returns:

the statement

SQLTipText

public String SQLTipText()

Returns the tip text for this property.

Returns:

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

setDryRun

public void setDryRun(boolean value)

Sets whether to merely simulate the statement.

Specified by:

setDryRun in interface DryRunSupporter

Parameters:

value - true if to simulate the statement

getDryRun

public boolean getDryRun()

Returns whether the statement is merely simulated.

Specified by:

getDryRun in interface DryRunSupporter

Returns:

true if only simulated

dryRunTipText

public String dryRunTipText()

Returns the tip text for this property.

Specified by:

dryRunTipText in interface DryRunSupporter

Returns:

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

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class AbstractDbStandalone

Returns:

the default database connection

getDatabaseConnection

protected AbstractDatabaseConnection getDatabaseConnection()

Determines the database connection in the flow.

Specified by:

getDatabaseConnection in class AbstractDbStandalone

Returns:

the database connection to use

queryDatabase

protected String queryDatabase()

Performs the actual database query.

Specified by:

queryDatabase in class AbstractDbStandalone

Returns:

null if everything is fine, otherwise error message