/*
* Copyright (c) 2001, 2002 The XDoclet team
* All rights reserved.
*/
package xdoclet.modules.ejb.home;
import org.apache.commons.logging.Log;
import xjavadoc.XClass;
import xjavadoc.XTag;
import xdoclet.XDocletException;
import xdoclet.XDocletMessages;
import xdoclet.modules.ejb.AbstractEjbCodeGeneratorSubTask;
import xdoclet.modules.ejb.XDocletModulesEjbMessages;
import xdoclet.modules.ejb.intf.InterfaceTagsHandler;
import xdoclet.tagshandler.PackageTagsHandler;
import xdoclet.util.LogUtil;
import xdoclet.util.Translator;
/**
* Generates local home interfaces for EJBs.
*
* @author Ara Abrahamian (ara_e@email.com)
* @created Oct 15, 2001
* @ant.element display-name="Local Home Interface" name="localhomeinterface"
* parent="xdoclet.modules.ejb.EjbDocletTask"
* @version $Revision: 1.13 $
* @xdoclet.merge-file file="local-home-custom.xdt" relates-to="{0}LocalHome.java" description="A text file containing
* custom template and/or java code to include in the local home interface."
*/
public class LocalHomeInterfaceSubTask extends AbstractEjbCodeGeneratorSubTask
{
public final static String DEFAULT_LOCALHOMEINTERFACE_CLASS_PATTERN = "{0}LocalHome";
protected final static String DEFAULT_TEMPLATE_FILE = "resources/home-local.xdt";
/**
* A configuration parameter for specifying the local home interface name pattern. By default the value is used for
* deciding the local home interface name. The placeholder "{0}" in the value means the current class's symbolic
* name which for an EJBean is the EJB name.
*
* @see #getLocalHomeClassPattern()
*/
protected String localHomeClassPattern;
/**
* Describe what the LocalHomeInterfaceSubTask constructor does
*/
public LocalHomeInterfaceSubTask()
{
setTemplateURL(getClass().getResource(DEFAULT_TEMPLATE_FILE));
setDestinationFile(getLocalHomeClassPattern() + ".java");
addOfType("javax.ejb.EntityBean");
addOfType("javax.ejb.SessionBean");
}
/**
* Returns the configuration parameter for specifying the local home interface name pattern. By default the value is
* used for deciding the local home interface 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}LocalHome" is
* used by default.
*
* @return The LocalHomeClassPattern value
* @see #localHomeClassPattern
*/
public String getLocalHomeClassPattern()
{
if (localHomeClassPattern != null) {
return localHomeClassPattern;
}
else {
return DEFAULT_LOCALHOMEINTERFACE_CLASS_PATTERN;
}
}
/**
* The pattern by which the local home interfaces are named. The placeholder "{0}" designates the EJB name.
*
* @param new_pattern The new Pattern value
* @ant.not-required No, defaults to {0}LocalHome
*/
public void setPattern(String new_pattern)
{
localHomeClassPattern = new_pattern;
}
/**
* Called to validate configuration parameters.
*
* @exception XDocletException
*/
public void validateOptions() throws XDocletException
{
super.validateOptions();
if (getLocalHomeClassPattern() == null || getLocalHomeClassPattern().trim().equals("")) {
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.PARAMETER_MISSING_OR_EMPTY, new String[]{"pattern"}));
}
if (getLocalHomeClassPattern().indexOf("{0}") == -1) {
throw new XDocletException(Translator.getString(XDocletModulesEjbMessages.class, XDocletModulesEjbMessages.PATTERN_HAS_NO_PLACEHOLDER));
}
}
/**
* Gets the GeneratedFileName attribute of the LocalHomeInterfaceSubTask object
*
* @param clazz Describe what the parameter does
* @return The GeneratedFileName value
* @exception XDocletException
*/
protected String getGeneratedFileName(XClass clazz) throws XDocletException
{
return PackageTagsHandler.packageNameAsPathFor(HomeTagsHandler.getHomeInterface("local", getCurrentClass())) + ".java";
}
/**
* Describe what the method does
*
* @param clazz Describe what the parameter does
* @return Describe the return value
* @exception XDocletException
*/
protected boolean matchesGenerationRules(XClass clazz) throws XDocletException
{
if (super.matchesGenerationRules(clazz) == false) {
return false;
}
Log log = LogUtil.getLog(LocalHomeInterfaceSubTask.class, "matchesGenerationRules");
if (!InterfaceTagsHandler.isLocalEjb(getCurrentClass())) {
log.debug("Reject file " + clazz.getQualifiedName() + " because of different view-type");
return false;
}
XTag interfaceTag = getCurrentClass().getDoc().getTag("ejb:home");
if (interfaceTag == null) {
return true;
}
String generate = interfaceTag.getAttributeValue("generate");
if (generate != null && generate.indexOf("local") == -1) {
log.debug("Skip local home interface for " + clazz.getQualifiedName() + " because of generate=" + generate + " flag.");
return false;
}
return true;
}
/**
* Describe what the method does
*
* @exception XDocletException
*/
protected void engineStarted() throws XDocletException
{
System.out.println(Translator.getString(XDocletModulesEjbMessages.class, XDocletModulesEjbMessages.GENERATING_LOCALHOME_FOR,
new String[]{getCurrentClass().getQualifiedName()}));
}
}