xdoclet.modules.ejb.session

Class RemoteFacadeSubTask

public class RemoteFacadeSubTask extends AbstractEjbCodeGeneratorSubTask

this subtask is stage 2 of remote facade generation.

Version: $Revision: 1.4 $

Author: Konstantin Pribluda (kpriblouda@yahoo.com)

UNKNOWN: September 10, 2002 display-name = "Facade" name = "remotefacade" parent = "xdoclet.modules.ejb.EjbDocletTask"

Field Summary
static StringDEFAULT_REMOTE_FACADE_CLASS_PATTERN
protected static StringDEFAULT_TEMPLATE_FILE
protected StringremoteFacadeClassPattern
A configuration parameter for specifying the entity bean facade EJB class name pattern.
protected StringremoteFacadeEjbNamePattern
a configuration parameter for specifying facade ejb names pattern {0} means ejb name
Constructor Summary
RemoteFacadeSubTask()
Method Summary
protected voidengineStarted()
Describe what the method does
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the RemoteFacadeSubTask object
StringgetRemoteFacadeClassPattern()
Returns the configuration parameter for specifying the entity bean facade class name pattern.
protected booleanmatchesGenerationRules(XClass clazz)
we accept session beans generated on first stage runs.
voidsetPattern(String new_pattern)
Sets the Pattern attribute of the DataObjectSubTask object
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

DEFAULT_REMOTE_FACADE_CLASS_PATTERN

public static final String DEFAULT_REMOTE_FACADE_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

remoteFacadeClassPattern

protected String remoteFacadeClassPattern
A configuration parameter for specifying the entity bean facade EJB class name pattern. By default the value is used for deciding the entity bean facade class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

remoteFacadeEjbNamePattern

protected String remoteFacadeEjbNamePattern
a configuration parameter for specifying facade ejb names pattern {0} means ejb name

Constructor Detail

RemoteFacadeSubTask

public RemoteFacadeSubTask()

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the RemoteFacadeSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

getRemoteFacadeClassPattern

public String getRemoteFacadeClassPattern()
Returns the configuration parameter for specifying the entity bean facade class name pattern. By default the value is used for deciding the concrete CMP entity bean class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}FacadeEJB" is used by default.

Returns: The EntityCmpClassPattern value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
we accept session beans generated on first stage runs.

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

UNKNOWN: refactor/merge this method with matchesGenerationRules from EntityBmpSubTask

setPattern

public void setPattern(String new_pattern)
Sets the Pattern attribute of the DataObjectSubTask object

Parameters: new_pattern The new Pattern value

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException