/* ============================================================================ 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 . For more information on the Apache Software Foundation, please see . */ package org.apache.cocoon.transformation; import org.apache.avalon.framework.activity.Disposable; import org.apache.avalon.framework.component.ComponentManager; import org.apache.avalon.framework.component.Composable; import org.apache.avalon.framework.parameters.Parameters; import org.apache.avalon.excalibur.pool.Recyclable; import org.apache.cocoon.ProcessingException; import org.apache.cocoon.environment.SourceResolver; import org.apache.cocoon.xml.dom.DOMBuilder; import org.apache.cocoon.xml.dom.DOMStreamer; import org.w3c.dom.Document; import org.xml.sax.SAXException; import org.xml.sax.Locator; import org.xml.sax.Attributes; import java.io.IOException; import java.util.Map; /** * An Abstract DOM Transformer, for use when a transformer needs a DOM-based * view of the document. * Subclass this interface and implement transform(Document doc). * If you need a ComponentManager there is an instance variable * manager for use. * * @author Ross Burton * @author Bruce G. Robertson * @author Vadim Gritsenko * @version CVS $Id: AbstractDOMTransformer.java,v 1.5 2002/02/22 07:03:56 cziegeler Exp $ */ public abstract class AbstractDOMTransformer extends AbstractTransformer implements Transformer, DOMBuilder.Listener, Composable, Disposable, Recyclable { /** * The SAX entity resolver */ protected SourceResolver resolver; /** * The request object model */ protected Map objectModel; /** * The URI requested */ protected String source; /** * Parameters in the sitemap */ protected Parameters parameters; /** * A ComponentManager which is available for use. */ protected ComponentManager manager; /** * The DOMBuilder used to build DOM tree out of *incoming SAX events. */ protected DOMBuilder builder; public AbstractDOMTransformer() { super(); this.builder = new DOMBuilder(this); } /** * Set the component manager. */ public void compose(ComponentManager manager) { this.manager = manager; } /** * Set the SourceResolver, objectModel Map, * the source and sitemap Parameters used to process the request. * * If you wish to process the parameters, override this method, call * super() and then add your code. */ public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) throws ProcessingException, SAXException, IOException { this.resolver = resolver; this.objectModel = objectModel; this.source = src; this.parameters = par; } /** * Recycle the component. */ public void recycle() { this.resolver = null; this.source = null; this.objectModel = null; this.parameters = null; this.builder.recycle(); } /** * dispose */ public void dispose() { this.builder = null; this.manager = null; this.builder = null; } /** * This method is called when the Document is finished. * @param doc The DOM Document object representing this SAX stream * @see org.apache.cocoon.xml.dom.DOMBuilder.Listener */ public void notify(Document doc) throws SAXException { // Call the user's transform method Document newdoc = transform(doc); // Now we stream the resulting DOM tree down the pipe DOMStreamer s = new DOMStreamer(contentHandler, lexicalHandler); s.stream(newdoc); } /** * Transform the specified DOM, returning a new DOM to stream down the pipeline. * @param doc The DOM Document representing the SAX stream * @returns A DOM Document to stream down the pipeline */ protected abstract Document transform(Document doc); // // SAX Methods. Send incoming SAX events to the DOMBuilder. // public void setDocumentLocator(Locator locator) { builder.setDocumentLocator(locator); } public void startDocument() throws SAXException { builder.startDocument(); } public void endDocument() throws SAXException { builder.endDocument(); } public void startPrefixMapping(String prefix, String uri) throws SAXException { builder.startPrefixMapping(prefix, uri); } public void endPrefixMapping(String prefix) throws SAXException { builder.endPrefixMapping(prefix); } public void startElement(String uri, String loc, String raw, Attributes a) throws SAXException { builder.startElement(uri, loc, raw, a); } public void endElement(String uri, String loc, String raw) throws SAXException { builder.endElement(uri, loc, raw); } public void characters(char c[], int start, int len) throws SAXException { builder.characters(c, start, len); } public void ignorableWhitespace(char c[], int start, int len) throws SAXException { builder.ignorableWhitespace(c, start, len); } public void processingInstruction(String target, String data) throws SAXException { builder.processingInstruction(target, data); } public void skippedEntity(String name) throws SAXException { builder.skippedEntity(name); } public void startDTD(String name, String publicId, String systemId) throws SAXException { builder.startDTD(name, publicId, systemId); } public void endDTD() throws SAXException { builder.endDTD(); } public void startEntity(String name) throws SAXException { builder.startEntity(name); } public void endEntity(String name) throws SAXException { builder.endEntity(name); } public void startCDATA() throws SAXException { builder.startCDATA(); } public void endCDATA() throws SAXException { builder.endCDATA(); } public void comment(char ch[], int start, int len) throws SAXException { builder.comment(ch, start, len); } }