xdoclet.modules.ejb.entity

Class EntityPkSubTask


public class EntityPkSubTask
extends AbstractEjbCodeGeneratorSubTask

Generates primary key classes for entity EJBs.
Version:
$Revision: 1.11 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "PK Class" name = "entitypk" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Field Summary

static String
DEFAULT_ENTITY_PK_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
entityPkClassPattern
A configuration parameter for specifying the entity bean primary class name pattern.

Constructor Summary

EntityPkSubTask()
Describe what the EntityPkSubTask constructor does

Method Summary

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.

Field Details

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.

Constructor Details

EntityPkSubTask

public EntityPkSubTask()
Describe what the EntityPkSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Throws:
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.
Returns:
The EntityPkClassPattern value

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the EntityPkSubTask object
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException -

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
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.
Parameters:
new_pattern - The new Pattern value
ant.not-required
No,defaultsto {0}PK

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException -