| /* |
| * Copyright 1999-2004 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.cocoon.xml; |
| |
| import org.xml.sax.Attributes; |
| import org.xml.sax.Locator; |
| import org.xml.sax.SAXException; |
| |
| /** |
| * This class provides a bridge class to connect to existing content |
| * handlers and lexical handlers. |
| * |
| * @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a> |
| * @version CVS $Id: AbstractXMLPipe.java,v 1.2 2004/03/05 13:03:01 bdelacretaz Exp $ |
| */ |
| public abstract class AbstractXMLPipe |
| extends AbstractXMLProducer |
| implements XMLPipe { |
| |
| /** |
| * Receive an object for locating the origin of SAX document events. |
| * |
| * @param locator An object that can return the location of any SAX |
| * document event. |
| */ |
| public void setDocumentLocator(Locator locator) { |
| if (contentHandler != null) contentHandler.setDocumentLocator(locator); |
| } |
| |
| /** |
| * Receive notification of the beginning of a document. |
| */ |
| public void startDocument() |
| throws SAXException { |
| if (contentHandler != null) contentHandler.startDocument(); |
| } |
| |
| /** |
| * Receive notification of the end of a document. |
| */ |
| public void endDocument() |
| throws SAXException { |
| if (contentHandler != null) contentHandler.endDocument(); |
| } |
| |
| /** |
| * Begin the scope of a prefix-URI Namespace mapping. |
| * |
| * @param prefix The Namespace prefix being declared. |
| * @param uri The Namespace URI the prefix is mapped to. |
| */ |
| public void startPrefixMapping(String prefix, String uri) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.startPrefixMapping(prefix, uri); |
| } |
| |
| /** |
| * End the scope of a prefix-URI mapping. |
| * |
| * @param prefix The prefix that was being mapping. |
| */ |
| public void endPrefixMapping(String prefix) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.endPrefixMapping(prefix); |
| } |
| |
| /** |
| * Receive notification of the beginning of an element. |
| * |
| * @param uri The Namespace URI, or the empty string if the element has no |
| * Namespace URI or if Namespace |
| * processing is not being performed. |
| * @param loc The local name (without prefix), or the empty string if |
| * Namespace processing is not being performed. |
| * @param raw The raw XML 1.0 name (with prefix), or the empty string if |
| * raw names are not available. |
| * @param a The attributes attached to the element. If there are no |
| * attributes, it shall be an empty Attributes object. |
| */ |
| public void startElement(String uri, String loc, String raw, Attributes a) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.startElement(uri, loc, raw, a); |
| } |
| |
| |
| /** |
| * Receive notification of the end of an element. |
| * |
| * @param uri The Namespace URI, or the empty string if the element has no |
| * Namespace URI or if Namespace |
| * processing is not being performed. |
| * @param loc The local name (without prefix), or the empty string if |
| * Namespace processing is not being performed. |
| * @param raw The raw XML 1.0 name (with prefix), or the empty string if |
| * raw names are not available. |
| */ |
| public void endElement(String uri, String loc, String raw) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.endElement(uri, loc, raw); |
| } |
| |
| /** |
| * Receive notification of character data. |
| * |
| * @param c The characters from the XML document. |
| * @param start The start position in the array. |
| * @param len The number of characters to read from the array. |
| */ |
| public void characters(char c[], int start, int len) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.characters(c, start, len); |
| } |
| |
| /** |
| * Receive notification of ignorable whitespace in element content. |
| * |
| * @param c The characters from the XML document. |
| * @param start The start position in the array. |
| * @param len The number of characters to read from the array. |
| */ |
| public void ignorableWhitespace(char c[], int start, int len) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.ignorableWhitespace(c, start, len); |
| } |
| |
| /** |
| * Receive notification of a processing instruction. |
| * |
| * @param target The processing instruction target. |
| * @param data The processing instruction data, or null if none was |
| * supplied. |
| */ |
| public void processingInstruction(String target, String data) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.processingInstruction(target, data); |
| } |
| |
| /** |
| * Receive notification of a skipped entity. |
| * |
| * @param name The name of the skipped entity. If it is a parameter |
| * entity, the name will begin with '%'. |
| */ |
| public void skippedEntity(String name) |
| throws SAXException { |
| if (contentHandler != null) contentHandler.skippedEntity(name); |
| } |
| |
| /** |
| * Report the start of DTD declarations, if any. |
| * |
| * @param name The document type name. |
| * @param publicId The declared public identifier for the external DTD |
| * subset, or null if none was declared. |
| * @param systemId The declared system identifier for the external DTD |
| * subset, or null if none was declared. |
| */ |
| public void startDTD(String name, String publicId, String systemId) |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.startDTD(name, publicId, systemId); |
| } |
| |
| /** |
| * Report the end of DTD declarations. |
| */ |
| public void endDTD() |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.endDTD(); |
| } |
| |
| /** |
| * Report the beginning of an entity. |
| * |
| * @param name The name of the entity. If it is a parameter entity, the |
| * name will begin with '%'. |
| */ |
| public void startEntity(String name) |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.startEntity(name); |
| } |
| |
| /** |
| * Report the end of an entity. |
| * |
| * @param name The name of the entity that is ending. |
| */ |
| public void endEntity(String name) |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.endEntity(name); |
| } |
| |
| /** |
| * Report the start of a CDATA section. |
| */ |
| public void startCDATA() |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.startCDATA(); |
| } |
| |
| /** |
| * Report the end of a CDATA section. |
| */ |
| public void endCDATA() |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.endCDATA(); |
| } |
| |
| /** |
| * Report an XML comment anywhere in the document. |
| * |
| * @param ch An array holding the characters in the comment. |
| * @param start The starting position in the array. |
| * @param len The number of characters to use from the array. |
| */ |
| public void comment(char ch[], int start, int len) |
| throws SAXException { |
| if (lexicalHandler != null) lexicalHandler.comment(ch, start, len); |
| } |
| } |