xdoclet.modules.caucho

Class ResinEjbTagsHandler


public class ResinEjbTagsHandler
extends RelationTagsHandler

Template tags handler used by resin-ejb.j and resin-relationships.j to add resin cmp-specific configuration (resin.ejb) to the standard deployment descriptor.
Author:
Yoritaka Sakakura (yori@teardrop.org)
See Also:
Resin CMP Configuration
xdoclet.taghandler
namespace = "ResinEjb"
created
June 5, 2002

Method Summary

void
ifHasLeftOrderBy(String template)
Evaluates the body if the left side of the relationship is many and the order-by parameter of the resinejb:relation method-level tag is defined.
void
ifHasLeftSqlColumn(String template)
Evaluates the body if the left side of the relationship is single and the sql-column parameter of the resinejb:relation method-level tag is defined.
void
ifHasRightOrderBy(String template)
Evaluates the body if the right side of the relationship is many and the order-by parameter of the resinejb:relation method-level tag is defined.
void
ifHasRightSqlColumn(String template)
Evaluates the body if the right side of the relationship is single and the sql-column parameter of the resinejb:relation method-level tag is defined.
void
ifHasSqlTable(String template)
Evaluates the body if either side of the current relation is many and the sql-table parameter of the resinejb:relation method-level tag is defined.
String
leftOrderBy()
Returns the order-by for the left side of the current relation, if applicable.
String
leftSqlColumn()
Returns the sql-column for the left side of the current relation, if applicable.
String
rightOrderBy()
Returns the order-by for the right side of the current relation, if applicable.
String
rightSqlColumn()
Returns the sql-column for the right side of the current relation, if applicable.
String
signatureFromMethod()
Returns the signature of the current method in a form suitable for the /resinejb/enterprise-beans/entity/method/signature element.
String
sqlTable()
Returns the sql-table of the current relationship, if any.

Method Details

ifHasLeftOrderBy

public void ifHasLeftOrderBy(String template)
            throws xdoclet.XDocletException
Evaluates the body if the left side of the relationship is many and the order-by parameter of the resinejb:relation method-level tag is defined.
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifHasLeftSqlColumn

public void ifHasLeftSqlColumn(String template)
            throws xdoclet.XDocletException
Evaluates the body if the left side of the relationship is single and the sql-column parameter of the resinejb:relation method-level tag is defined.
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifHasRightOrderBy

public void ifHasRightOrderBy(String template)
            throws xdoclet.XDocletException
Evaluates the body if the right side of the relationship is many and the order-by parameter of the resinejb:relation method-level tag is defined.
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifHasRightSqlColumn

public void ifHasRightSqlColumn(String template)
            throws xdoclet.XDocletException
Evaluates the body if the right side of the relationship is single and the sql-column parameter of the resinejb:relation method-level tag is defined.
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifHasSqlTable

public void ifHasSqlTable(String template)
            throws xdoclet.XDocletException
Evaluates the body if either side of the current relation is many and the sql-table parameter of the resinejb:relation method-level tag is defined.
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

leftOrderBy

public String leftOrderBy()
            throws xdoclet.XDocletException
Returns the order-by for the left side of the current relation, if applicable.
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

leftSqlColumn

public String leftSqlColumn()
            throws xdoclet.XDocletException
Returns the sql-column for the left side of the current relation, if applicable.
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

rightOrderBy

public String rightOrderBy()
            throws xdoclet.XDocletException
Returns the order-by for the right side of the current relation, if applicable.
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

rightSqlColumn

public String rightSqlColumn()
            throws xdoclet.XDocletException
Returns the sql-column for the right side of the current relation, if applicable.
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

signatureFromMethod

public String signatureFromMethod()
            throws xdoclet.XDocletException
Returns the signature of the current method in a form suitable for the /resinejb/enterprise-beans/entity/method/signature element.
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

sqlTable

public String sqlTable()
            throws xdoclet.XDocletException
Returns the sql-table of the current relationship, if any.
Returns:
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"