xdoclet.modules.ejb.entity
Class DataObjectSubTask
AbstractEjbCodeGeneratorSubTask
xdoclet.modules.ejb.entity.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).
- Ara Abrahamian (ara_e@email.com)
- display-name = "Data Object"
name = "dataobject"
parent = "xdoclet.modules.ejb.EjbDocletTask"
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.
|
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.
DataObjectSubTask
public DataObjectSubTask()
Describe what the DataObjectSubTask constructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
xdoclet.XDocletException
-
generateForClass
protected void generateForClass(XClass clazz)
throws xdoclet.XDocletException
Describe what the method does
clazz
- Describe what the parameter does
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.
- The DataObjectClassPattern value
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the DataObjectSubTask object
clazz
- Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException
-
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
Describe what the method does
clazz
- Describe what the parameter does
- Describe the return value
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.
new_pattern
- The new Pattern value
- "No, default is '{0}Data'"
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
-