You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by br...@apache.org on 2003/11/13 14:14:50 UTC
cvs commit: cocoon-2.1/src/java/org/apache/cocoon/xml SaxBuffer.java
bruno 2003/11/13 05:14:50
Added: src/java/org/apache/cocoon/xml SaxBuffer.java
Log:
initial commit
Revision Changes Path
1.1 cocoon-2.1/src/java/org/apache/cocoon/xml/SaxBuffer.java
Index: SaxBuffer.java
===================================================================
/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 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.xml;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
import org.xml.sax.Locator;
import org.xml.sax.Attributes;
import org.xml.sax.ext.LexicalHandler;
import org.apache.excalibur.xml.sax.XMLizable;
import java.util.ArrayList;
import java.util.Iterator;
/**
* A class that can record SAX events and replay them later.
*
* <p>Compared to XMLByteStreamCompiler, this class is many times faster at sending out the recorded
* SAX events since it doesn't need to convert between byte and char representations etc.
* On the other hand, its data structure is more complex then a simple byte array,
* making XMLByteStreamCompiler better in case the recorded SAX should be stored long-term.
*
* <p>Use this class if you need to frequently generate smaller amounts of SAX events,
* or replay a set of recorded start events immediately.
*
* <p>Both ContentHandler and LexicalHandler are supported, the only exception is
* that the setDocumentLocator event is not recorded.
*/
public class SaxBuffer implements ContentHandler, LexicalHandler, XMLizable {
private ArrayList saxbits = new ArrayList();
public void skippedEntity(String name) throws SAXException {
saxbits.add(new SkippedEntity(name));
}
public void setDocumentLocator(Locator locator) {
//don't record this event
}
public void ignorableWhitespace(char ch[], int start, int length) throws SAXException {
saxbits.add(new IgnorableWhitespace(ch, start, length));
}
public void processingInstruction(String target, String data) throws SAXException {
saxbits.add(new PI(target, data));
}
public void startDocument() throws SAXException {
saxbits.add(new StartDocument());
}
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {
saxbits.add(new StartElement(namespaceURI, localName, qName, atts));
}
public void endPrefixMapping(String prefix) throws SAXException {
saxbits.add(new EndPrefixMapping(prefix));
}
public void characters(char ch[], int start, int length) throws SAXException {
saxbits.add(new Characters(ch, start, length));
}
public void endElement(String namespaceURI, String localName, String qName) throws SAXException {
saxbits.add(new EndElement(namespaceURI, localName, qName));
}
public void endDocument() throws SAXException {
saxbits.add(new EndDocument());
}
public void startPrefixMapping(String prefix, String uri) throws SAXException {
saxbits.add(new StartPrefixMapping(prefix, uri));
}
public void endCDATA() throws SAXException {
saxbits.add(new EndCDATA());
}
public void comment(char ch[], int start, int length) throws SAXException {
saxbits.add(new Comment(ch, start, length));
}
public void startEntity(String name) throws SAXException {
saxbits.add(new StartEntity(name));
}
public void endDTD() throws SAXException {
saxbits.add(new EndDTD());
}
public void startDTD(String name, String publicId, String systemId) throws SAXException {
saxbits.add(new StartDTD(name, publicId, systemId));
}
public void startCDATA() throws SAXException {
saxbits.add(new StartCDATA());
}
public void endEntity(String name) throws SAXException {
saxbits.add(new EndEntity(name));
}
public void toSAX(ContentHandler contentHandler) throws SAXException {
Iterator saxbitsIt = saxbits.iterator();
while (saxbitsIt.hasNext()) {
SaxBit saxbit = (SaxBit)saxbitsIt.next();
saxbit.send(contentHandler);
}
}
interface SaxBit {
public void send(ContentHandler contentHandler) throws SAXException;
}
final class PI implements SaxBit {
private final String target;
private final String data;
public PI(String target, String data) {
this.target = target;
this.data = data;
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.processingInstruction(target, data);
}
}
final class StartElement implements SaxBit {
private final String namespaceURI;
private final String localName;
private final String qName;
private final Attributes attrs;
public StartElement(String namespaceURI, String localName, String qName, Attributes attrs) {
this.namespaceURI = namespaceURI;
this.localName = localName;
this.qName = qName;
this.attrs = attrs;
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.startElement(namespaceURI, localName, qName, attrs);
}
}
final class EndPrefixMapping implements SaxBit {
private final String prefix;
public EndPrefixMapping(String prefix) {
this.prefix = prefix;
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.endPrefixMapping(prefix);
}
}
final class Characters implements SaxBit {
private final char[] ch;
public Characters(char[] ch, int start, int length) {
// make a copy so that we don't hold references to a potentially large array we don't control
this.ch = new char[length];
System.arraycopy(ch, start, this.ch, 0, length);
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.characters(ch, 0, ch.length);
}
}
final class EndElement implements SaxBit {
private final String namespaceURI;
private final String localName;
private final String qName;
public EndElement(String namespaceURI, String localName, String qName) {
this.namespaceURI = namespaceURI;
this.localName = localName;
this.qName = qName;
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.endElement(namespaceURI, localName, qName);
}
}
final class EndDocument implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.endDocument();
}
}
final class StartPrefixMapping implements SaxBit {
private final String prefix;
private final String uri;
public StartPrefixMapping(String prefix, String uri) {
this.prefix = prefix;
this.uri = uri;
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.startPrefixMapping(prefix, uri);
}
}
final class Comment implements SaxBit {
private final char[] ch;
public Comment(char[] ch, int start, int length) {
// make a copy so that we don't hold references to a potentially large array we don't control
this.ch = new char[length];
System.arraycopy(ch, start, this.ch, 0, length);
}
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).comment(ch, 0, ch.length);
}
}
final class StartCDATA implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).startCDATA();
}
}
final class EndCDATA implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).endCDATA();
}
}
final class SkippedEntity implements SaxBit {
private final String name;
public SkippedEntity(String name) {
this.name = name;
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.skippedEntity(name);
}
}
final class IgnorableWhitespace implements SaxBit {
private final char[] ch;
public IgnorableWhitespace(char[] ch, int start, int length) {
// make a copy so that we don't hold references to a potentially large array we don't control
this.ch = new char[length];
System.arraycopy(ch, start, this.ch, 0, length);
}
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.ignorableWhitespace(ch, 0, ch.length);
}
}
final class StartDocument implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
contentHandler.startDocument();
}
}
final class StartDTD implements SaxBit {
private final String name;
private final String publicId;
private final String systemId;
public StartDTD(String name, String publicId, String systemId) {
this.name = name;
this.publicId = publicId;
this.systemId = systemId;
}
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).startDTD(name, publicId, systemId);
}
}
final class EndDTD implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).endDTD();
}
}
final class StartEntity implements SaxBit {
private final String name;
public StartEntity(String name) {
this.name = name;
}
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).startEntity(name);
}
}
final class EndEntity implements SaxBit {
private final String name;
public EndEntity(String name) {
this.name = name;
}
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
((LexicalHandler)contentHandler).endEntity(name);
}
}
}
Re: cvs commit: cocoon-2.1/src/java/org/apache/cocoon/xml
SaxBuffer.java
Posted by Bruno Dumon <br...@outerthought.org>.
On Thu, 2003-11-13 at 14:27, Vadim Gritsenko wrote:
> bruno@apache.org wrote:
>
> > * On the other hand, its data structure is more complex then a simple byte array,
> > * making XMLByteStreamCompiler better in case the recorded SAX should be stored long-term.
> >
> >
> ...
>
> > final class PI implements SaxBit {
> >
> >
>
> You may want to make those inner classes static -- this will save some
> memory.
Ah that's right, thanks for the suggestion.
--
Bruno Dumon http://outerthought.org/
Outerthought - Open Source, Java & XML Competence Support Center
bruno@outerthought.org bruno@apache.org
Re: cvs commit: cocoon-2.1/src/java/org/apache/cocoon/xml SaxBuffer.java
Posted by Vadim Gritsenko <va...@verizon.net>.
bruno@apache.org wrote:
> * On the other hand, its data structure is more complex then a simple byte array,
> * making XMLByteStreamCompiler better in case the recorded SAX should be stored long-term.
>
>
...
> final class PI implements SaxBit {
>
>
You may want to make those inner classes static -- this will save some
memory.
Vadim