xdoclet.ejb
Class EntityPkSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.ejb.AbstractEjbCodeGeneratorSubTask
                          |
                          +--xdoclet.ejb.EntityPkSubTask

All Implemented Interfaces:

java.io.Serializable

public class EntityPkSubTask

extends AbstractEjbCodeGeneratorSubTask

Version:

$Revision: 1.22 $

Author:

Ara Abrahamian (ara_e@email.com)

See Also:

Serialized Form

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

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

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

EntityPkSubTask()

Method Summary

protected void	engineStarted()
java.lang.String	getEntityPkClassPattern() Returns the configuration parameter for specifying the entity bean primary class name pattern.
protected java.lang.String	getGeneratedFileName(com.sun.javadoc.ClassDoc clazz) Returns class name for the generated file.
java.lang.String	getSubTaskName()
protected boolean	matchesGenerationRules(com.sun.javadoc.ClassDoc clazz) Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise.
void	setPattern(java.lang.String new_pattern)
void	validateOptions() Called to validate configuration parameters.

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, copyAttributesFrom, engineFinished, execute, generateForClass, getDestinationFile, getEngine, getExtent, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

DEFAULT_ENTITY_PK_CLASS_PATTERN

public static final java.lang.String DEFAULT_ENTITY_PK_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static java.lang.String DEFAULT_TEMPLATE_FILE

entityPkClassPattern

protected java.lang.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. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

See Also:

getEntityPkClassPattern()

Constructor Detail

EntityPkSubTask

public EntityPkSubTask()

Method Detail

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

getEntityPkClassPattern

public java.lang.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. {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}PK" is used by default.

Returns:

The EntityPkClassPattern value

See Also:

entityPkClassPattern

setPattern

public void setPattern(java.lang.String new_pattern)

validateOptions

public void validateOptions()
                     throws XDocletException

Called to validate configuration parameters.

Overrides:

validateOptions in class TemplateSubTask

Throws:

XDocletException - Description of Exception

getGeneratedFileName

protected java.lang.String getGeneratedFileName(com.sun.javadoc.ClassDoc clazz)
                                         throws XDocletException

Description copied from class: TemplateSubTask

Returns class name for the generated file. {0} substituted by class name.

Overrides:

getGeneratedFileName in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

The GeneratedClassName value

Throws:

XDocletException - Description of Exception

matchesGenerationRules

protected boolean matchesGenerationRules(com.sun.javadoc.ClassDoc clazz)
                                  throws XDocletException

Description copied from class: TemplateSubTask

Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise. If returned false, no output file is generated for clazz.

Overrides:

matchesGenerationRules in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask