xdoclet.modules.ejb.entity
Class EntityPkSubTask
AbstractEjbCodeGeneratorSubTask
xdoclet.modules.ejb.entity.EntityPkSubTask
public class EntityPkSubTask
extends AbstractEjbCodeGeneratorSubTask
Generates primary key classes for entity EJBs.
- Ara Abrahamian (ara_e@email.com)
- display-name = "PK Class"
name = "entitypk"
parent = "xdoclet.modules.ejb.EjbDocletTask"
protected void | engineStarted() - Describe what the method does
|
String | getEntityPkClassPattern() - Returns the configuration parameter for specifying the entity bean primary class name pattern.
|
protected String | getGeneratedFileName(XClass clazz) - Gets the GeneratedFileName attribute of the EntityPkSubTask object
|
protected boolean | matchesGenerationRules(XClass clazz) - Describe what the method does
|
void | setPattern(String new_pattern) - The pattern by which the primary key classes are named.
|
void | validateOptions() - Called to validate configuration parameters.
|
DEFAULT_ENTITY_PK_CLASS_PATTERN
public static final String DEFAULT_ENTITY_PK_CLASS_PATTERN
DEFAULT_TEMPLATE_FILE
protected static final String DEFAULT_TEMPLATE_FILE
entityPkClassPattern
protected String entityPkClassPattern
A configuration parameter for specifying the entity bean primary class name pattern. By default the value is used
for deciding the entity bean primary class name. The placeholder "{0}" in the value means the current class's
symbolic name which for an EJBean is the EJB name.
EntityPkSubTask
public EntityPkSubTask()
Describe what the EntityPkSubTask constructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
xdoclet.XDocletException
-
getEntityPkClassPattern
public String getEntityPkClassPattern()
Returns the configuration parameter for specifying the entity bean primary class name pattern. By default the
value is used for deciding the entity bean primary class name. The placeholder "{0}" in the value means the
current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then
"{0}PK" is used by default.
- The EntityPkClassPattern value
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the EntityPkSubTask object
clazz
- Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException
-
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
Describe what the method does
clazz
- Describe what the parameter does
- Describe the return value
xdoclet.XDocletException
-
setPattern
public void setPattern(String new_pattern)
The pattern by which the primary key classes are named. The placeholder "{0}" designates the EJB name.
new_pattern
- The new Pattern value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
-