Package adams.core.option

Class DatabaseActorExecutionClassProducer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.option.AbstractOptionProducer<O,I>

adams.core.option.AbstractRecursiveOptionProducer<O,I>

adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling<String,String>

adams.core.option.AbstractJavaCodeProducer

adams.core.option.AbstractActorJavaCodeProducer

adams.core.option.ActorExecutionClassProducer

adams.core.option.DatabaseActorExecutionClassProducer

All Implemented Interfaces:

CleanUpHandler, Destroyable, FileFormatHandler, LoggingSupporter, OptionHandler, OptionProducer<String,String>, OptionProducerWithOptionHandling<String,String>, RecursiveOptionProducer, PasswordSupporter, SizeOfHandler, Serializable

public class DatabaseActorExecutionClassProducer
extends ActorExecutionClassProducer
implements PasswordSupporter

Generates a wrapper for an actor that works in conjunction with a database.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BasePassword	m_Password	the database password.
protected String	m_URL	the database URL.
protected String	m_User	the database user.

Fields inherited from class adams.core.option.AbstractJavaCodeProducer

JAVA_KEYWORDS, m_AdditionalImportsInsertLocation, m_Copyright, m_Indentation, m_JavaKeywords, m_OutputBuffer, m_OutputDefaultValues, m_Package, m_ShortenedImports, m_SimpleName, m_VarNames

Fields inherited from class adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling

m_OptionManager

Fields inherited from class adams.core.option.AbstractRecursiveOptionProducer

m_Nesting

Fields inherited from class adams.core.option.AbstractOptionProducer

m_Input, m_LastGenerated, m_Output, m_OutputVariableValues, m_SkippedProperties, m_UsePropertyNames

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
DatabaseActorExecutionClassProducer()

Method Summary

Modifier and Type	Method	Description
protected void	addPreExecuteMethod()	Adds a method that gets executed just prior to the actors setup and execution.
BasePassword	getPassword()	Returns the database URL.
protected List<String>	getRequiredImports()	Returns other necessary imports.
String	getURL()	Returns the database URL.
String	getUser()	Returns the database user.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the visitor.
static void	main(String[] args)	Executes the producer from commandline.
String	passwordTipText()	Returns the tip text for this property.
void	setPassword(BasePassword value)	Sets the database password.
void	setURL(String value)	Sets the database URL.
void	setUser(String value)	Sets the database user.
String	URLTipText()	Returns the tip text for this property.
String	userTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.option.ActorExecutionClassProducer

addAdditionalMethods, addClassJavadoc, addDoExecuteMethod, addMainMethod, addMethodEnd, addMethodStart, addPostExecuteMethod, defineOptions, getIndentation, getPackage, getSimpleName, postIndent, preIndent, setPackage, setSimpleName

Methods inherited from class adams.core.option.AbstractActorJavaCodeProducer

getDefaultFormatExtension, getFormatDescription, getFormatExtensions, getOuterVariableName, preProduce

Methods inherited from class adams.core.option.AbstractJavaCodeProducer

addClassEnd, addClassStart, addConstructor, addCopyright, addImports, addLicensePreamble, addPackage, copyrightTipText, escapeDoubleQuotes, getCast, getClassname, getClassname, getClassname, getCopyright, getCurrentVariable, getNextTmpVariable, getNextTmpVariable, getNextTmpVariable, getOutput, getOutputDefaultValues, initOutput, insertAdditionalImports, isClassName, outputDefaultValuesTipText, packageTipText, postProduce, preProduce, processClassOption, processOption, processOption, processOption, setCopyright, setOutputDefaultValues, shortenClassname, simpleNameTipText, toString

Methods inherited from class adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling

cleanUpOptions, destroy, finishInit, getOptionManager, newOptionManager, toCommandLine

Methods inherited from class adams.core.option.AbstractRecursiveOptionProducer

cleanUp, generateLoggingString, getDebugIndentation, getDebugIndentation, getRecursionLevel, reset

Methods inherited from class adams.core.option.AbstractOptionProducer

checkInput, doProduce, doProduce, getCurrentValue, getInput, getOptionIdentifier, getOutputVariableValues, getSkippedProperties, getUsePropertyNames, isDefaultValue, loggingLevelTipText, outputVariableValuesTipText, postProduce, produce, produce, runProducer, setLoggingLevel, setOutputVariableValues, setSkippedProperties, toString, write

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.option.OptionProducer

cleanUp, doProduce, getInput, getLoggingLevel, getOutputVariableValues, getSkippedProperties, getUsePropertyNames, loggingLevelTipText, outputVariableValuesTipText, produce, setLoggingLevel, setOutputVariableValues, setSkippedProperties, write

Field Detail

m_URL

protected String m_URL

the database URL.

m_User

protected String m_User

the database user.

m_Password

protected BasePassword m_Password

the database password.

Constructor Detail

DatabaseActorExecutionClassProducer

public DatabaseActorExecutionClassProducer()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface OptionProducer<String,String>

Overrides:

globalInfo in class ActorExecutionClassProducer

Returns:

a description suitable for displaying in the gui

initialize

protected void initialize()

Initializes the visitor.

Overrides:

initialize in class AbstractJavaCodeProducer

setURL

public void setURL(String value)

Sets the database URL.

Parameters:

value - the URL

getURL

public String getURL()

Returns the database URL.

Returns:

the URL

URLTipText

public String URLTipText()

Returns the tip text for this property.

Returns:

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

setUser

public void setUser(String value)

Sets the database user.

Parameters:

value - the user

getUser

public String getUser()

Returns the database user.

Returns:

the user

userTipText

public String userTipText()

Returns the tip text for this property.

Returns:

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

setPassword

public void setPassword(BasePassword value)

Sets the database password.

Specified by:

setPassword in interface PasswordSupporter

Parameters:

value - the password

getPassword

public BasePassword getPassword()

Returns the database URL.

Specified by:

getPassword in interface PasswordSupporter

Returns:

the URL

passwordTipText

public String passwordTipText()

Returns the tip text for this property.

Returns:

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

getRequiredImports

protected List<String> getRequiredImports()

Returns other necessary imports.

Overrides:

getRequiredImports in class ActorExecutionClassProducer

Returns:

the class names

addPreExecuteMethod

protected void addPreExecuteMethod()

Adds a method that gets executed just prior to the actors setup and execution.

Overrides:

addPreExecuteMethod in class ActorExecutionClassProducer

main

public static void main(String[] args)

Executes the producer from commandline.

Parameters:

args - the commandline arguments, use -help for help