xdoclet.modules.ejb.entity
Class EntityCmpSubTask
AbstractEjbCodeGeneratorSubTask
xdoclet.modules.ejb.entity.EntityCmpSubTask
public class EntityCmpSubTask
extends AbstractEjbCodeGeneratorSubTask
- Ara Abrahamian (ara_e@email.com)
- display-name = "CMP"
name = "entitycmp"
parent = "xdoclet.modules.ejb.EjbDocletTask"
DEFAULT_ENTITYCMP_CLASS_PATTERN
public static final String DEFAULT_ENTITYCMP_CLASS_PATTERN
DEFAULT_TEMPLATE_FILE
protected static final String DEFAULT_TEMPLATE_FILE
entityCmpClassPattern
protected String entityCmpClassPattern
A configuration parameter for specifying the concrete CMP entity bean 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.
EntityCmpSubTask
public EntityCmpSubTask()
Describe what the EntityCmpSubTask constructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
xdoclet.XDocletException
-
getCmpSpec
public String getCmpSpec()
Gets the CmpSpec attribute of the EntityCmpSubTask object
getEntityCmpClassPattern
public String getEntityCmpClassPattern()
Returns the configuration parameter for specifying the concrete CMP entity bean 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}CMP" is used
by default.
- The EntityCmpClassPattern value
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
clazz
- Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException
-
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
clazz
- Describe what the parameter does
- Describe the return value
xdoclet.XDocletException
-
- refactor/merge this method with matchesGenerationRules from EntityBmpSubTask
setCmpSpec
public void setCmpSpec(EntityCmpSubTask.CmpSpecVersion cmpspec)
Sets the CmpSpec attribute of the EntityCmpSubTask object
cmpspec
- The new CmpSpec value
setPattern
public void setPattern(String new_pattern)
Sets the Pattern attribute of the EntityCmpSubTask object
new_pattern
- The new Pattern value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
-