xdoclet.modules.ejb.entity

Class DataObjectSubTask


public class DataObjectSubTask
extends AbstractEjbCodeGeneratorSubTask

Creates "data objects" for Entity EJBs. This task is currently being deprecated in favour of Value Object which is more powerful in terms of relationships (1-1, 1-n and n-m).
Version:
$Revision: 1.12 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "Data Object" name = "dataobject" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Field Summary

static String
DEFAULT_DATAOBJECT_CLASS_PATTERN
protected static String
DEFAULT_TEMPLATE_FILE
protected String
dataObjectClassPattern
A configuration parameter for specifying the data object class name pattern.

Constructor Summary

DataObjectSubTask()
Describe what the DataObjectSubTask constructor does

Method Summary

protected void
engineStarted()
Describe what the method does
protected void
generateForClass(XClass clazz)
Describe what the method does
String
getDataObjectClassPattern()
Returns the configuration parameter for specifying the data object class name pattern.
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DataObjectSubTask object
protected boolean
matchesGenerationRules(XClass clazz)
Describe what the method does
void
setPattern(String new_pattern)
The pattern by which the data object classes are named.
void
validateOptions()
Called to validate configuration parameters.

Field Details

DEFAULT_DATAOBJECT_CLASS_PATTERN

public static final String DEFAULT_DATAOBJECT_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

dataObjectClassPattern

protected String dataObjectClassPattern
A configuration parameter for specifying the data object class name pattern. By default the value is used for deciding the entity data object class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

Constructor Details

DataObjectSubTask

public DataObjectSubTask()
Describe what the DataObjectSubTask constructor does

Method Details

engineStarted

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

generateForClass

protected void generateForClass(XClass clazz)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
clazz - Describe what the parameter does
Throws:
xdoclet.XDocletException -

getDataObjectClassPattern

public String getDataObjectClassPattern()
Returns the configuration parameter for specifying the data object class name pattern. By default the value is used for deciding the entity data object 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}Data" is used by default.
Returns:
The DataObjectClassPattern value

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the DataObjectSubTask 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 data object classes are named. The placeholder "{0}" designates the EJB name.
Parameters:
new_pattern - The new Pattern value
ant.not-required
"No, default is '{0}Data'"

validateOptions

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