xdoclet.modules.ejb.entity

Class EntityFacadeSubTask

public class EntityFacadeSubTask extends AbstractEjbCodeGeneratorSubTask

Version: $Revision: 1.3 $

Author: Konstantin Pribluda (kpriblouda@yahoo.com)

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

Field Summary
static StringDEFAULT_ENTITY_FACADE_CLASS_PATTERN
static StringDEFAULT_FACADE_EJB_NAME_PATTERN
protected static StringDEFAULT_TEMPLATE_FILE
protected StringentityFacadeClassPattern
A configuration parameter for specifying the entity bean facade EJB class name pattern.
protected StringentityFacadeEjbNamePattern
a configuration parameter for specifying facade ejb names pattern {0} means ejb name
Constructor Summary
EntityFacadeSubTask()
Method Summary
protected voidengineStarted()
Describe what the method does
StringgetEntityFacadeClassPattern()
Returns the configuration parameter for specifying the entity bean facade class name pattern.
StringgetEntityFacadeEjbNamePattern()
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
protected booleanmatchesGenerationRules(XClass clazz)
voidsetEjbNamePattern(String new_pattern)
voidsetPattern(String new_pattern)
Sets the Pattern attribute of the EntityFacadeSubTask object
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

DEFAULT_ENTITY_FACADE_CLASS_PATTERN

public static final String DEFAULT_ENTITY_FACADE_CLASS_PATTERN

DEFAULT_FACADE_EJB_NAME_PATTERN

public static final String DEFAULT_FACADE_EJB_NAME_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

entityFacadeClassPattern

protected String entityFacadeClassPattern
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.

entityFacadeEjbNamePattern

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

Constructor Detail

EntityFacadeSubTask

public EntityFacadeSubTask()

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

getEntityFacadeClassPattern

public String getEntityFacadeClassPattern()
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

See Also: EntityFacadeSubTask

getEntityFacadeEjbNamePattern

public String getEntityFacadeEjbNamePattern()

getGeneratedFileName

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

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

UNKNOWN: refactor/merge this method with matchesGenerationRules from EntityBmpSubTask

setEjbNamePattern

public void setEjbNamePattern(String new_pattern)

setPattern

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

Parameters: new_pattern The new Pattern value

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException