xdoclet.modules.jdo

Class VendorExtensionsSubTask

Implemented Interfaces:
Serializable

public abstract class VendorExtensionsSubTask
extends xdoclet.SubTask

Version:
$Revision: 1.1 $
Author:
Ludovic Claude (ludovicc@users.sourceforge.net)
created
10 October 2002

Field Summary

static String
COLUMN_NAME_ATTR
static String
RELATED_FIELD_ATTR
static String
SQL_FIELD_TAG
static String
SQL_RELATION_TAG
static String
SQL_TABLE_TAG
static String
STYLE_ATTR
static String
STYLE_FOREIGN_KEY_VALUE
static String
STYLE_RELATION_TABLE_VALUE
static String
TABLE_NAME_ATTR

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Method Summary

void
execute()
protected abstract Collection
getArrayExtensions()
protected abstract Collection
getClassExtensions()
protected abstract Collection
getCollectionExtensions()
XClass
getCurrentClass()
Peeks and return the current class from top of currentClassStack stack.
XConstructor
getCurrentConstructor()
Returns current constructor.
XField
getCurrentField()
Returns current field.
XMethod
getCurrentMethod()
Returns current method.
XPackage
getCurrentPackage()
Returns current package.
protected Collection
getExtensions(String level)
protected abstract Collection
getFieldExtensions()
protected abstract Collection
getMapExtensions()
protected JdoXmlMetadataSubTask
getMetadataSubTask()
abstract String
getVendorDescription()
abstract String
getVendorName()
XClass
popCurrentClass()
Popes current class from top currentClassStack stack.
XClass
pushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
void
setCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
void
setCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object
void
setCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object
void
setCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object
void
setCurrentPackage(XPackage pakkage)
Returns current package.

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Field Details

COLUMN_NAME_ATTR

public static final String COLUMN_NAME_ATTR

RELATED_FIELD_ATTR

public static final String RELATED_FIELD_ATTR

SQL_FIELD_TAG

public static final String SQL_FIELD_TAG

SQL_RELATION_TAG

public static final String SQL_RELATION_TAG

SQL_TABLE_TAG

public static final String SQL_TABLE_TAG

STYLE_ATTR

public static final String STYLE_ATTR

STYLE_FOREIGN_KEY_VALUE

public static final String STYLE_FOREIGN_KEY_VALUE

STYLE_RELATION_TABLE_VALUE

public static final String STYLE_RELATION_TABLE_VALUE

TABLE_NAME_ATTR

public static final String TABLE_NAME_ATTR

Method Details

execute

public void execute()
            throws xdoclet.XDocletException
Overrides:
execute in interface xdoclet.SubTask
Throws:
xdoclet.XDocletException -
See Also:
xdoclet.SubTask.execute()

getArrayExtensions

protected abstract Collection getArrayExtensions()
            throws xdoclet.XDocletException

getClassExtensions

protected abstract Collection getClassExtensions()
            throws xdoclet.XDocletException

getCollectionExtensions

protected abstract Collection getCollectionExtensions()
            throws xdoclet.XDocletException

getCurrentClass

public XClass getCurrentClass()
Peeks and return the current class from top of currentClassStack stack.
Overrides:
getCurrentClass in interface xdoclet.DocletSupport
Returns:
The CurrentClass value
See Also:
setCurrentClass(xjavadoc.XClass)

getCurrentConstructor

public XConstructor getCurrentConstructor()
Returns current constructor.
Overrides:
getCurrentConstructor in interface xdoclet.DocletSupport
Returns:
The CurrentConstructor value
See Also:
setCurrentConstructor(xjavadoc.XConstructor)

getCurrentField

public XField getCurrentField()
Returns current field.
Overrides:
getCurrentField in interface xdoclet.DocletSupport
Returns:
The CurrentField value
See Also:
setCurrentField(xjavadoc.XField)

getCurrentMethod

public XMethod getCurrentMethod()
Returns current method.
Overrides:
getCurrentMethod in interface xdoclet.DocletSupport
Returns:
The CurrentMethod value
See Also:
setCurrentMethod(xjavadoc.XMethod)

getCurrentPackage

public XPackage getCurrentPackage()
Returns current package.
Overrides:
getCurrentPackage in interface xdoclet.DocletSupport
Returns:
The CurrentPackage value
See Also:
setCurrentPackage(xjavadoc.XPackage)

getExtensions

protected Collection getExtensions(String level)
            throws xdoclet.XDocletException

getFieldExtensions

protected abstract Collection getFieldExtensions()
            throws xdoclet.XDocletException

getMapExtensions

protected abstract Collection getMapExtensions()
            throws xdoclet.XDocletException

getMetadataSubTask

protected JdoXmlMetadataSubTask getMetadataSubTask()

getVendorDescription

public abstract String getVendorDescription()

getVendorName

public abstract String getVendorName()

popCurrentClass

public XClass popCurrentClass()
Popes current class from top currentClassStack stack. The poped class is no longer the current class.
Overrides:
popCurrentClass in interface xdoclet.DocletSupport
Returns:
Description of the Returned Value
See Also:
getCurrentClass(), setCurrentClass(xjavadoc.XClass), pushCurrentClass(xjavadoc.XClass)

pushCurrentClass

public XClass pushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
Overrides:
pushCurrentClass in interface xdoclet.DocletSupport
Parameters:
clazz - Description of Parameter
Returns:
Description of the Returned Value
See Also:
getCurrentClass(), setCurrentClass(xjavadoc.XClass), popCurrentClass()

setCurrentClass

public void setCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
Overrides:
setCurrentClass in interface xdoclet.DocletSupport
Parameters:
clazz - The new CurrentClass value
ant.element

setCurrentConstructor

public void setCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object
Overrides:
setCurrentConstructor in interface xdoclet.DocletSupport
Parameters:
constructor - The new CurrentConstructor value
ant.element

setCurrentField

public void setCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object
Overrides:
setCurrentField in interface xdoclet.DocletSupport
Parameters:
field - The new CurrentField value
ant.element

setCurrentMethod

public void setCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object
Overrides:
setCurrentMethod in interface xdoclet.DocletSupport
Parameters:
method - The new CurrentMethod value
ant.element

setCurrentPackage

public void setCurrentPackage(XPackage pakkage)
Returns current package.
Overrides:
setCurrentPackage in interface xdoclet.DocletSupport
Parameters:
pakkage - The new CurrentPackage value
See Also:
setCurrentPackage(xjavadoc.XPackage)
ant.element