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)
ant.element
display-name = "Facade" name = "remotefacade" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
September 10, 2002

Field Summary

static String
DEFAULT_REMOTE_FACADE_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
remoteFacadeClassPattern
A configuration parameter for specifying the entity bean facade EJB class name pattern.
protected String
remoteFacadeEjbNamePattern
a configuration parameter for specifying facade ejb names pattern {0} means ejb name

Constructor Summary

RemoteFacadeSubTask()

Method Summary

protected void
engineStarted()
Describe what the method does
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the RemoteFacadeSubTask object
String
getRemoteFacadeClassPattern()
Returns the configuration parameter for specifying the entity bean facade class name pattern.
protected boolean
matchesGenerationRules(XClass clazz)
we accept session beans generated on first stage runs.
void
setPattern(String new_pattern)
Sets the Pattern attribute of the DataObjectSubTask object
void
validateOptions()
Called to validate configuration parameters.

Field Details

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 Details

RemoteFacadeSubTask

public RemoteFacadeSubTask()

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Throws:
xdoclet.XDocletException -

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the RemoteFacadeSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.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)
            throws xdoclet.XDocletException
we accept session beans generated on first stage runs.
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException -
To do:
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()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException -