|
- /*
- * Copyright 2000-2006 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-
- package org.apache.tools.ant.taskdefs;
-
- import java.io.File;
- import java.util.Enumeration;
- import java.util.Iterator;
- import java.util.Vector;
- import org.apache.tools.ant.AntClassLoader;
- import org.apache.tools.ant.BuildException;
- import org.apache.tools.ant.DirectoryScanner;
- import org.apache.tools.ant.DynamicConfigurator;
- import org.apache.tools.ant.Project;
- import org.apache.tools.ant.types.Mapper;
- import org.apache.tools.ant.types.Path;
- import org.apache.tools.ant.types.Reference;
- import org.apache.tools.ant.types.Resource;
- import org.apache.tools.ant.types.ResourceCollection;
- import org.apache.tools.ant.types.XMLCatalog;
- import org.apache.tools.ant.types.resources.FileResource;
- import org.apache.tools.ant.types.resources.Union;
- import org.apache.tools.ant.util.FileNameMapper;
- import org.apache.tools.ant.util.FileUtils;
-
- /**
- * Processes a set of XML documents via XSLT. This is
- * useful for building views of XML based documentation.
- *
- *
- * @since Ant 1.1
- *
- * @ant.task name="xslt" category="xml"
- */
-
- public class XSLTProcess extends MatchingTask implements XSLTLogger {
- /** destination directory */
- private File destDir = null;
-
- /** where to find the source XML file, default is the project's basedir */
- private File baseDir = null;
-
- /** XSL stylesheet as a filename */
- private String xslFile = null;
-
- /** XSL stylesheet as a {@link org.apache.tools.ant.types.Resource} */
- private Resource xslResource = null;
-
- /** extension of the files produced by XSL processing */
- private String targetExtension = ".html";
-
- /** additional parameters to be passed to the stylesheets */
- private Vector params = new Vector();
-
- /** Input XML document to be used */
- private File inFile = null;
-
- /** Output file */
- private File outFile = null;
-
- /** The name of the XSL processor to use */
- private String processor;
-
- /** Classpath to use when trying to load the XSL processor */
- private Path classpath = null;
-
- /** The Liason implementation to use to communicate with the XSL
- * processor */
- private XSLTLiaison liaison;
-
- /** Flag which indicates if the stylesheet has been loaded into
- * the processor */
- private boolean stylesheetLoaded = false;
-
- /** force output of target files even if they already exist */
- private boolean force = false;
-
- /** XSL output properties to be used */
- private Vector outputProperties = new Vector();
-
- /** for resolving entities such as dtds */
- private XMLCatalog xmlCatalog = new XMLCatalog();
-
- /** Name of the TRAX Liaison class */
- private static final String TRAX_LIAISON_CLASS =
- "org.apache.tools.ant.taskdefs.optional.TraXLiaison";
-
- /** Utilities used for file operations */
- private static final FileUtils FILE_UTILS = FileUtils.getFileUtils();
-
- /**
- * Whether to style all files in the included directories as well.
- *
- * @since Ant 1.5
- */
- private boolean performDirectoryScan = true;
-
- /**
- * factory element for TraX processors only
- * @since Ant 1.6
- */
- private Factory factory = null;
-
- /**
- * whether to reuse Transformer if transforming multiple files.
- * @since 1.5.2
- */
- private boolean reuseLoadedStylesheet = true;
-
- /**
- * AntClassLoader for the nested <classpath> - if set.
- *
- * <p>We keep this here in order to reset the context classloader
- * in execute. We can't use liaison.getClass().getClassLoader()
- * since the actual liaison class may have been loaded by a loader
- * higher up (system classloader, for example).</p>
- *
- * @since Ant 1.6.2
- */
- private AntClassLoader loader = null;
-
- /**
- * Mapper to use when a set of files gets processed.
- *
- * @since Ant 1.6.2
- */
- private Mapper mapperElement = null;
-
- /**
- * Additional resource collections to process.
- *
- * @since Ant 1.7
- */
- private Union resources = new Union();
-
- /**
- * Whether to use the implicit fileset.
- *
- * @since Ant 1.7
- */
- private boolean useImplicitFileset = true;
-
- /**
- * The default processor is trax
- * @since Ant 1.7
- */
- public static final String PROCESSOR_TRAX = "trax";
-
- /**
- * Creates a new XSLTProcess Task.
- */
- public XSLTProcess() {
- } //-- XSLTProcess
-
- /**
- * Whether to style all files in the included directories as well;
- * optional, default is true.
- *
- * @param b true if files in included directories are processed.
- * @since Ant 1.5
- */
- public void setScanIncludedDirectories(boolean b) {
- performDirectoryScan = b;
- }
-
- /**
- * Controls whether the stylesheet is reloaded for every transform.
- *
- * <p>Setting this to true may get around a bug in certain
- * Xalan-J versions, default is false.</p>
- * @param b a <code>boolean</code> value
- * @since Ant 1.5.2
- */
- public void setReloadStylesheet(boolean b) {
- reuseLoadedStylesheet = !b;
- }
-
- /**
- * Defines the mapper to map source to destination files.
- * @param mapper the mapper to use
- * @exception BuildException if more than one mapper is defined
- * @since Ant 1.6.2
- */
- public void addMapper(Mapper mapper) {
- if (mapperElement != null) {
- throw new BuildException("Cannot define more than one mapper",
- getLocation());
- }
- mapperElement = mapper;
- }
-
- /**
- * Adds a collection of resources to style in addition to the
- * given file or the implicit fileset.
- *
- * @param rc the collection of resources to style
- * @since Ant 1.7
- */
- public void add(ResourceCollection rc) {
- resources.add(rc);
- }
-
- /**
- * Adds the XSLT stylesheet as a resource
- * @param xslResource the stylesheet as a
- * {@link org.apache.tools.ant.types.Resource}
- * @since Ant 1.7
- */
- public void addConfigured(Resource xslResource) {
- this.xslResource = xslResource;
- }
-
- /**
- * Adds a nested filenamemapper.
- * @param fileNameMapper the mapper to add
- * @exception BuildException if more than one mapper is defined
- * @since Ant 1.7.0
- */
- public void add(FileNameMapper fileNameMapper) throws BuildException {
- Mapper mapper = new Mapper(getProject());
- mapper.add(fileNameMapper);
- addMapper(mapper);
- }
-
- /**
- * Executes the task.
- *
- * @exception BuildException if there is an execution problem.
- * @todo validate that if either in or our is defined, then both are
- */
- public void execute() throws BuildException {
- if ("style".equals(getTaskType())) {
- log("Warning: the task name <style> is deprecated. Use <xslt> instead.",
- Project.MSG_WARN);
- }
-
- File savedBaseDir = baseDir;
-
- DirectoryScanner scanner;
- String[] list;
- String[] dirs;
-
- if (xslResource == null && xslFile == null) {
- throw new BuildException("specify the "
- + "stylesheet either as a filename in style "
- + "attribute or as a nested resource", getLocation());
-
- }
- if (xslResource != null && xslFile != null) {
- throw new BuildException("specify the "
- + "stylesheet either as a filename in style "
- + "attribute or as a nested resource but not "
- + "as both", getLocation());
- }
-
- if (inFile != null && !inFile.exists()) {
- throw new BuildException(
- "input file " + inFile.toString() + " does not exist", getLocation());
- }
-
- try {
- if (baseDir == null) {
- baseDir = getProject().resolveFile(".");
- }
-
- liaison = getLiaison();
-
- // check if liaison wants to log errors using us as logger
- if (liaison instanceof XSLTLoggerAware) {
- ((XSLTLoggerAware) liaison).setLogger(this);
- }
-
- log("Using " + liaison.getClass().toString(), Project.MSG_VERBOSE);
-
- if (xslFile != null) {
- // If we enter here, it means that the stylesheet is supplied
- // via style attribute
- File stylesheet = getProject().resolveFile(xslFile);
- if (!stylesheet.exists()) {
- stylesheet = FILE_UTILS.resolveFile(baseDir, xslFile);
- /*
- * shouldn't throw out deprecation warnings before we know,
- * the wrong version has been used.
- */
- if (stylesheet.exists()) {
- log("DEPRECATED - the 'style' attribute should be relative "
- + "to the project's");
- log(" basedir, not the tasks's basedir.");
- }
- }
- FileResource fr = new FileResource();
- fr.setProject(getProject());
- fr.setFile(stylesheet);
- xslResource = fr;
- }
-
- // if we have an in file and out then process them
- if (inFile != null && outFile != null) {
- process(inFile, outFile, xslResource);
- return;
- }
-
- /*
- * if we get here, in and out have not been specified, we are
- * in batch processing mode.
- */
-
- //-- make sure destination directory exists...
- checkDest();
-
- if (useImplicitFileset) {
- scanner = getDirectoryScanner(baseDir);
- log("Transforming into " + destDir, Project.MSG_INFO);
-
- // Process all the files marked for styling
- list = scanner.getIncludedFiles();
- for (int i = 0; i < list.length; ++i) {
- process(baseDir, list[i], destDir, xslResource);
- }
- if (performDirectoryScan) {
- // Process all the directories marked for styling
- dirs = scanner.getIncludedDirectories();
- for (int j = 0; j < dirs.length; ++j) {
- list = new File(baseDir, dirs[j]).list();
- for (int i = 0; i < list.length; ++i) {
- process(baseDir, dirs[j] + File.separator + list[i],
- destDir, xslResource);
- }
- }
- }
- } else { // only resource collections, there better be some
- if (resources.size() == 0) {
- throw new BuildException("no resources specified");
- }
- }
- processResources(xslResource);
- } finally {
- if (loader != null) {
- loader.resetThreadContextLoader();
- loader.cleanup();
- loader = null;
- }
- liaison = null;
- stylesheetLoaded = false;
- baseDir = savedBaseDir;
- }
- }
-
- /**
- * Set whether to check dependencies, or always generate;
- * optional, default is false.
- *
- * @param force true if always generate.
- */
- public void setForce(boolean force) {
- this.force = force;
- }
-
- /**
- * Set the base directory;
- * optional, default is the project's basedir.
- *
- * @param dir the base directory
- **/
- public void setBasedir(File dir) {
- baseDir = dir;
- }
-
- /**
- * Set the destination directory into which the XSL result
- * files should be copied to;
- * required, unless <tt>in</tt> and <tt>out</tt> are
- * specified.
- * @param dir the name of the destination directory
- **/
- public void setDestdir(File dir) {
- destDir = dir;
- }
-
- /**
- * Set the desired file extension to be used for the target;
- * optional, default is html.
- * @param name the extension to use
- **/
- public void setExtension(String name) {
- targetExtension = name;
- }
-
- /**
- * Name of the stylesheet to use - given either relative
- * to the project's basedir or as an absolute path; required.
- *
- * @param xslFile the stylesheet to use
- */
- public void setStyle(String xslFile) {
- this.xslFile = xslFile;
- }
-
- /**
- * Set the optional classpath to the XSL processor
- *
- * @param classpath the classpath to use when loading the XSL processor
- */
- public void setClasspath(Path classpath) {
- createClasspath().append(classpath);
- }
-
- /**
- * Set the optional classpath to the XSL processor
- *
- * @return a path instance to be configured by the Ant core.
- */
- public Path createClasspath() {
- if (classpath == null) {
- classpath = new Path(getProject());
- }
- return classpath.createPath();
- }
-
- /**
- * Set the reference to an optional classpath to the XSL processor
- *
- * @param r the id of the Ant path instance to act as the classpath
- * for loading the XSL processor
- */
- public void setClasspathRef(Reference r) {
- createClasspath().setRefid(r);
- }
-
- /**
- * Set the name of the XSL processor to use; optional, default trax.
- * Other values are "xalan" for Xalan1
- *
- * @param processor the name of the XSL processor
- */
- public void setProcessor(String processor) {
- this.processor = processor;
- }
-
- /**
- * Whether to use the implicit fileset.
- *
- * <p>Set this to false if you want explicit control with nested
- * resource collections.</p>
- * @param useimplicitfileset set to true if you want to use implicit fileset
- * @since Ant 1.7
- */
- public void setUseImplicitFileset(boolean useimplicitfileset) {
- useImplicitFileset = useimplicitfileset;
- }
-
- /**
- * Add the catalog to our internal catalog
- *
- * @param xmlCatalog the XMLCatalog instance to use to look up DTDs
- */
- public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog) {
- this.xmlCatalog.addConfiguredXMLCatalog(xmlCatalog);
- }
-
- /**
- * Load processor here instead of in setProcessor - this will be
- * called from within execute, so we have access to the latest
- * classpath.
- *
- * @param proc the name of the processor to load.
- * @exception Exception if the processor cannot be loaded.
- */
- private void resolveProcessor(String proc) throws Exception {
- String classname;
- if (proc.equals(PROCESSOR_TRAX)) {
- classname = TRAX_LIAISON_CLASS;
- } else {
- //anything else is a classname
- classname = proc;
- }
- Class clazz = loadClass(classname);
- liaison = (XSLTLiaison) clazz.newInstance();
- }
-
- /**
- * Load named class either via the system classloader or a given
- * custom classloader.
- *
- * As a side effect, the loader is set as the thread context classloader
- * @param classname the name of the class to load.
- * @return the requested class.
- * @exception Exception if the class could not be loaded.
- */
- private Class loadClass(String classname) throws Exception {
- if (classpath == null) {
- return Class.forName(classname);
- } else {
- loader = getProject().createClassLoader(classpath);
- loader.setThreadContextLoader();
- Class c = Class.forName(classname, true, loader);
- return c;
- }
- }
-
- /**
- * Specifies the output name for the styled result from the
- * <tt>in</tt> attribute; required if <tt>in</tt> is set
- *
- * @param outFile the output File instance.
- */
- public void setOut(File outFile) {
- this.outFile = outFile;
- }
-
- /**
- * specifies a single XML document to be styled. Should be used
- * with the <tt>out</tt> attribute; ; required if <tt>out</tt> is set
- *
- * @param inFile the input file
- */
- public void setIn(File inFile) {
- this.inFile = inFile;
- }
-
- /**
- * Throws a BuildException if the destination directory hasn't
- * been specified.
- * @since Ant 1.7
- */
- private void checkDest() {
- if (destDir == null) {
- String msg = "destdir attributes must be set!";
- throw new BuildException(msg);
- }
- }
-
- /**
- * Styles all existing resources.
- *
- * @since Ant 1.7
- */
- private void processResources(Resource stylesheet) {
- Iterator iter = resources.iterator();
- while (iter.hasNext()) {
- Resource r = (Resource) iter.next();
- if (!r.isExists()) {
- continue;
- }
- File base = baseDir;
- String name = r.getName();
- if (r instanceof FileResource) {
- FileResource f = (FileResource) r;
- base = f.getBaseDir();
- if (base == null) {
- name = f.getFile().getAbsolutePath();
- }
- }
- process(base, name, destDir, stylesheet);
- }
- }
-
- /**
- * Processes the given input XML file and stores the result
- * in the given resultFile.
- *
- * @param baseDir the base directory for resolving files.
- * @param xmlFile the input file
- * @param destDir the destination directory
- * @param stylesheet the stylesheet to use.
- * @exception BuildException if the processing fails.
- */
- private void process(File baseDir, String xmlFile, File destDir,
- Resource stylesheet)
- throws BuildException {
-
- File outF = null;
- File inF = null;
-
- try {
- long styleSheetLastModified = stylesheet.getLastModified();
- inF = new File(baseDir, xmlFile);
-
- if (inF.isDirectory()) {
- log("Skipping " + inF + " it is a directory.",
- Project.MSG_VERBOSE);
- return;
- }
-
- FileNameMapper mapper = null;
- if (mapperElement != null) {
- mapper = mapperElement.getImplementation();
- } else {
- mapper = new StyleMapper();
- }
-
- String[] outFileName = mapper.mapFileName(xmlFile);
- if (outFileName == null || outFileName.length == 0) {
- log("Skipping " + inFile + " it cannot get mapped to output.",
- Project.MSG_VERBOSE);
- return;
- } else if (outFileName == null || outFileName.length > 1) {
- log("Skipping " + inFile + " its mapping is ambiguos.",
- Project.MSG_VERBOSE);
- return;
- }
-
- outF = new File(destDir, outFileName[0]);
-
- if (force
- || inF.lastModified() > outF.lastModified()
- || styleSheetLastModified > outF.lastModified()) {
- ensureDirectoryFor(outF);
- log("Processing " + inF + " to " + outF);
-
- configureLiaison(stylesheet);
- liaison.transform(inF, outF);
- }
- } catch (Exception ex) {
- // If failed to process document, must delete target document,
- // or it will not attempt to process it the second time
- log("Failed to process " + inFile, Project.MSG_INFO);
- if (outF != null) {
- outF.delete();
- }
-
- throw new BuildException(ex);
- }
-
- } //-- processXML
-
- /**
- * Process the input file to the output file with the given stylesheet.
- *
- * @param inFile the input file to process.
- * @param outFile the destination file.
- * @param stylesheet the stylesheet to use.
- * @exception BuildException if the processing fails.
- */
- private void process(File inFile, File outFile, Resource stylesheet)
- throws BuildException {
- try {
- long styleSheetLastModified = stylesheet.getLastModified();
- log("In file " + inFile + " time: " + inFile.lastModified(),
- Project.MSG_DEBUG);
- log("Out file " + outFile + " time: " + outFile.lastModified(),
- Project.MSG_DEBUG);
- log("Style file " + xslFile + " time: " + styleSheetLastModified,
- Project.MSG_DEBUG);
- if (force || inFile.lastModified() >= outFile.lastModified()
- || styleSheetLastModified >= outFile.lastModified()) {
- ensureDirectoryFor(outFile);
- log("Processing " + inFile + " to " + outFile,
- Project.MSG_INFO);
- configureLiaison(stylesheet);
- liaison.transform(inFile, outFile);
- } else {
- log("Skipping input file " + inFile
- + " because it is older than output file " + outFile
- + " and so is the stylesheet " + stylesheet, Project.MSG_DEBUG);
- }
- } catch (Exception ex) {
- log("Failed to process " + inFile, Project.MSG_INFO);
- if (outFile != null) {
- outFile.delete();
- }
- throw new BuildException(ex);
- }
- }
-
- /**
- * Ensure the directory exists for a given file
- *
- * @param targetFile the file for which the directories are required.
- * @exception BuildException if the directories cannot be created.
- */
- private void ensureDirectoryFor(File targetFile)
- throws BuildException {
- File directory = targetFile.getParentFile();
- if (!directory.exists()) {
- if (!directory.mkdirs()) {
- throw new BuildException("Unable to create directory: "
- + directory.getAbsolutePath());
- }
- }
- }
-
- /**
- * Get the factory instance configured for this processor
- *
- * @return the factory instance in use
- */
- public Factory getFactory() {
- return factory;
- }
-
- /**
- * Get the XML catalog containing entity definitions
- *
- * @return the XML catalog for the task.
- */
- public XMLCatalog getXMLCatalog() {
- return xmlCatalog;
- }
-
- /**
- * Get an enumeration on the outputproperties.
- * @return the outputproperties
- */
- public Enumeration getOutputProperties() {
- return outputProperties.elements();
- }
-
-
- /**
- * Get the Liason implementation to use in processing.
- *
- * @return an instance of the XSLTLiason interface.
- */
- protected XSLTLiaison getLiaison() {
- // if processor wasn't specified, see if TraX is available. If not,
- // default it to xalan, depending on which is in the classpath
- if (liaison == null) {
- if (processor != null) {
- try {
- resolveProcessor(processor);
- } catch (Exception e) {
- throw new BuildException(e);
- }
- } else {
- try {
- resolveProcessor(PROCESSOR_TRAX);
- } catch (Throwable e1) {
- e1.printStackTrace();
- throw new BuildException(e1);
- }
- }
- }
- return liaison;
- }
-
- /**
- * Create an instance of an XSL parameter for configuration by Ant.
- *
- * @return an instance of the Param class to be configured.
- */
- public Param createParam() {
- Param p = new Param();
- params.addElement(p);
- return p;
- }
-
- /**
- * The Param inner class used to store XSL parameters
- */
- public static class Param {
- /** The parameter name */
- private String name = null;
-
- /** The parameter's value */
- private String expression = null;
-
- private String ifProperty;
- private String unlessProperty;
- private Project project;
-
- /**
- * Set the current project
- *
- * @param project the current project
- */
- public void setProject(Project project) {
- this.project = project;
- }
-
- /**
- * Set the parameter name.
- *
- * @param name the name of the parameter.
- */
- public void setName(String name) {
- this.name = name;
- }
-
- /**
- * The parameter value
- * NOTE : was intended to be an XSL expression.
- * @param expression the parameter's value.
- */
- public void setExpression(String expression) {
- this.expression = expression;
- }
-
- /**
- * Get the parameter name
- *
- * @return the parameter name
- * @exception BuildException if the name is not set.
- */
- public String getName() throws BuildException {
- if (name == null) {
- throw new BuildException("Name attribute is missing.");
- }
- return name;
- }
-
- /**
- * Get the parameter's value
- *
- * @return the parameter value
- * @exception BuildException if the value is not set.
- */
- public String getExpression() throws BuildException {
- if (expression == null) {
- throw new BuildException("Expression attribute is missing.");
- }
- return expression;
- }
-
- /**
- * Set whether this param should be used. It will be
- * used if the property has been set, otherwise it won't.
- * @param ifProperty name of property
- */
- public void setIf(String ifProperty) {
- this.ifProperty = ifProperty;
- }
-
- /**
- * Set whether this param should NOT be used. It
- * will not be used if the property has been set, otherwise it
- * will be used.
- * @param unlessProperty name of property
- */
- public void setUnless(String unlessProperty) {
- this.unlessProperty = unlessProperty;
- }
- /**
- * Ensures that the param passes the conditions placed
- * on it with <code>if</code> and <code>unless</code> properties.
- * @return true if the task passes the "if" and "unless" parameters
- */
- public boolean shouldUse() {
- if (ifProperty != null && project.getProperty(ifProperty) == null) {
- return false;
- } else if (unlessProperty != null
- && project.getProperty(unlessProperty) != null) {
- return false;
- }
-
- return true;
- }
- } // Param
-
-
- /**
- * Create an instance of an output property to be configured.
- * @return the newly created output property.
- * @since Ant 1.5
- */
- public OutputProperty createOutputProperty() {
- OutputProperty p = new OutputProperty();
- outputProperties.addElement(p);
- return p;
- }
-
-
- /**
- * Specify how the result tree should be output as specified
- * in the <a href="http://www.w3.org/TR/xslt#output">
- * specification</a>.
- * @since Ant 1.5
- */
- public static class OutputProperty {
- /** output property name */
- private String name;
-
- /** output property value */
- private String value;
-
- /**
- * @return the output property name.
- */
- public String getName() {
- return name;
- }
-
- /**
- * set the name for this property
- * @param name A non-null String that specifies an
- * output property name, which may be namespace qualified.
- */
- public void setName(String name) {
- this.name = name;
- }
-
- /**
- * @return the output property value.
- */
- public String getValue() {
- return value;
- }
-
- /**
- * set the value for this property
- * @param value The non-null string value of the output property.
- */
- public void setValue(String value) {
- this.value = value;
- }
- }
-
- /**
- * Initialize internal instance of XMLCatalog
- * @throws BuildException on error
- */
- public void init() throws BuildException {
- super.init();
- xmlCatalog.setProject(getProject());
- }
-
- /**
- * Loads the stylesheet and set xsl:param parameters.
- *
- * @param stylesheet the file from which to load the stylesheet.
- * @exception BuildException if the stylesheet cannot be loaded.
- * @deprecated since Ant 1.7
- */
- protected void configureLiaison(File stylesheet) throws BuildException {
- FileResource fr = new FileResource();
- fr.setProject(getProject());
- fr.setFile(stylesheet);
- configureLiaison(fr);
- }
- /**
- * Loads the stylesheet and set xsl:param parameters.
- *
- * @param stylesheet the resource from which to load the stylesheet.
- * @exception BuildException if the stylesheet cannot be loaded.
- * @since Ant 1.7
- */
- protected void configureLiaison(Resource stylesheet) throws BuildException {
- if (stylesheetLoaded && reuseLoadedStylesheet) {
- return;
- }
- stylesheetLoaded = true;
-
- try {
- log("Loading stylesheet " + stylesheet, Project.MSG_INFO);
- // We call liason.configure() and then liaison.setStylesheet()
- // so that the internal variables of liaison can be set up
- if (liaison instanceof XSLTLiaison2) {
- ((XSLTLiaison2) liaison).configure(this);
- }
-
- if (liaison instanceof XSLTLiaison3) {
- // If we are here we can set the stylesheet as a
- // resource
- ((XSLTLiaison3) liaison).setStylesheet(stylesheet);
- } else {
- // If we are here we cannot set the stylesheet as
- // a resource, but we can set it as a file. So,
- // we make an attempt to get it as a file
- if (stylesheet instanceof FileResource) {
- liaison.setStylesheet(
- ((FileResource) stylesheet).getFile());
- } else {
- throw new BuildException(liaison.getClass().toString()
- + " accepts the stylesheet only as a file",
- getLocation());
- }
- }
- for (Enumeration e = params.elements(); e.hasMoreElements();) {
- Param p = (Param) e.nextElement();
- if (p.shouldUse()) {
- liaison.addParam(p.getName(), p.getExpression());
- }
- }
- } catch (Exception ex) {
- log("Failed to transform using stylesheet " + stylesheet,
- Project.MSG_INFO);
- throw new BuildException(ex);
- }
- }
-
- /**
- * Create the factory element to configure a trax liaison.
- * @return the newly created factory element.
- * @throws BuildException if the element is created more than one time.
- */
- public Factory createFactory() throws BuildException {
- if (factory != null) {
- throw new BuildException("'factory' element must be unique");
- }
- factory = new Factory();
- return factory;
- }
-
- /**
- * The factory element to configure a transformer factory
- * @since Ant 1.6
- */
- public static class Factory {
-
- /** the factory class name to use for TraXLiaison */
- private String name;
-
- /**
- * the list of factory attributes to use for TraXLiaison
- */
- private Vector attributes = new Vector();
-
- /**
- * @return the name of the factory.
- */
- public String getName() {
- return name;
- }
-
- /**
- * Set the name of the factory
- * @param name the name of the factory.
- */
- public void setName(String name) {
- this.name = name;
- }
-
- /**
- * Create an instance of a factory attribute.
- * @param attr the newly created factory attribute
- */
- public void addAttribute(Attribute attr) {
- attributes.addElement(attr);
- }
-
- /**
- * return the attribute elements.
- * @return the enumeration of attributes
- */
- public Enumeration getAttributes() {
- return attributes.elements();
- }
-
- /**
- * A JAXP factory attribute. This is mostly processor specific, for
- * example for Xalan 2.3+, the following attributes could be set:
- * <ul>
- * <li>http://xml.apache.org/xalan/features/optimize (true|false) </li>
- * <li>http://xml.apache.org/xalan/features/incremental (true|false) </li>
- * </ul>
- */
- public static class Attribute implements DynamicConfigurator {
-
- /** attribute name, mostly processor specific */
- private String name;
-
- /** attribute value, often a boolean string */
- private Object value;
-
- /**
- * @return the attribute name.
- */
- public String getName() {
- return name;
- }
-
- /**
- * @return the output property value.
- */
- public Object getValue() {
- return value;
- }
-
- /**
- * Not used.
- * @param name not used
- * @return null
- * @throws BuildException never
- */
- public Object createDynamicElement(String name) throws BuildException {
- return null;
- }
-
- /**
- * Set an attribute.
- * Only "name" and "value" are supported as names.
- * @param name the name of the attribute
- * @param value the value of the attribute
- * @throws BuildException on error
- */
- public void setDynamicAttribute(String name, String value)
- throws BuildException {
- // only 'name' and 'value' exist.
- if ("name".equalsIgnoreCase(name)) {
- this.name = value;
- } else if ("value".equalsIgnoreCase(name)) {
- // a value must be of a given type
- // say boolean|integer|string that are mostly used.
- if ("true".equalsIgnoreCase(value)) {
- this.value = Boolean.TRUE;
- } else if ("false".equalsIgnoreCase(value)) {
- this.value = Boolean.FALSE;
- } else {
- try {
- this.value = new Integer(value);
- } catch (NumberFormatException e) {
- this.value = value;
- }
- }
- } else {
- throw new BuildException("Unsupported attribute: " + name);
- }
- }
- } // -- class Attribute
-
- } // -- class Factory
-
- /**
- * Mapper implementation of the "traditional" way <xslt>
- * mapped filenames.
- *
- * <p>If the file has an extension, chop it off. Append whatever
- * the user has specified as extension or ".html".</p>
- *
- * @since Ant 1.6.2
- */
- private class StyleMapper implements FileNameMapper {
- public void setFrom(String from) {
- }
- public void setTo(String to) {
- }
- public String[] mapFileName(String xmlFile) {
- int dotPos = xmlFile.lastIndexOf('.');
- if (dotPos > 0) {
- xmlFile = xmlFile.substring(0, dotPos);
- }
- return new String[] {xmlFile + targetExtension};
- }
- }
-
- }
|