You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by je...@apache.org on 2003/01/12 12:50:34 UTC

cvs commit: xml-forrest/src/resources/tasks/org/apache/cocoon/transformation IdGeneratorTransformer.java XPathTransformer.java

jefft       2003/01/12 03:50:34

  Added:       src/resources/tasks/org/apache/cocoon/transformation
                        IdGeneratorTransformer.java XPathTransformer.java
  Log:
  Components used in Forrest's sitemap
  
  Revision  Changes    Path
  1.1                  xml-forrest/src/resources/tasks/org/apache/cocoon/transformation/IdGeneratorTransformer.java
  
  Index: IdGeneratorTransformer.java
  ===================================================================
  /*
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
  
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Apache Cocoon" and  "Apache Software Foundation" must  not  be
      used to  endorse or promote  products derived from  this software without
      prior written permission. For written permission, please contact
      apache@apache.org.
  
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation and was  originally created by
   Stefano Mazzocchi  <st...@apache.org>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
  
  */
  package org.apache.cocoon.transformation;
  
  import org.apache.avalon.framework.configuration.Configurable;
  import org.apache.avalon.framework.configuration.Configuration;
  import org.apache.avalon.framework.configuration.ConfigurationException;
  import org.apache.avalon.framework.component.ComponentManager;
  import org.apache.avalon.framework.parameters.Parameters;
  import org.apache.cocoon.ProcessingException;
  import org.apache.avalon.excalibur.xml.xpath.XPathProcessor;
  import org.apache.cocoon.environment.SourceResolver;
  import org.apache.cocoon.caching.Cacheable;
  import org.apache.cocoon.caching.CacheValidity;
  import org.apache.cocoon.caching.NOPCacheValidity;
  import org.apache.cocoon.xml.XMLUtils;
  import org.apache.cocoon.util.HashUtil;
  
  import org.w3c.dom.Document;
  import org.w3c.dom.Text;
  import org.w3c.dom.Element;
  import org.w3c.dom.Attr;
  import org.w3c.dom.DOMException;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  import org.xml.sax.Attributes;
  import org.xml.sax.InputSource;
  import org.xml.sax.Locator;
  import org.xml.sax.SAXException;
  
  import java.io.*;
  import java.net.MalformedURLException;
  import java.net.URLEncoder;
  import java.util.Map;
  import java.util.Stack;
  
  /**
   * A Transformer for adding a URL-encoded 'id' attribute to a node, whose value
   * is determined by the string value of another node.
   *
   * <p>
   * For example, if we were parsing XML like:
   * <pre>
   * &lt;section>
   *   &lt;title>Blah blah</title>
   *   ....
   * &lt;/section>
   * </pre>
   * We could add an 'id' attribute to the 'section' element with a transformer
   * configured as follows:
   * <pre>
   * &lt;map:transformer name="idgen"
   *      src="org.apache.cocoon.transformation.IdGeneratorTransformer">
   *   &lt;element>/document/body//*[local-name() = 'section']&lt;/element>
   *   &lt;id>title/text()&lt;/id>
   * &lt;/map:transformer>
   * </pre>
   * The 'element' parameter is an XPath expression identifying candidates for
   * having an id added.
   * The 'id' parameter is an XPath relative to each found 'element', and
   * specifies a string to use as the id attribute value.  The value will be URL
   * encoded in the id attribute.  If an id with the specified value already
   * exists, the new id will be made unique with XPath's
   * <code>generate-id()</code> function.
   * <p>
   * By default, the added attribute is called <code>id</code>.  This can be
   * altered by specifying an <code>id-attr</code> parameter:
   * <pre>
   *   &lt;id-attr>ID&lt;/id-attr>
   * </pre>
   * If the specified attribute is already present on the node, it will not be
   * rewritten.
   */
  public class IdGeneratorTransformer
      extends AbstractDOMTransformer
      implements Cacheable, Configurable
  {
  
      /** XPath Processor */
      private XPathProcessor processor = null;
  
      protected String elementXPath = null;
      protected String idXPath = null;
      protected String idAttr = null;
  
      public void configure(Configuration configuration) throws ConfigurationException {
          getLogger().info("## || Configuring IdGeneratorTransformer with "+configuration);
          this.elementXPath = configuration.getChild("element").getValue(null);
          this.idXPath = configuration.getChild("id").getValue(null);
          this.idAttr = configuration.getChild("id-attr").getValue("id");
          if (elementXPath == null) {
              throw new ConfigurationException(
                      "## The IdGenerator 'element' parameter must be specified. For example, "+
                      "<element>/document/body//*[local-name() = 'section']</element>");
          }
          if (idXPath == null) {
              throw new ConfigurationException(
                      "## The IdGenerator 'id' parameter must be specified. For example,"+
                      "<id>title/text()</id>");
          }
      }
  
      public void setup(SourceResolver resolver, Map objectModel,
              String source, Parameters parameters)
          throws ProcessingException, SAXException, IOException
      {
          super.setup(resolver, objectModel, source, parameters);
          /*
           If you prefer dynamic configuration, use this instead of
           configure(), and remember to clear the fields in recycle()
  
          this.elementXPath = (String)parameters.getParameter("element", null);
          if (this.elementXPath == null) {
              throw new ProcessingException(
                      "The IdGenerator 'element' parameter must be specified. For example, "+
                      "<map:parameter name=\"element\" value=\"/document/body//*[local-name() = 'section']\"/>");
          }
          this.idXPath = (String)parameters.getParameter("id", null);
          if (idXPath == null) {
              throw new ProcessingException(
                      "The IdGenerator 'id' parameter must be specified. For example,"+
                      "<map:parameter name=\"id\" value=\"title/text()\"/>");
          }
          this.idAttr = (String)parameters.getParameter("id-attr", "id");
          */
      }
  
      public void compose(ComponentManager manager) {
          super.compose(manager);
          try {
              this.processor = (XPathProcessor)this.manager.lookup(XPathProcessor.ROLE);
          } catch (Exception e) {
              getLogger().error("cannot obtain XPathProcessor", e);
          }
      }
  
      /** Implementation of a template method declared in AbstractDOMTransformer.
       * @param doc DOM of XML received by the transformer
       * @return A pared-down DOM.
       */
      protected Document transform(Document doc) {
          getLogger().debug("## Transforming with element='"+elementXPath+"', id='"+idXPath+"'");
          Document newDoc = null;
          try {
              newDoc = addIds(doc, elementXPath, idXPath);
          } catch (SAXException se) {
              // Really ought to be able to propagate these to caller
              getLogger().error("Error when transforming XML", se);
              throw new RuntimeException("Error transforming XML. See error log for details: "+se);
          }
          return newDoc;
      }
  
      private Document addIds(Document doc, String elementXPath, String idXPath) throws SAXException {
          getLogger().debug("## Using element XPath "+elementXPath);
          NodeList sects = processor.selectNodeList(doc, elementXPath);
          getLogger().debug("## .. got "+sects.getLength()+" sections");
          for (int i=0; i<sects.getLength(); i++) {
              Element sect = (Element)sects.item(i);
              sect.normalize();
              getLogger().debug("## Using id XPath "+idXPath);
              String id = null;
              try {
                id = processor.evaluateAsString(sect, idXPath);
              } catch (Exception e) {
                  throw new RuntimeException("'id' XPath expression '"+idXPath+"' does not return a text node: "+e);
              }
              getLogger().info("## Got id "+id);
              if (!sect.hasAttribute(this.idAttr)) {
                  String newId = URLEncoder.encode(id);
                  newId = avoidConflicts(doc, sect, this.idAttr, newId);
                  sect.setAttribute(this.idAttr, newId);
              }
          }
          return doc;
      }
  
      /**
       * Ensure that IDs aren't repeated in the document.  If an element with the
       * specified id is already present, <code>generate-id</code> is used to
       * distinguish the new one.
       */
      private String avoidConflicts(Document doc, Element sect, String idAttr, String newId) {
          // We rely on the URLencoding of newId to avoid ' conflicts here:
          NodeList conflicts = processor.selectNodeList(doc, "//*[@"+idAttr+"='"+newId+"']");
          int numConflicts = conflicts.getLength();
          getLogger().info("## "+numConflicts+" conflicts with "+newId);
          if (numConflicts != 0) {
              newId += "-"+processor.evaluateAsString(sect, "generate-id()");
          }
          return newId;
      }
  
      // Cache methods
  
      /**
       * Generate the unique key.
       * This key must be unique inside the space of this component.
       *
       * @return A hash of the element and id parameters, thus uniquely
       * identifying this IdGenerator amongst it's peers.
       */
      public long generateKey() {
          return HashUtil.hash(this.elementXPath+this.idXPath);
      }
  
      /**
       * Generate the validity object.
       *
       * @return An "always valid" CacheValidity object. This transformer has no
       * inputs other than the incoming SAX events.
       */
      public CacheValidity generateValidity() {
          return new NOPCacheValidity();
      }
  
      /**
       * Recycle the component.
       */
      public void recycle() {
          super.recycle();
          // Uncomment these if we're dynamically (in the map:transform) configuring
          //this.elementXPath = null;
          //this.idXPath = null;
          // note that we don't turf our processor,
      }
  
      /**
       * dispose
       */
      public void dispose() {
          super.dispose();
          this.processor = null;
          this.elementXPath = null;
          this.idXPath = null;
          this.idAttr = null;
      }
  }
  
  
  
  1.1                  xml-forrest/src/resources/tasks/org/apache/cocoon/transformation/XPathTransformer.java
  
  Index: XPathTransformer.java
  ===================================================================
  /*
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
  
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Apache Cocoon" and  "Apache Software Foundation" must  not  be
      used to  endorse or promote  products derived from  this software without
      prior written permission. For written permission, please contact
      apache@apache.org.
  
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation and was  originally created by
   Stefano Mazzocchi  <st...@apache.org>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
  
  */
  package org.apache.cocoon.transformation;
  
  import org.apache.avalon.excalibur.xml.Parser;
  import org.apache.avalon.framework.component.ComponentManager;
  import org.apache.avalon.framework.parameters.Parameters;
  import org.apache.cocoon.ProcessingException;
  import org.apache.avalon.excalibur.xml.xpath.XPathProcessor;
  import org.apache.cocoon.environment.SourceResolver;
  import org.apache.cocoon.caching.Cacheable;
  import org.apache.cocoon.caching.CacheValidity;
  import org.apache.cocoon.caching.NOPCacheValidity;
  import org.apache.cocoon.xml.XMLUtils;
  import org.apache.cocoon.util.HashUtil;
  
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  import org.w3c.dom.Attr;
  import org.w3c.dom.DOMException;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  import org.xml.sax.Attributes;
  import org.xml.sax.InputSource;
  import org.xml.sax.Locator;
  import org.xml.sax.SAXException;
  
  import java.io.*;
  import java.net.MalformedURLException;
  import java.util.Map;
  import java.util.Stack;
  
  /**
   * A transformer that prunes the source tree based on <code>include</code> and
   * <code>exclude</code> XPath expressions.
   * The <code>include</code> parameter specifies nodes to let through, and
   * <code>exclude</code> parameter nodes to filter out. Either or both may be
   * omitted. The default behaviour is for all nodes to be let through
   * (<code>include</code> = "/").
   * <p>
   * This transformer should be declared in the sitemap at
   * <b>map:sitemap/map:components/map:transformers</b>, as follows<br>
   * <pre>
   * &lt;map:transformer logger="sitemap.transformer.xpath" name="xpath" src="org.apache.cocoon.transformation.XPathTransformer" /&gt;<br>
   * </pre>
   * <h3>Example usage</h3>
   * As an example, consider a user manual XML file:
   * <pre>
   * &lt;manual&gt;
   *   &lt;s1 title="Introduction"&gt;
   *     &lt;p&gt;This is the introduction&lt;/p&gt;
   *     &lt;p&gt;A second paragraph&lt;/p&gt;
   *   &lt;/s1&gt;
   *   &lt;s1 title="Getting started"&gt;
   *     &lt;p&gt;Getting started&lt;/p&gt;
   *     &lt;fixme&gt;Add some content here&lt;/fixme&gt;
   *     &lt;n:note xmlns:n="urn:notes"&gt;banana 1&lt;/n:note&gt; &lt;note&gt;banana 2&lt;/note&gt;
   *     &lt;p&gt;Yes, we have no bananas&lt;/p&gt;
   *   &lt;/s1&gt;
   * &lt;/manual&gt;
   * </pre>
   * We could now deliver named chapters as follows:
   * <pre>
   *   &lt;map:match pattern="manual/*"&gt;
   *      &lt;map:generate src="manual.xml"/&gt;
   *      &lt;map:transform type="xpath"&gt;
   *        &lt;map:parameter name="include" value="/manual/s1[@title='{1}']"/&gt;
   *      &lt;/map:transform&gt;
   *     &lt;map:serialize type="xml"/&gt;
   *   &lt;/map:match&gt;
   * </pre>
   * So <code>manual/Introduction</code> would return the first chapter.
   *
   * @author <a href="mailto:jefft@apache.org">Jeff Turner</a>
   * @version CVS $Id: XPathTransformer.java,v 1.1 2003/01/12 11:50:34 jefft Exp $
   */
  public class XPathTransformer
      extends AbstractDOMTransformer
      implements Cacheable
  {
  
      /** XPath Processor */
      private XPathProcessor processor = null;
      /** DOM Parser */
      private Parser parser = null;
  
      /** XPath specifying nodes to include. Defaults to the root node */
      protected String include = null;
      /** XPath specifying nodes to exclude. Defaults to "" (no exclusions) */
      protected String exclude = null;
  
      public void setup(SourceResolver resolver, Map objectModel,
              String source, Parameters parameters)
          throws ProcessingException, SAXException, IOException {
          super.setup(resolver, objectModel, source, parameters);
          this.include = (String)parameters.getParameter("include", "/");
          this.exclude = (String)parameters.getParameter("exclude", null);
          this.include = (String)parameters.getParameter("include-if", "/");
          this.exclude = (String)parameters.getParameter("exclude-if", null);
          }
  
  
      public void compose(ComponentManager manager) {
          super.compose(manager);
          try {
              this.processor = (XPathProcessor)this.manager.lookup(XPathProcessor.ROLE);
          } catch (Exception e) {
              getLogger().error("cannot obtain XPathProcessor", e);
          }
          try {
              this.parser = (Parser)this.manager.lookup(Parser.ROLE);
          } catch (Exception e) {
              getLogger().error("cannot obtain Parser", e);
          }
      }
  
      public void startElement(String uri, String loc, String raw, Attributes a)
          throws SAXException
      {
          getLogger().warn("################################### "+raw);
          super.startElement(uri, loc, raw, a);
      }
  
      /** Implementation of a template method declared in AbstractDOMTransformer.
       * @param doc DOM of XML received by the transformer
       * @return A pared-down DOM.
       */
      protected Document transform(Document doc) {
          getLogger().debug("Transforming with include='"+include+"', exclude='"+exclude+"'");
          Document newDoc = null;
  		try {
          	newDoc = handleIncludes(doc, this.include);
          	newDoc = handleExcludes(newDoc, this.exclude);
  		} catch (SAXException se) {
  			// Really ought to be able to propagate these to caller
  			getLogger().error("Error when transforming XML", se);
  			throw new RuntimeException("Error transforming XML. See error log for details: "+se);
  		}
          return newDoc;
      }
  
      /**
       * Construct a new DOM containing nodes matched by <code>include</code> XPath expression.
       * @param doc Original DOM
       * @param xpath XPath include expression
       * @return DOM containing nodes from <code>doc</code> matched by <code>XPath</code>
       */
      private Document handleIncludes(Document doc, String xpath) throws SAXException {
          if (xpath == null || xpath.equals("/")) {
              return doc;
          }
          Document newDoc = parser.createDocument();
          NodeList nodes = processor.selectNodeList(doc, xpath);
          for (int i=0; i<nodes.getLength(); i++) {
              Node node = (Node)nodes.item(i);
              addNode(newDoc, node);
          }
          return newDoc;
      }
  
      /**
       * Construct a new DOM excluding nodes matched by <code>exclude</code> XPath expression.
       * @param doc Original DOM
       * @param xpath XPath exclude expression
       * @return DOM containing nodes from <code>doc</code>, excluding those
       * matched by <code>XPath</code>
       */
      private Document handleExcludes(Document doc, String xpath) {
          if (xpath == null || xpath.trim().equals("")) {
              return doc;
          }
          NodeList nodes = processor.selectNodeList(doc, xpath);
          for (int i=0; i<nodes.getLength(); i++) {
              Node node = (Node)nodes.item(i);
              // Detach this node. Attr nodes need to be handled specially
              if (node.getNodeType() == Node.ATTRIBUTE_NODE) {
                  Attr attrNode = (Attr)node;
                  Element parent = attrNode.getOwnerElement();
                  parent.removeAttributeNode(attrNode);
              } else {
                  Node parent = node.getParentNode();
                  if (parent != null) {
                      parent.removeChild(node);
                  }
              }
          }
          return doc;
      }
  
      /**
       * Add a node to the Document, including all of the node's ancestor nodes.
       * Eg, if <code>node</code> is the title="Introduction" node in the
       * example, the doc would have node /manual/s1/@title='Introduction' added
       * to it.
       *
       * @fixme This method could do with some optimization. Currently, every
       * node addition results in one expensive node equality check per ancestor
       * @param doc Document to add a node to
       * @param nodeTemplate Node from another Document which we wish to
       * replicate in <code>doc</code>. This is used as a template, not actually
       * physically copied.
       */
      private void addNode(Document doc, Node nodeTemplate) {
          // Get a stack of node's ancestors (inclusive)
          Stack stack = new Stack();
          Node parent = nodeTemplate;
          while (parent != nodeTemplate.getOwnerDocument()) {
              stack.push(parent);
              parent = parent.getParentNode();
          }
          // Example stack: (top) [ /manual, /manual/s1, /manual/s1/@title ] (bottom)
  
          // Now from the earliest non-root ancestor, add cloned nodes to the
          // doc. We check if a suitable ancestor node doesn't already exist in
          // addNode()
          parent = doc;
          while (!stack.empty()) {
              Node n = (Node)stack.pop();
              if (!stack.empty()) {
                  // Shallow copy of a parent node (in example: /manual, then /manual/s1)
                  n = doc.importNode(n, false);
                  parent = findOrCreateNode(parent, n);
              } else {
                  // Deep copy of the matched node (in example: /manual/s1/@title)
                  parent.appendChild(doc.importNode(n, true));
              }
          }
      }
  
      /**
       * Add newNode as a child of parent, first checking if any equivalent node
       * to newNode already exists as a child of parent.
       *
       * @param parent Parent node of found or created node
       * @param newNode The node potentially added to parent, unless parent
       * already has an equivalent node
       * @return the appended node, or the old equivalent node if found.
       */
      private Node findOrCreateNode(Node parent, Node newNode) {
          NodeList otherChildren = parent.getChildNodes();
          for (int i=0; i<otherChildren.getLength(); i++) {
              Node child = (Node)otherChildren.item(i);
              if (nodeEquality(child, newNode)) {
                  // Found existing equivalent node
                  return child;
              }
          }
          // No existing equivalent node found; add and return newNode
          parent.appendChild(newNode);
          return newNode;
      }
  
      /**
       * Shallow-test two nodes for equality.
       * To quote from the Xerces DOM3 Node.isEqualNode() javadocs, from where
       * most of the code is filched:
       *
       * [Nodes are equal if] the following string attributes are equal:
       * <code>nodeName</code>, <code>localName</code>,
       * <code>namespaceURI</code>, <code>prefix</code>, <code>nodeValue</code>.
       * This is: they are both <code>null</code>, or they have the same length
       * and are character for character identical.
       */
      private boolean nodeEquality(Node n1, Node n2) {
          if (n1.getNodeType() != n2.getNodeType()) {
              return false;
          }
          if (n1.getNodeName() == null) {
              if (n2.getNodeName() != null) {
                  return false;
              }
          }
          else if (!n1.getNodeName().equals(n2.getNodeName())) {
              return false;
          }
  
          if (n1.getLocalName() == null) {
              if (n2.getLocalName() != null) {
                  return false;
              }
          }
          else if (!n1.getLocalName().equals(n2.getLocalName())) {
              return false;
          }
  
          if (n1.getNamespaceURI() == null) {
              if (n2.getNamespaceURI() != null) {
                  return false;
              }
          }
          else if (!n1.getNamespaceURI().equals(n2.getNamespaceURI())) {
              return false;
          }
  
          if (n1.getPrefix() == null) {
              if (n2.getPrefix() != null) {
                  return false;
              }
          }
          else if (!n1.getPrefix().equals(n2.getPrefix())) {
              return false;
          }
  
          if (n1.getNodeValue() == null) {
              if (n2.getNodeValue() != null) {
                  return false;
              }
          }
          else if (!n1.getNodeValue().equals(n2.getNodeValue())) {
              return false;
          }
          return true;
      }
  
      // Unused debugging methods
  
      private final void printNode(String msg, Node node) {
          getLogger().info(msg+" "+node.getNodeName());
      }
  
      private final void printDeepNode(String msg, Node node) {
          try {
              getLogger().info(msg+" "+XMLUtils.serializeNodeToXML(node));
          } catch (ProcessingException pe) {
              getLogger().error("Error printing node", pe);
          }
      }
  
      // Cache methods
  
      /**
       * Generate the unique key.
       * This key must be unique inside the space of this component.
       *
       * @return A hash of the include and exclude parameters, thus uniquely
       * identifying this XPathTransformer amongst it's peers.
       */
      public long generateKey() {
          return HashUtil.hash(this.include+this.exclude);
      }
  
      /**
       * Generate the validity object.
       *
       * @return An "always valid" CacheValidity object. This transformer has no
       * inputs other than the incoming SAX events.
       */
      public CacheValidity generateValidity() {
          return new NOPCacheValidity();
      }
  
      /**
       * Recycle the component.
       */
      public void recycle() {
          super.recycle();
          this.include = null;
          this.exclude = null;
          // note that we don't turf our parser and processor,
      }
  
      /**
       * dispose
       */
      public void dispose() {
          super.dispose();
          this.processor = null;
          this.parser = null;
          this.include = null;
          this.exclude = null;
      }
  }
  
  
  

Re: Source layouts (Re: cvs commit: ...IdGeneratorTransformer.java XPathTransformer.java)

Posted by Steven Noels <st...@outerthought.org>.
Jeff Turner wrote:

> The transformers developed for Forrest so far (LinkRewriter, XPath,
> IdGenerator) are all quite generic.  The most Forrest-specific,
> LinkRewriter, has already been moved to Cocoon.  For that reason I prefer
> an org.apache.cocoon.transformation package, as it is the least likely to
> change.  These package names are all exposed in the sitemap, and will be
> the subject of backwards-compat breaks if we alter them in the future.
> In fact, even altering org.apache.cocoon.transformation.XPathTransformer
> now would break custom sitemaps made since linkmaps were introduced.

OK.

</Steven>
-- 
Steven Noels                            http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
Read my weblog at            http://blogs.cocoondev.org/stevenn/
stevenn at outerthought.org                stevenn at apache.org


Source layouts (Re: cvs commit: ...IdGeneratorTransformer.java XPathTransformer.java)

Posted by Jeff Turner <je...@apache.org>.
On Sun, Jan 12, 2003 at 01:22:57PM +0100, Steven Noels wrote:
> Jeff Turner wrote:
> 
> >>Jeff, must'nt that be in some other package hierarchy?
> >>
> >>src/java/
> >>        cocoon/
> >>               components/
> >>        ant/
> >>            tasks/
> >>
> >>We could move the scratchpad code into that structure, too. Kill the 
> >>last remainder of the old directory layout.
> >
> >
> >Just to confirm: create a src/java/ parallel to src/resources/? Sounds
> >good to me..
> 
> yay!
> 
> Suggestion:
> 
> src/java/
>          org/apache/forrest/
>                             app/
>                                 component/
>                                           name
> 
> like in:
> 
> src/java/org/apache/forrest/cocoon/transformer/IdGeneratorTransformer.java

The transformers developed for Forrest so far (LinkRewriter, XPath,
IdGenerator) are all quite generic.  The most Forrest-specific,
LinkRewriter, has already been moved to Cocoon.  For that reason I prefer
an org.apache.cocoon.transformation package, as it is the least likely to
change.  These package names are all exposed in the sitemap, and will be
the subject of backwards-compat breaks if we alter them in the future.
In fact, even altering org.apache.cocoon.transformation.XPathTransformer
now would break custom sitemaps made since linkmaps were introduced.

> src/java/org/apache/forrest/ant/task/JeffsGreatFooBarTask.java

Anything below org.apache.forrest would be fine by me.


--Jeff

> ?
> 
> </Steven>
> -- 
> Steven Noels                            http://outerthought.org/
> Outerthought - Open Source, Java & XML Competence Support Center
> Read my weblog at            http://blogs.cocoondev.org/stevenn/
> stevenn at outerthought.org                stevenn at apache.org
> 

Re: cvs commit: xml-forrest/src/resources/tasks/org/apache/cocoon/transformation IdGeneratorTransformer.java XPathTransformer.java

Posted by Steven Noels <st...@outerthought.org>.
Jeff Turner wrote:

>>Jeff, must'nt that be in some other package hierarchy?
>>
>>src/java/
>>         cocoon/
>>                components/
>>         ant/
>>             tasks/
>>
>>We could move the scratchpad code into that structure, too. Kill the 
>>last remainder of the old directory layout.
> 
> 
> Just to confirm: create a src/java/ parallel to src/resources/? Sounds
> good to me..

yay!

Suggestion:

src/java/
          org/apache/forrest/
                             app/
                                 component/
                                           name

like in:

src/java/org/apache/forrest/cocoon/transformer/IdGeneratorTransformer.java
src/java/org/apache/forrest/ant/task/JeffsGreatFooBarTask.java

?

</Steven>
-- 
Steven Noels                            http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
Read my weblog at            http://blogs.cocoondev.org/stevenn/
stevenn at outerthought.org                stevenn at apache.org


Re: cvs commit: xml-forrest/src/resources/tasks/org/apache/cocoon/transformation IdGeneratorTransformer.java XPathTransformer.java

Posted by Jeff Turner <je...@apache.org>.
On Sun, Jan 12, 2003 at 01:04:08PM +0100, Steven Noels wrote:
> jefft@apache.org wrote:
> 
> >jefft       2003/01/12 03:50:34
> >
> >  Added:       src/resources/tasks/org/apache/cocoon/transformation
> >                        IdGeneratorTransformer.java XPathTransformer.java
> 
> 
> Jeff, must'nt that be in some other package hierarchy?
> 
> src/java/
>          cocoon/
>                 components/
>          ant/
>              tasks/
>
> We could move the scratchpad code into that structure, too. Kill the 
> last remainder of the old directory layout.

Just to confirm: create a src/java/ parallel to src/resources/? Sounds
good to me..

--Jeff


> </Steven>
> -- 
> Steven Noels                            http://outerthought.org/
> Outerthought - Open Source, Java & XML Competence Support Center
> Read my weblog at            http://blogs.cocoondev.org/stevenn/
> stevenn at outerthought.org                stevenn at apache.org
> 

Re: cvs commit: xml-forrest/src/resources/tasks/org/apache/cocoon/transformation IdGeneratorTransformer.java XPathTransformer.java

Posted by Steven Noels <st...@outerthought.org>.
jefft@apache.org wrote:

> jefft       2003/01/12 03:50:34
> 
>   Added:       src/resources/tasks/org/apache/cocoon/transformation
>                         IdGeneratorTransformer.java XPathTransformer.java


Jeff, must'nt that be in some other package hierarchy?

src/java/
          cocoon/
                 components/
          ant/
              tasks/

We could move the scratchpad code into that structure, too. Kill the 
last remainder of the old directory layout.

</Steven>
-- 
Steven Noels                            http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
Read my weblog at            http://blogs.cocoondev.org/stevenn/
stevenn at outerthought.org                stevenn at apache.org