You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by vg...@apache.org on 2003/12/09 22:37:35 UTC
cvs commit: cocoon-2.2/src/java/org/apache/cocoon/xml ParamSaxBuffer.java SaxBuffer.java
vgritsenko 2003/12/09 13:37:35
Modified: src/java/org/apache/cocoon/xml SaxBuffer.java
Added: src/java/org/apache/cocoon/xml ParamSaxBuffer.java
Log:
sync saxbuffer enhancements: add helper methods, sort inner classes,
add ParamSaxBuffer.
Revision Changes Path
1.2 +164 -97 cocoon-2.2/src/java/org/apache/cocoon/xml/SaxBuffer.java
Index: SaxBuffer.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/xml/SaxBuffer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SaxBuffer.java 13 Nov 2003 15:21:11 -0000 1.1
+++ SaxBuffer.java 9 Dec 2003 21:37:35 -0000 1.2
@@ -56,9 +56,11 @@
import org.xml.sax.Attributes;
import org.xml.sax.ext.LexicalHandler;
import org.apache.excalibur.xml.sax.XMLizable;
+import org.apache.avalon.excalibur.pool.Recyclable;
import java.util.ArrayList;
import java.util.Iterator;
+import java.util.List;
/**
* A class that can record SAX events and replay them later.
@@ -73,16 +75,37 @@
*
* <p>Both ContentHandler and LexicalHandler are supported, the only exception is
* that the setDocumentLocator event is not recorded.
+ *
+ * @author <a href="mailto:dev@cocoon.apache.org">Apache Cocoon Team</a>
+ * @version CVS $Id$
*/
-public class SaxBuffer implements ContentHandler, LexicalHandler, XMLizable {
- private ArrayList saxbits = new ArrayList();
+public class SaxBuffer implements ContentHandler, LexicalHandler, XMLizable, Recyclable {
+
+ /**
+ * Stores list of {@link SaxBit} objects.
+ */
+ private List saxbits = new ArrayList();
+
+ /**
+ * Creates empty SaxBuffer
+ */
+ public SaxBuffer() {
+ }
+
+ /**
+ * Creates copy of another SaxBuffer
+ */
+ public SaxBuffer(SaxBuffer saxBuffer) {
+ this.saxbits.addAll(saxBuffer.saxbits);
+ }
+
public void skippedEntity(String name) throws SAXException {
saxbits.add(new SkippedEntity(name));
}
public void setDocumentLocator(Locator locator) {
- //don't record this event
+ // don't record this event
}
public void ignorableWhitespace(char ch[], int start, int length) throws SAXException {
@@ -149,18 +172,70 @@
saxbits.add(new EndEntity(name));
}
+
+ /**
+ * Adds a SaxBit to the bits list
+ */
+ protected final void addBit(SaxBit bit) {
+ saxbits.add(bit);
+ }
+
+ /**
+ * Iterates through the bits list
+ */
+ protected final Iterator bits() {
+ return saxbits.iterator();
+ }
+
+ public boolean isEmpty() {
+ return saxbits.isEmpty();
+ }
+
public void toSAX(ContentHandler contentHandler) throws SAXException {
- Iterator saxbitsIt = saxbits.iterator();
- while (saxbitsIt.hasNext()) {
- SaxBit saxbit = (SaxBit)saxbitsIt.next();
+ for (Iterator i = saxbits.iterator(); i.hasNext();) {
+ SaxBit saxbit = (SaxBit)i.next();
saxbit.send(contentHandler);
}
}
+ /*
+ * NOTE: Used in i18n XML bundle implementation
+ */
+ public String toString() {
+ StringBuffer value = new StringBuffer();
+ for (Iterator i = saxbits.iterator(); i.hasNext();) {
+ SaxBit saxbit = (SaxBit)i.next();
+ if (saxbit instanceof Characters) {
+ ((Characters)saxbit).toString(value);
+ }
+ }
+
+ return value.toString();
+ }
+
+ public void recycle() {
+ saxbits.clear();
+ }
+
+ /**
+ * SaxBit is a representation of the SAX event. Every SaxBit is immutable object.
+ */
interface SaxBit {
public void send(ContentHandler contentHandler) throws SAXException;
}
+ final static class StartDocument implements SaxBit {
+ public void send(ContentHandler contentHandler) throws SAXException {
+ contentHandler.startDocument();
+ }
+ }
+
+ final static class EndDocument implements SaxBit {
+ public void send(ContentHandler contentHandler) throws SAXException {
+ contentHandler.endDocument();
+ }
+ }
+
final static class PI implements SaxBit {
private final String target;
private final String data;
@@ -175,69 +250,65 @@
}
}
- final static class StartElement implements SaxBit {
- private final String namespaceURI;
- private final String localName;
- private final String qName;
- private final Attributes attrs;
+ final static class StartDTD implements SaxBit {
+ private final String name;
+ private final String publicId;
+ private final String systemId;
- public StartElement(String namespaceURI, String localName, String qName, Attributes attrs) {
- this.namespaceURI = namespaceURI;
- this.localName = localName;
- this.qName = qName;
- this.attrs = attrs;
+ public StartDTD(String name, String publicId, String systemId) {
+ this.name = name;
+ this.publicId = publicId;
+ this.systemId = systemId;
}
public void send(ContentHandler contentHandler) throws SAXException {
- contentHandler.startElement(namespaceURI, localName, qName, attrs);
+ if (contentHandler instanceof LexicalHandler)
+ ((LexicalHandler)contentHandler).startDTD(name, publicId, systemId);
}
}
- final static class EndPrefixMapping implements SaxBit {
- private final String prefix;
-
- public EndPrefixMapping(String prefix) {
- this.prefix = prefix;
- }
-
+ final static class EndDTD implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
- contentHandler.endPrefixMapping(prefix);
+ if (contentHandler instanceof LexicalHandler)
+ ((LexicalHandler)contentHandler).endDTD();
}
}
- final static class Characters implements SaxBit {
- private final char[] ch;
+ final static class StartEntity implements SaxBit {
+ private final String name;
- 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 StartEntity(String name) {
+ this.name = name;
}
public void send(ContentHandler contentHandler) throws SAXException {
- contentHandler.characters(ch, 0, ch.length);
+ if (contentHandler instanceof LexicalHandler)
+ ((LexicalHandler)contentHandler).startEntity(name);
}
}
- final static class EndElement implements SaxBit {
- private final String namespaceURI;
- private final String localName;
- private final String qName;
+ final static class EndEntity implements SaxBit {
+ private final String name;
- public EndElement(String namespaceURI, String localName, String qName) {
- this.namespaceURI = namespaceURI;
- this.localName = localName;
- this.qName = qName;
+ public EndEntity(String name) {
+ this.name = name;
}
public void send(ContentHandler contentHandler) throws SAXException {
- contentHandler.endElement(namespaceURI, localName, qName);
+ if (contentHandler instanceof LexicalHandler)
+ ((LexicalHandler)contentHandler).endEntity(name);
}
}
- final static class EndDocument implements SaxBit {
+ final static class SkippedEntity implements SaxBit {
+ private final String name;
+
+ public SkippedEntity(String name) {
+ this.name = name;
+ }
+
public void send(ContentHandler contentHandler) throws SAXException {
- contentHandler.endDocument();
+ contentHandler.skippedEntity(name);
}
}
@@ -255,114 +326,110 @@
}
}
- final static class Comment implements SaxBit {
- private final char[] ch;
+ final static class EndPrefixMapping implements SaxBit {
+ private final String prefix;
- 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 EndPrefixMapping(String prefix) {
+ this.prefix = prefix;
}
public void send(ContentHandler contentHandler) throws SAXException {
- if (contentHandler instanceof LexicalHandler)
- ((LexicalHandler)contentHandler).comment(ch, 0, ch.length);
+ contentHandler.endPrefixMapping(prefix);
}
}
- final static class StartCDATA implements SaxBit {
- public void send(ContentHandler contentHandler) throws SAXException {
- if (contentHandler instanceof LexicalHandler)
- ((LexicalHandler)contentHandler).startCDATA();
+ final static 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 = new org.xml.sax.helpers.AttributesImpl(attrs);
}
- }
- final static class EndCDATA implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
- if (contentHandler instanceof LexicalHandler)
- ((LexicalHandler)contentHandler).endCDATA();
+ contentHandler.startElement(namespaceURI, localName, qName, attrs);
}
}
- final static class SkippedEntity implements SaxBit {
- private final String name;
+ final static class EndElement implements SaxBit {
+ private final String namespaceURI;
+ private final String localName;
+ private final String qName;
- public SkippedEntity(String name) {
- this.name = name;
+ 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.skippedEntity(name);
+ contentHandler.endElement(namespaceURI, localName, qName);
}
}
- final static class IgnorableWhitespace implements SaxBit {
+ final static class Characters implements SaxBit {
private final char[] ch;
- public IgnorableWhitespace(char[] ch, int start, int length) {
+ 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.ignorableWhitespace(ch, 0, ch.length);
+ contentHandler.characters(ch, 0, ch.length);
}
- }
-
- final static class StartDocument implements SaxBit {
- public void send(ContentHandler contentHandler) throws SAXException {
- contentHandler.startDocument();
+
+ public void toString(StringBuffer value) {
+ value.append(ch);
}
}
- final static class StartDTD implements SaxBit {
- private final String name;
- private final String publicId;
- private final String systemId;
+ final static class Comment implements SaxBit {
+ private final char[] ch;
- public StartDTD(String name, String publicId, String systemId) {
- this.name = name;
- this.publicId = publicId;
- this.systemId = systemId;
+ 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).startDTD(name, publicId, systemId);
+ ((LexicalHandler)contentHandler).comment(ch, 0, ch.length);
}
}
- final static class EndDTD implements SaxBit {
+ final static class StartCDATA implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
- ((LexicalHandler)contentHandler).endDTD();
+ ((LexicalHandler)contentHandler).startCDATA();
}
}
- final static class StartEntity implements SaxBit {
- private final String name;
-
- public StartEntity(String name) {
- this.name = name;
- }
-
+ final static class EndCDATA implements SaxBit {
public void send(ContentHandler contentHandler) throws SAXException {
if (contentHandler instanceof LexicalHandler)
- ((LexicalHandler)contentHandler).startEntity(name);
+ ((LexicalHandler)contentHandler).endCDATA();
}
}
- final static class EndEntity implements SaxBit {
- private final String name;
+ final static class IgnorableWhitespace implements SaxBit {
+ private final char[] ch;
- public EndEntity(String name) {
- this.name = name;
+ 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 {
- if (contentHandler instanceof LexicalHandler)
- ((LexicalHandler)contentHandler).endEntity(name);
+ contentHandler.ignorableWhitespace(ch, 0, ch.length);
}
}
}
1.1 cocoon-2.2/src/java/org/apache/cocoon/xml/ParamSaxBuffer.java
Index: ParamSaxBuffer.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 java.util.Iterator;
import java.util.Map;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
/**
* Modification of the SAX buffer with parameterization capabilities.
*
* Any <code>{name}</code> expression inside of the character events can be
* replaced by the content of another SaxBuffer if it is present in the map
* passed to the {@link toSAX(ContentHandler, Map)} method.
*
* @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
* @version CVS $Id: ParamSaxBuffer.java,v 1.1 2003/12/09 21:37:35 vgritsenko Exp $
*/
public class ParamSaxBuffer extends SaxBuffer {
/**
* Creates empty SaxBuffer
*/
public ParamSaxBuffer() {
}
/**
* Creates copy of another SaxBuffer
*/
public ParamSaxBuffer(SaxBuffer saxBuffer) {
super(saxBuffer);
}
/**
* Parses text and extracts <code>{name}</code> parameters for later
* substitution.
*/
public void characters(char ch[], int start, int length) throws SAXException {
int end = start + length;
for (int i = start; i < end; i++) {
if (ch[i] == '{') {
// Send any collected characters so far
if (i > start) {
addBit(new Characters(ch, start, i - start));
}
// Find closing brace, and construct parameter name
StringBuffer name = new StringBuffer();
int j = i + 1;
for (; j < end; j++) {
if (ch[j] == '}') {
break;
}
name.append(ch[j]);
}
if (j == length) {
throw new SAXException("Unclosed '}'");
}
addBit(new Parameter(name.toString()));
// Continue processing
i = j;
start = j + 1;
continue;
}
}
// Send any tailing characters
if (start < end) {
addBit(new Characters(ch, start, end - start));
}
}
/**
* @param parameters map containing SaxBuffers
*/
public void toSAX(ContentHandler contentHandler, Map parameters) throws SAXException {
for (Iterator i = bits(); i.hasNext();) {
SaxBit saxbit = (SaxBit)i.next();
if (saxbit instanceof Parameter) {
((Parameter)saxbit).send(contentHandler, parameters);
} else {
saxbit.send(contentHandler);
}
}
}
final static class Parameter implements SaxBit {
private final String name;
public Parameter(String name) {
this.name = name;
}
public void send(ContentHandler contentHandler) throws SAXException {
}
public void send(ContentHandler contentHandler, Map parameters) throws SAXException {
SaxBuffer value = (SaxBuffer)parameters.get(name);
if (value != null) {
value.toSAX(contentHandler);
}
}
}
}