Package adams.core.option

Class ActorExecutionClassProducer

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DatabaseActorExecutionClassProducer

public class ActorExecutionClassProducer
extends AbstractActorJavaCodeProducer

Generates a wrapper class for executing an actor.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalMethods()	Hook-method for adding additional methods necessary to make the class compile.
protected void	addClassJavadoc()	Adds the Javadoc for the class.
protected void	addDoExecuteMethod()	Adds a method that executes the actor.
protected void	addMainMethod()	Hook method for adding a main method.
protected void	addMethodEnd()	Closes the method with the generated code.
protected void	addMethodStart()	Adds the method that encloses the generated code.
protected void	addPostExecuteMethod()	Adds a method that gets executed just after to the actors execution and cleanUp.
protected void	addPreExecuteMethod()	Adds a method that gets executed just prior to the actors setup and execution.
void	defineOptions()	Adds options to the internal list of options.
protected String	getIndentation()	Returns the indentation for code inside the try-catch-block.
String	getPackage()	Returns the package name to use.
protected List<String>	getRequiredImports()	Returns other necessary imports.
String	getSimpleName()	Returns the simple name to use.
String	globalInfo()	Returns a string describing the object.
static void	main(String[] args)	Executes the producer from commandline.
protected void	postIndent(Object value)	Hook method that gets called just after the nesting got decreased.
protected void	preIndent(Object value)	Hook method that gets called before nesting is increased.
void	setPackage(String value)	Sets the package name of the class to generate.
void	setSimpleName(String value)	Sets the simple name (without package) of the class to generate.

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

Constructor Detail

ActorExecutionClassProducer

public ActorExecutionClassProducer()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface OptionProducer<String,String>

Specified by:

globalInfo in class AbstractOptionProducer<String,String>

Returns:

a description suitable for displaying in the gui

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

Specified by:

defineOptions in interface OptionProducerWithOptionHandling<String,String>

Overrides:

defineOptions in class AbstractJavaCodeProducer

setSimpleName

public void setSimpleName(String value)

Sets the simple name (without package) of the class to generate.

Overrides:

setSimpleName in class AbstractJavaCodeProducer

Parameters:

value - the simple name

getSimpleName

public String getSimpleName()

Returns the simple name to use.

Overrides:

getSimpleName in class AbstractJavaCodeProducer

Returns:

the simple name

setPackage

public void setPackage(String value)

Sets the package name of the class to generate.

Overrides:

setPackage in class AbstractJavaCodeProducer

Parameters:

value - the package name

getPackage

public String getPackage()

Returns the package name to use.

Overrides:

getPackage in class AbstractJavaCodeProducer

Returns:

the package name

getIndentation

protected String getIndentation()

Returns the indentation for code inside the try-catch-block.

Specified by:

getIndentation in class AbstractJavaCodeProducer

Returns:

the indentation string

preIndent

protected void preIndent(Object value)

Hook method that gets called before nesting is increased.

Overrides:

preIndent in class AbstractJavaCodeProducer

Parameters:

value - the current object

postIndent

protected void postIndent(Object value)

Hook method that gets called just after the nesting got decreased.

Overrides:

postIndent in class AbstractJavaCodeProducer

Parameters:

value - the current object

getRequiredImports

protected List<String> getRequiredImports()

Returns other necessary imports.

Overrides:

getRequiredImports in class AbstractJavaCodeProducer

Returns:

the class names

addClassJavadoc

protected void addClassJavadoc()

Adds the Javadoc for the class.

Overrides:

addClassJavadoc in class AbstractJavaCodeProducer

addPreExecuteMethod

protected void addPreExecuteMethod()

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

addDoExecuteMethod

protected void addDoExecuteMethod()

Adds a method that executes the actor.

addPostExecuteMethod

protected void addPostExecuteMethod()

Adds a method that gets executed just after to the actors execution and cleanUp.

addAdditionalMethods

protected void addAdditionalMethods()

Hook-method for adding additional methods necessary to make the class compile.

Overrides:

addAdditionalMethods in class AbstractJavaCodeProducer

addMethodStart

protected void addMethodStart()

Adds the method that encloses the generated code.

Specified by:

addMethodStart in class AbstractJavaCodeProducer

addMethodEnd

protected void addMethodEnd()

Closes the method with the generated code.

Specified by:

addMethodEnd in class AbstractJavaCodeProducer

addMainMethod

protected void addMainMethod()

Hook method for adding a main method.

Overrides:

addMainMethod in class AbstractJavaCodeProducer

main

public static void main(String[] args)

Executes the producer from commandline.

Parameters:

args - the commandline arguments, use -help for help