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 String	DEFAULT_ENTITY_FACADE_CLASS_PATTERN
static String	DEFAULT_FACADE_EJB_NAME_PATTERN
protected static String	DEFAULT_TEMPLATE_FILE
protected String	entityFacadeClassPattern A configuration parameter for specifying the entity bean facade EJB class name pattern.
protected String	entityFacadeEjbNamePattern a configuration parameter for specifying facade ejb names pattern {0} means ejb name

Constructor Summary
	EntityFacadeSubTask()

Method Summary
protected void	engineStarted() Describe what the method does
String	getEntityFacadeClassPattern() Returns the configuration parameter for specifying the entity bean facade class name pattern.
String	getEntityFacadeEjbNamePattern()
protected String	getGeneratedFileName(XClass clazz) Gets the GeneratedFileName attribute of the EntityCmpSubTask object
protected boolean	matchesGenerationRules(XClass clazz)
void	setEjbNamePattern(String new_pattern)
void	setPattern(String new_pattern) Sets the Pattern attribute of the EntityFacadeSubTask object
void	validateOptions() 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