net.axyana.qizxopen.dm
Class XMLEventReceiverBase

java.lang.Object
  net.axyana.qizxopen.dm.XMLEventReceiverBase

All Implemented Interfaces:

XMLEventReceiver

Direct Known Subclasses:

EventDrivenBuilder, EventDrivenBuilder, SAXEventReceiver, XMLSerializer

public abstract class XMLEventReceiverBase

extends java.lang.Object

implements XMLEventReceiver

An abstract receiver of SAX-like events.

Manages namespaces. Used as a base for serialization and SAX output.

Constructor Summary

XMLEventReceiverBase()

Method Summary

void	abort() Signals an error in the event flow.
void	definePrefixHints(NSPrefixMapping prefixes) Optional: defines a preferred prefix/namespace mapping for serialization.
void	evAtom(java.lang.Object value) A special atom with any value (serializable).
void	evAttribute(QName name, java.lang.String value) Adds an attribute on the current element.
void	evDocumentEnd() Ends a document.
void	evDocumentStart() Starts a document.
void	evDTD(java.lang.String name, java.lang.String publicID, java.lang.String systemID) DTD definition.
void	evElementEnd(QName name) Ends an element.
void	evElementStart(QName name) Starts an element.
void	evNamespace(java.lang.String prefix, java.lang.String uri) Adds a namespace node on the current element.
boolean	maxVolumeReached()
void	reset() Resets the state prior to use startDocument() or startElement().
java.lang.String	resolvePrefix(java.lang.String prefix) Resolves a prefix to an URI in the context of the current node.
void	setMaxVolume(int volume)
void	setTrace(boolean value)
void	terminate() Terminates a document or simple subtree.
void	traverse(FONIDocument dm, int nodeId) Convenience method: traverses and generates a FONI document using this receiver.
void	traverse(Node node, boolean inScopeNS) Traverse and generate a subtree.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.axyana.qizxopen.dm.XMLEventReceiver

evAtomText, evComment, evPI, evText

Constructor Detail

XMLEventReceiverBase

public XMLEventReceiverBase()

Method Detail

definePrefixHints

public void definePrefixHints(NSPrefixMapping prefixes)

Description copied from interface: XMLEventReceiver

Optional: defines a preferred prefix/namespace mapping for serialization. This table is used when no mapping is in scope in the current context.

Specified by:

definePrefixHints in interface XMLEventReceiver

setTrace

public void setTrace(boolean value)

setMaxVolume

public void setMaxVolume(int volume)

maxVolumeReached

public boolean maxVolumeReached()

reset

public void reset()

Description copied from interface: XMLEventReceiver

Resets the state prior to use startDocument() or startElement().

Specified by:

reset in interface XMLEventReceiver

terminate

public void terminate()
               throws DataModelException

Description copied from interface: XMLEventReceiver

Terminates a document or simple subtree. May perform consistency checks.

Specified by:

terminate in interface XMLEventReceiver

Throws:

DataModelException

abort

public void abort()
           throws DataModelException

Description copied from interface: XMLEventReceiver

Signals an error in the event flow.

Specified by:

abort in interface XMLEventReceiver

Throws:

DataModelException

evDocumentStart

public void evDocumentStart()
                     throws DataModelException

Description copied from interface: XMLEventReceiver

Starts a document.

It is not called in the case only a fragment is generated.

Specified by:

evDocumentStart in interface XMLEventReceiver

Throws:

DataModelException

evDocumentEnd

public void evDocumentEnd()
                   throws DataModelException

Description copied from interface: XMLEventReceiver

Ends a document. Must be balanced by a matching startDocument().

Specified by:

evDocumentEnd in interface XMLEventReceiver

Throws:

DataModelException

evElementStart

public void evElementStart(QName name)
                    throws DataModelException

Description copied from interface: XMLEventReceiver

Starts an element. Must be balanced by a matching endElement().

Specified by:

evElementStart in interface XMLEventReceiver

Throws:

DataModelException

evNamespace

public void evNamespace(java.lang.String prefix,
                        java.lang.String uri)
                 throws DataModelException

Description copied from interface: XMLEventReceiver

Adds a namespace node on the current element. Must follow startElement and precede any child. May be interleaved with attribute().

Specified by:

evNamespace in interface XMLEventReceiver

Throws:

DataModelException

evAttribute

public void evAttribute(QName name,
                        java.lang.String value)
                 throws DataModelException

Description copied from interface: XMLEventReceiver

Adds an attribute on the current element. Must follow startElement and precede any child. May be interleaved with namespace().

Specified by:

evAttribute in interface XMLEventReceiver

Throws:

DataModelException

evElementEnd

public void evElementEnd(QName name)
                  throws DataModelException

Description copied from interface: XMLEventReceiver

Ends an element. Discards prefix/namespace mappings possibly defined by the element.

Specified by:

evElementEnd in interface XMLEventReceiver

Throws:

DataModelException

resolvePrefix

public java.lang.String resolvePrefix(java.lang.String prefix)

Description copied from interface: XMLEventReceiver

Resolves a prefix to an URI in the context of the current node.

Specified by:

resolvePrefix in interface XMLEventReceiver

Returns:

null if the prefix cannot be resolved.

evDTD

public void evDTD(java.lang.String name,
                  java.lang.String publicID,
                  java.lang.String systemID)
           throws DataModelException

Description copied from interface: XMLEventReceiver

DTD definition.

Specified by:

evDTD in interface XMLEventReceiver

Throws:

DataModelException

evAtom

public void evAtom(java.lang.Object value)
            throws DataModelException

Description copied from interface: XMLEventReceiver

A special atom with any value (serializable).

Specified by:

evAtom in interface XMLEventReceiver

Throws:

DataModelException

traverse

public void traverse(Node node,
                     boolean inScopeNS)
              throws DataModelException

Traverse and generate a subtree.

Specified by:

traverse in interface XMLEventReceiver

Parameters:

inScopeNS - if true, copy all in-scope namespace nodes (not only those defined on the node itself). A false value is generally used.

Throws:

DataModelException

traverse

public void traverse(FONIDocument dm,
                     int nodeId)
              throws DataModelException

Description copied from interface: XMLEventReceiver

Convenience method: traverses and generates a FONI document using this receiver.

Specified by:

traverse in interface XMLEventReceiver

Throws:

DataModelException