xdoclet.modules.ejb.entity

Class EntityCmpSubTask

public class EntityCmpSubTask extends AbstractEjbCodeGeneratorSubTask

Version: $Revision: 1.8 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 15, 2001 display-name = "CMP" name = "entitycmp" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "entitycmp-custom.xdt" relates-to = "{0}CMP.java" description = "A text file containing custom * template and/or java code to include in the EJB CMP class."

Nested Class Summary
static classEntityCmpSubTask.CmpSpecVersion
Field Summary
static StringDEFAULT_ENTITYCMP_CLASS_PATTERN
protected static StringDEFAULT_TEMPLATE_FILE
protected StringentityCmpClassPattern
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 voidengineStarted()
Describe what the method does
StringgetCmpSpec()
Gets the CmpSpec attribute of the EntityCmpSubTask object
StringgetEntityCmpClassPattern()
Returns the configuration parameter for specifying the concrete CMP entity bean class name pattern.
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object
protected booleanmatchesGenerationRules(XClass clazz)
voidsetCmpSpec(EntityCmpSubTask.CmpSpecVersion cmpspec)
Sets the CmpSpec attribute of the EntityCmpSubTask object
voidsetPattern(String new_pattern)
Sets the Pattern attribute of the EntityCmpSubTask object
voidvalidateOptions()
Called to validate configuration parameters.

Field Detail

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.

See Also: getEntityCmpClassPattern

Constructor Detail

EntityCmpSubTask

public EntityCmpSubTask()
Describe what the EntityCmpSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: 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

See Also: entityCmpClassPattern

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the EntityCmpSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

UNKNOWN: 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()
Called to validate configuration parameters.

Throws: XDocletException