xdoclet.modules.ejb.entity

Class EntityCmpSubTask


public class EntityCmpSubTask
extends AbstractEjbCodeGeneratorSubTask

Version:
$Revision: 1.8 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "CMP" name = "entitycmp" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Nested Class Summary

static class
EntityCmpSubTask.CmpSpecVersion

Field Summary

static String
DEFAULT_ENTITYCMP_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
entityCmpClassPattern
A configuration parameter for specifying the concrete CMP entity bean class name pattern.

Constructor Summary

EntityCmpSubTask()
Describe what the EntityCmpSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
String
getCmpSpec()
Gets the CmpSpec attribute of the EntityCmpSubTask object
String
getEntityCmpClassPattern()
Returns the configuration parameter for specifying the concrete CMP entity bean class name pattern.
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
protected boolean
matchesGenerationRules(XClass clazz)
void
setCmpSpec(EntityCmpSubTask.CmpSpecVersion cmpspec)
Sets the CmpSpec attribute of the EntityCmpSubTask object
void
setPattern(String new_pattern)
Sets the Pattern attribute of the EntityCmpSubTask object
void
validateOptions()
Called to validate configuration parameters.

Field Details

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.

Constructor Details

EntityCmpSubTask

public EntityCmpSubTask()
Describe what the EntityCmpSubTask constructor does

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Throws:
xdoclet.XDocletException -

getCmpSpec

public String getCmpSpec()
Gets the CmpSpec attribute of the EntityCmpSubTask object
Returns:
The CmpSpec value

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.
Returns:
The EntityCmpClassPattern value

getGeneratedFileName

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

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Parameters:
clazz - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException -
To do:
refactor/merge this method with matchesGenerationRules from EntityBmpSubTask

setCmpSpec

public void setCmpSpec(EntityCmpSubTask.CmpSpecVersion cmpspec)
Sets the CmpSpec attribute of the EntityCmpSubTask object
Parameters:
cmpspec - The new CmpSpec value

setPattern

public void setPattern(String new_pattern)
Sets the Pattern attribute of the EntityCmpSubTask object
Parameters:
new_pattern - The new Pattern value

validateOptions

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