SAXEventRecorder

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> dom4j >> [ io overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.dom4j.io.SAXEventRecorder

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dom4j.io
Class SAXEventRecorder

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.dom4j.io.SAXEventRecorder

All Implemented Interfaces:: org.xml.sax.ContentHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, java.io.Externalizable, org.xml.sax.ext.LexicalHandler, java.io.Serializable

public class SAXEventRecorder
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.LexicalHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.DTDHandler, java.io.Externalizable

Records SAX events such that they may be "replayed" at a later time. Provides an alternative serialization approach when externalizing a DOM4J document. Rather than serializing a document as text and re-parsing, the sax events may be serialized instead.

Example usage:

 
  
  
         SAXEventRecorder recorder = new SAXEventRecorder();
         SAXWriter saxWriter = new SAXWriter(recorder, recorder);
         saxWriter.write(document);
         out.writeObject(recorder);
         ...
         SAXEventRecorder recorder = (SAXEventRecorder)in.readObject();
         SAXContentHandler saxContentHandler = new SAXContentHandler();
         recorder.replay(saxContentHandler);
         Document document = saxContentHandler.getDocument();

Nested Class Summary

(package private) static class SAXEventRecorder.SAXEvent


Field Summary

private static java.lang.String EMPTY_STRING


private java.util.List events


private static byte NULL


private static byte OBJECT


private java.util.Map prefixMappings


static long serialVersionUID


private static byte STRING


private static java.lang.String XMLNS


Constructor Summary

SAXEventRecorder()


Method Summary

void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value)
          Report an attribute type declaration.

void characters(char[] ch, int start, int end)
          Receive notification of character data inside an element.

void comment(char[] ch, int start, int end)
          Report an XML comment anywhere in the document.

void elementDecl(java.lang.String name, java.lang.String model)
          Report an element type declaration.

void endCDATA()
          Report the end of a CDATA section.

void endDocument()
          Receive notification of the end of the document.

void endDTD()
          Report the end of DTD declarations.

void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
          Receive notification of the end of an element.

void endEntity(java.lang.String name)
          Report the end of an entity.

void endPrefixMapping(java.lang.String prefix)
          Receive notification of the end of a Namespace mapping.

void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String sysId)
          Report a parsed external entity declaration.

void internalEntityDecl(java.lang.String name, java.lang.String value)
          Report an internal entity declaration.

void processingInstruction(java.lang.String target, java.lang.String data)
          Receive notification of a processing instruction.

void readExternal(java.io.ObjectInput in)
          This method restores an object's state by reading in the instance data for the object from the passed in stream.

void replay(org.xml.sax.ContentHandler handler)


void startCDATA()
          Report the start of a CDATA section.

void startDocument()
          Receive notification of the beginning of the document.

void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Report the start of DTD declarations, if any.

void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qualifiedName, org.xml.sax.Attributes attributes)
          Receive notification of the start of an element.

void startEntity(java.lang.String name)
          Report the beginning of some internal and external XML entities.

void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
          Receive notification of the start of a Namespace mapping.

void writeExternal(java.io.ObjectOutput out)
          This method is responsible for writing the instance data of an object to the passed in stream.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

error, fatalError, ignorableWhitespace, notationDecl, resolveEntity, setDocumentLocator, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.DTDHandler

notationDecl, unparsedEntityDecl

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:: Constant Field Values

STRING

private static final byte STRING

See Also:: Constant Field Values

OBJECT

private static final byte OBJECT

See Also:: Constant Field Values

NULL

private static final byte NULL

See Also:: Constant Field Values

events

private java.util.List events

prefixMappings

private java.util.Map prefixMappings

XMLNS

private static final java.lang.String XMLNS

See Also:: Constant Field Values

EMPTY_STRING

private static final java.lang.String EMPTY_STRING

See Also:: Constant Field Values

Constructor Detail

SAXEventRecorder

public SAXEventRecorder()

Method Detail