xdoclet.modules.jdo

Class VendorExtensionsSubTask

public abstract class VendorExtensionsSubTask extends SubTask

Version: $Revision: 1.1 $

Author: Ludovic Claude (ludovicc@users.sourceforge.net)

UNKNOWN: 10 October 2002

Field Summary
static StringCOLUMN_NAME_ATTR
static StringRELATED_FIELD_ATTR
static StringSQL_FIELD_TAG
static StringSQL_RELATION_TAG
static StringSQL_TABLE_TAG
static StringSTYLE_ATTR
static StringSTYLE_FOREIGN_KEY_VALUE
static StringSTYLE_RELATION_TABLE_VALUE
static StringTABLE_NAME_ATTR
Method Summary
voidexecute()
protected abstract CollectiongetArrayExtensions()
protected abstract CollectiongetClassExtensions()
protected abstract CollectiongetCollectionExtensions()
XClassgetCurrentClass()
Peeks and return the current class from top of currentClassStack stack.
XConstructorgetCurrentConstructor()
Returns current constructor.
XFieldgetCurrentField()
Returns current field.
XMethodgetCurrentMethod()
Returns current method.
XPackagegetCurrentPackage()
Returns current package.
protected CollectiongetExtensions(String level)
protected abstract CollectiongetFieldExtensions()
protected abstract CollectiongetMapExtensions()
protected JdoXmlMetadataSubTaskgetMetadataSubTask()
abstract StringgetVendorDescription()
abstract StringgetVendorName()
XClasspopCurrentClass()
Popes current class from top currentClassStack stack.
XClasspushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
voidsetCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
voidsetCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object
voidsetCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object
voidsetCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object
voidsetCurrentPackage(XPackage pakkage)
Returns current package.

Field Detail

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 Detail

execute

public void execute()

Throws: XDocletException

See Also: execute

getArrayExtensions

protected abstract Collection getArrayExtensions()

getClassExtensions

protected abstract Collection getClassExtensions()

getCollectionExtensions

protected abstract Collection getCollectionExtensions()

getCurrentClass

public XClass getCurrentClass()
Peeks and return the current class from top of currentClassStack stack.

Returns: The CurrentClass value

See Also: setCurrentClass

getCurrentConstructor

public XConstructor getCurrentConstructor()
Returns current constructor.

Returns: The CurrentConstructor value

See Also: setCurrentConstructor

getCurrentField

public XField getCurrentField()
Returns current field.

Returns: The CurrentField value

See Also: setCurrentField

getCurrentMethod

public XMethod getCurrentMethod()
Returns current method.

Returns: The CurrentMethod value

See Also: setCurrentMethod

getCurrentPackage

public XPackage getCurrentPackage()
Returns current package.

Returns: The CurrentPackage value

See Also: setCurrentPackage

getExtensions

protected Collection getExtensions(String level)

getFieldExtensions

protected abstract Collection getFieldExtensions()

getMapExtensions

protected abstract Collection getMapExtensions()

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.

Returns: Description of the Returned Value

See Also: getCurrentClass setCurrentClass pushCurrentClass

pushCurrentClass

public XClass pushCurrentClass(XClass clazz)
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.

Parameters: clazz Description of Parameter

Returns: Description of the Returned Value

See Also: getCurrentClass setCurrentClass popCurrentClass

setCurrentClass

public void setCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.

Parameters: clazz The new CurrentClass value

See Also: getCurrentClass

UNKNOWN:

setCurrentConstructor

public void setCurrentConstructor(XConstructor constructor)
Sets the CurrentConstructor attribute of the DocletSupport object

Parameters: constructor The new CurrentConstructor value

UNKNOWN:

setCurrentField

public void setCurrentField(XField field)
Sets the CurrentField attribute of the DocletSupport object

Parameters: field The new CurrentField value

UNKNOWN:

setCurrentMethod

public void setCurrentMethod(XMethod method)
Sets the CurrentMethod attribute of the DocletSupport object

Parameters: method The new CurrentMethod value

UNKNOWN:

setCurrentPackage

public void setCurrentPackage(XPackage pakkage)
Returns current package.

Parameters: pakkage The new CurrentPackage value

See Also: setCurrentPackage

UNKNOWN: