Package adams.flow.source

Class SQLIdSupplier

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.source.AbstractSource

adams.flow.source.AbstractArrayProvider

adams.flow.source.AbstractIdSupplier

adams.flow.source.AbstractDatabaseIdSupplier

adams.flow.source.SQLIdSupplier

All Implemented Interfaces:

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

public class SQLIdSupplier
extends AbstractDatabaseIdSupplier

Executes an SQL statement for generating the IDs.
Variables are automatically expanded.

Input/output:
- generates:
java.lang.Integer


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
 

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

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

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

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

-output-array (property: outputArray)
    Whether to output the IDs as array or one by one.
 

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

-type <INTEGER|STRING> (property: type)
    The type of IDs to generate.
    default: INTEGER
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SQLIdSupplier.Type	The type of IDs to output.

Field Summary

Fields

Modifier and Type	Field	Description
protected SQLStatement	m_SQL	the SQL statement to execute.
protected SQLIdSupplier.Type	m_Type	the type of IDs to generate.

Fields inherited from class adams.flow.source.AbstractDatabaseIdSupplier

m_DatabaseConnection

Fields inherited from class adams.flow.source.AbstractIdSupplier

m_Lenient

Fields inherited from class adams.flow.source.AbstractArrayProvider

m_Index, m_OutputArray, m_Queue

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected AbstractDatabaseConnection	getDatabaseConnection()	Determines the database connection in the flow.
protected ArrayList	getIDs(StringBuilder errors)	Returns the IDs from the database.
protected Class	getItemClass()	Returns the based class of the items.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
SQLStatement	getSQL()	Returns the SQL statement to run.
SQLIdSupplier.Type	getType()	Returns the type of IDs to generate.
String	globalInfo()	Returns a string describing the object.
void	setSQL(SQLStatement value)	Sets the SQL statement to run.
void	setType(SQLIdSupplier.Type value)	Sets the type of IDs to generate.
String	SQLTipText()	Returns the tip text for this property.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.source.AbstractDatabaseIdSupplier

doExecute, initialize, outputArrayTipText, setUpDatabaseConnection, wrapUp

Methods inherited from class adams.flow.source.AbstractIdSupplier

getLenient, lenientTipText, setLenient

Methods inherited from class adams.flow.source.AbstractArrayProvider

generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray

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, 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

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_Type

protected SQLIdSupplier.Type m_Type

the type of IDs to generate.

Constructor Detail

SQLIdSupplier

public SQLIdSupplier()

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 AbstractIdSupplier

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 AbstractIdSupplier

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.

setType

public void setType(SQLIdSupplier.Type value)

Sets the type of IDs to generate.

Parameters:

value - the type

getType

public SQLIdSupplier.Type getType()

Returns the type of IDs to generate.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

getItemClass

protected Class getItemClass()

Returns the based class of the items.

Overrides:

getItemClass in class AbstractDatabaseIdSupplier

Returns:

the class

getDatabaseConnection

protected AbstractDatabaseConnection getDatabaseConnection()

Determines the database connection in the flow.

Specified by:

getDatabaseConnection in class AbstractDatabaseIdSupplier

Returns:

the database connection to use

getIDs

protected ArrayList getIDs(StringBuilder errors)

Returns the IDs from the database.

Specified by:

getIDs in class AbstractIdSupplier

Parameters:

errors - for storing any error messages

Returns:

the IDs