org.openarchitectureware.xpand2
Class Generator

java.lang.Object
  extended by org.openarchitectureware.workflow.lib.AbstractWorkflowComponent
      extended by org.openarchitectureware.workflow.lib.AbstractWorkflowComponent2
          extended by org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
              extended by org.openarchitectureware.xpand2.Generator
All Implemented Interfaces:
WorkflowComponent, WorkflowComponentWithID

public class Generator
extends AbstractExpressionsUsingWorkflowComponent


Nested Class Summary
 
Nested classes/interfaces inherited from class org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
AbstractExpressionsUsingWorkflowComponent.Debug, AbstractExpressionsUsingWorkflowComponent.GlobalVarDef
 
Field Summary
 
Fields inherited from class org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
callback, exceptionHandler, exceptionsOnNullEvaluation, log, metaModels
 
Constructor Summary
Generator()
           
 
Method Summary
 void addAdvice(java.lang.String advice)
          Adds an advice.
 void addExtensionAdvice(java.lang.String extensionAdvice)
          Adds an extension advice.
 void addOutlet(Outlet outlet)
          Adds an outlet.
protected  void checkConfigurationInternal(Issues issues)
           
 java.util.List<?> getBeautifier()
          Returns the list of beatifiers that will be applied to the generated output.
 java.lang.String getComponentName()
          Override this method by custom components.
 java.lang.String getFileEncoding()
          Returns the name of character encoding used for the output file.
 java.lang.String getLogMessage()
          Returns the log message,
 java.util.List<Outlet> getOutlets()
          Retrieves the configured and initialized outlets of the generator.
protected  void invokeInternal2(WorkflowContext ctx, ProgressMonitor monitor, Issues issues)
           
 void setAutomaticHyphens(boolean automaticHyphens)
          Enables or disables the automatic hyphenation.
 void setBeautifier(java.util.List<?> beautifiers)
          Sets the list of beatifiers that will be applied to the generated output.
 void setCollectProfileSummary(java.lang.String summary)
          Sets the collection profile summary.
 void setExpand(java.lang.String invoke)
          Sets the statement that is to expand by the generator.
 void setFileEncoding(java.lang.String fileEncoding)
          Sets the character encoding used for the output file.
 void setGenPath(java.lang.String genPath)
          Deprecated. use outlets instead
 void setOutput(Output output)
          Sets the output.
 void setPrDefaultExcludes(boolean prDefaultExcludes)
          Enables oder disables the default excludes for protected regions.
 void setPrExcludes(java.lang.String prExcludes)
          Sets the additional excludes for protected regions.
 void setPrSrcPaths(java.lang.String prSrcPathes)
          Sets the source paths for protected regions.
 void setSrcPath(java.lang.String srcPath)
          Deprecated. use outlets instead
 void setVerboseProfileFilename(java.lang.String fileName)
          Sets the filename for verbose profile.
 
Methods inherited from class org.openarchitectureware.expression.AbstractExpressionsUsingWorkflowComponent
addDebug, addGlobalVarDef, addMetaModel, getExecutionContext, getGlobalVars, getNullEvaluationHandler, getResourceManager, invokeInternal, setCallback, setDumpContext, setExceptionHandler, setExceptionsOnNullEvaluation, setResourceManager, toString
 
Methods inherited from class org.openarchitectureware.workflow.lib.AbstractWorkflowComponent2
checkConfiguration, invoke, setSkipOnErrors
 
Methods inherited from class org.openarchitectureware.workflow.lib.AbstractWorkflowComponent
checkRequiredConfigProperty, getContainer, getId, getLocation, setContainer, setId, setLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Generator

public Generator()
Method Detail

setCollectProfileSummary

public void setCollectProfileSummary(java.lang.String summary)
Sets the collection profile summary.

Parameters:
summary - the summary

setVerboseProfileFilename

public void setVerboseProfileFilename(java.lang.String fileName)
Sets the filename for verbose profile.

Parameters:
fileName - filename for verbose profile

setAutomaticHyphens

public void setAutomaticHyphens(boolean automaticHyphens)
Enables or disables the automatic hyphenation. If automatic hyphenation is enabled, redundant blank lines are avoided automatically.

Parameters:
automaticHyphens - If true, automatic hyphenation is enabled, otherwise disabled.

getLogMessage

public java.lang.String getLogMessage()
Description copied from interface: WorkflowComponentWithID
Returns the log message,

Specified by:
getLogMessage in interface WorkflowComponentWithID
Overrides:
getLogMessage in class AbstractWorkflowComponent
Returns:
the log message
See Also:
AbstractWorkflowComponent.getLogMessage()

addAdvice

public void addAdvice(java.lang.String advice)
Adds an advice.

Parameters:
advice - the advice

addExtensionAdvice

public void addExtensionAdvice(java.lang.String extensionAdvice)
Adds an extension advice.

Parameters:
extensionAdvice - the extension advice

getBeautifier

public java.util.List<?> getBeautifier()
Returns the list of beatifiers that will be applied to the generated output.

Returns:
list of beautifiers

setBeautifier

public void setBeautifier(java.util.List<?> beautifiers)
Sets the list of beatifiers that will be applied to the generated output.

Parameters:
beautifiers - list of beautifiera

setFileEncoding

public void setFileEncoding(java.lang.String fileEncoding)
Sets the character encoding used for the output file.

Parameters:
fileEncoding - name of character encoding

getFileEncoding

public java.lang.String getFileEncoding()
Returns the name of character encoding used for the output file.

Returns:
name of character encoding

setGenPath

@Deprecated
public void setGenPath(java.lang.String genPath)
Deprecated. use outlets instead


setExpand

public void setExpand(java.lang.String invoke)
Sets the statement that is to expand by the generator.

Parameters:
invoke - statement to expand

setPrDefaultExcludes

public void setPrDefaultExcludes(boolean prDefaultExcludes)
Enables oder disables the default excludes for protected regions.

Parameters:
prDefaultExcludes - If true, the default excludes are enabled, otherwise disabled.

setPrExcludes

public void setPrExcludes(java.lang.String prExcludes)
Sets the additional excludes for protected regions.

Parameters:
prExcludes - the excludes

setPrSrcPaths

public void setPrSrcPaths(java.lang.String prSrcPathes)
Sets the source paths for protected regions.

Parameters:
prSrcPathes - the source paths

getComponentName

public java.lang.String getComponentName()
Description copied from class: AbstractWorkflowComponent
Override this method by custom components.

Specified by:
getComponentName in interface WorkflowComponent
Overrides:
getComponentName in class AbstractWorkflowComponent
Returns:
Simple class name as default.
See Also:
WorkflowComponent.getComponentName()

setSrcPath

@Deprecated
public void setSrcPath(java.lang.String srcPath)
Deprecated. use outlets instead


invokeInternal2

protected void invokeInternal2(WorkflowContext ctx,
                               ProgressMonitor monitor,
                               Issues issues)
Overrides:
invokeInternal2 in class AbstractExpressionsUsingWorkflowComponent

addOutlet

public void addOutlet(Outlet outlet)
Adds an outlet.

Parameters:
outlet - the outlet

setOutput

public void setOutput(Output output)
Sets the output.

Parameters:
output - the output

getOutlets

public final java.util.List<Outlet> getOutlets()
Retrieves the configured and initialized outlets of the generator.

Since:
4.2

checkConfigurationInternal

protected void checkConfigurationInternal(Issues issues)
Overrides:
checkConfigurationInternal in class AbstractExpressionsUsingWorkflowComponent