xdoclet.ejb.tags
Class EjbRefTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.ejb.tags.EjbTagsHandler
                    |
                    +--xdoclet.ejb.tags.EjbRefTagsHandler

public class EjbRefTagsHandler

extends EjbTagsHandler

Version:

$Revision 1.1 $

Author:

Ara Abrahamian

Field Summary

protected java.lang.String

referringClassId The id of the EJB referencing another EJB, used for setting up a correct unique id for the ejb-ref.

Fields inherited from class xdoclet.ejb.tags.EjbTagsHandler

LOCAL_SUFFIX

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Constructor Summary

EjbRefTagsHandler()

Method Summary

java.lang.String	ejbRefId() Returns unique id for the specified ejb-ref.
protected com.sun.javadoc.ClassDoc	findEjb(java.lang.String ejbName) Finds and returns the class with the specified ejbName.
void	forAllEjbRefs(java.lang.String template, java.util.Properties attributes) Evaluates the body block for each ejb:ejb-ref defined for the EJB.
protected void	storeReferringClassId() Stores the id of current EJB for further use by other tags in referringClassId attribute.

Methods inherited from class xdoclet.ejb.tags.EjbTagsHandler

beanType, choosePackage, concreteFullClassName, ejbExternalRefName, ejbName, ejbRefName, extendsFromFor, forAllBeans, getDependentClassFor, getDependentClassTagName, getEjbIdFor, getEjbNameFor, getEjbSpec, getShortEjbNameFor, hasPermission, hasTransaction, id, ifIsAConcreteEJBean, ifLocalEjb, ifNotLocalEjb, ifNotRemoteEjb, ifRemoteEjb, isAConcreteEJBean, isEjb, isLocalEjb, isOnlyLocalEjb, isOnlyRemoteEjb, isRemoteEjb, prefixWithEjbSlash, shortEjbName, shouldTraverseSuperclassForDependentClass, symbolicClassName

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

referringClassId

protected transient java.lang.String referringClassId

The id of the EJB referencing another EJB, used for setting up a correct unique id for the ejb-ref.

See Also:

ejbRefId(), forAllEjbRefs(java.lang.String,java.util.Properties), storeReferringClassId()

Constructor Detail

EjbRefTagsHandler

public EjbRefTagsHandler()

Method Detail

ejbRefId

public java.lang.String ejbRefId()
                          throws XDocletException

Returns unique id for the specified ejb-ref. It prefixes it with the referring class's id, then a _ and the id of the ejb object.

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

forAllEjbRefs

public void forAllEjbRefs(java.lang.String template,
                          java.util.Properties attributes)
                   throws XDocletException

Evaluates the body block for each ejb:ejb-ref defined for the EJB. One of the useful things is does is to lookup the EJB using the ejb-name parameter of ejb:ejb-ref and fill in other required info.

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception

storeReferringClassId

protected void storeReferringClassId()
                              throws XDocletException

Stores the id of current EJB for further use by other tags in referringClassId attribute.

Throws:

XDocletException - Description of Exception

findEjb

protected com.sun.javadoc.ClassDoc findEjb(java.lang.String ejbName)
                                    throws XDocletException

Finds and returns the class with the specified ejbName. An XDocletException is thrown if not found.

Parameters:

ejbName - Description of Parameter

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception