net.sf.saxon.event
Class ContentHandlerProxy

java.lang.Object
  |
  +--net.sf.saxon.event.Emitter
        |
        +--net.sf.saxon.event.ContentHandlerProxy
All Implemented Interfaces:
org.xml.sax.Locator, Receiver, javax.xml.transform.Result

public class ContentHandlerProxy
extends Emitter
implements org.xml.sax.Locator

A ContentHandlerProxy is an Emitter that filters data before passing it to an underlying SAX2 ContentHandler. Relevant events (notably comments) can also be fed to a LexicalHandler. Note that in general the output passed to an Emitter corresponds to an External General Parsed Entity. A SAX2 ContentHandler only expects to deal with well-formed XML documents, so we only pass it the contents of the first element encountered.


Field Summary
protected  org.xml.sax.ContentHandler handler
           
protected  org.xml.sax.ext.LexicalHandler lexicalHandler
           
protected  org.xml.sax.Locator locator
           
 
Fields inherited from class net.sf.saxon.event.Emitter
characterSet, config, namePool, outputProperties, outputStream, streamResult, systemId, writer
 
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
 
Constructor Summary
ContentHandlerProxy()
           
 
Method Summary
 void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int properties)
          Notify an attribute.
 void characters(java.lang.CharSequence chars, int properties)
          Character data
 void comment(java.lang.CharSequence chars, int properties)
          Output a comment.
 void endDocument()
          End of document
 void endElement()
          End of element
 int getColumnNumber()
           
 int getLineNumber()
           
 java.lang.String getPublicId()
           
 boolean isRequireWellFormed()
          Determine whether the content handler can handle a stream of events that is merely well-balanced, or whether it can only handle a well-formed sequence.
 boolean isUndeclareNamespaces()
          Determine whether namespace undeclaration events (for a non-null prefix) should be notified.
 void namespace(int namespaceCode, int properties)
          Notify a namespace.
protected  void notifyNotWellFormed()
          The following function is called when it is found that the output is not a well-formed document.
 void processingInstruction(java.lang.String target, java.lang.CharSequence data, int properties)
          Processing Instruction
 void setDocumentLocator(org.xml.sax.Locator locator)
          Set Document Locator
 void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler)
          Set the Lexical Handler to be used.
 void setOutputProperties(java.util.Properties details)
          Set the output details.
 void setRequireWellFormed(boolean wellFormed)
          Indicate whether the content handler can handle a stream of events that is merely well-balanced, or whether it can only handle a well-formed sequence.
 void setUndeclareNamespaces(boolean undeclareNamespaces)
          Determine whether namespace undeclaration events (for a non-null prefix) should be notified.
 void setUnderlyingContentHandler(org.xml.sax.ContentHandler handler)
          Set the underlying content handler.
 void startContent()
          Notify the start of the content, that is, the completion of all attributes and namespaces.
 void startDocument()
          Start of document
 void startElement(int nameCode, int typeCode, int properties)
          Notify the start of an element
 
Methods inherited from class net.sf.saxon.event.Emitter
getConfiguration, getOutputProperties, getOutputStream, getSystemId, getWriter, makeEmitter, makeWriter, setConfiguration, setOutputStream, setStreamResult, setSystemId, setUnparsedEntity, setWriter, usesWriter
 
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.Locator
getSystemId
 

Field Detail

handler

protected org.xml.sax.ContentHandler handler

lexicalHandler

protected org.xml.sax.ext.LexicalHandler lexicalHandler

locator

protected org.xml.sax.Locator locator
Constructor Detail

ContentHandlerProxy

public ContentHandlerProxy()
Method Detail

setUnderlyingContentHandler

public void setUnderlyingContentHandler(org.xml.sax.ContentHandler handler)
Set the underlying content handler. This call is mandatory before using the Emitter.


setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler)
Set the Lexical Handler to be used. If called, this must be called AFTER setUnderlyingContentHandler()


setOutputProperties

public void setOutputProperties(java.util.Properties details)
                         throws javax.xml.transform.TransformerException
Set the output details.

Overrides:
setOutputProperties in class Emitter
javax.xml.transform.TransformerException

isRequireWellFormed

public boolean isRequireWellFormed()
Determine whether the content handler can handle a stream of events that is merely well-balanced, or whether it can only handle a well-formed sequence.


setRequireWellFormed

public void setRequireWellFormed(boolean wellFormed)
Indicate whether the content handler can handle a stream of events that is merely well-balanced, or whether it can only handle a well-formed sequence.


isUndeclareNamespaces

public boolean isUndeclareNamespaces()
Determine whether namespace undeclaration events (for a non-null prefix) should be notified. The default is no, because some ContentHandlers (e.g. JDOM) can't cope with them.

Returns:
true if namespace undeclarations (xmlns:p="") are output

setUndeclareNamespaces

public void setUndeclareNamespaces(boolean undeclareNamespaces)
Determine whether namespace undeclaration events (for a non-null prefix) should be notified. The default is no, because some ContentHandlers (e.g. JDOM) can't cope with them.

Parameters:
undeclareNamespaces - true if namespace undeclarations (xmlns:p="") are to be output

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)
Set Document Locator

Specified by:
setDocumentLocator in interface Receiver
Overrides:
setDocumentLocator in class Emitter

startDocument

public void startDocument()
                   throws javax.xml.transform.TransformerException
Start of document

Specified by:
startDocument in interface Receiver
javax.xml.transform.TransformerException

endDocument

public void endDocument()
                 throws javax.xml.transform.TransformerException
End of document

Specified by:
endDocument in interface Receiver
javax.xml.transform.TransformerException

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws javax.xml.transform.TransformerException
Notify the start of an element

Specified by:
startElement in interface Receiver
Parameters:
nameCode - integer code identifying the name of the element within the name pool.
typeCode - integer code identifying the element's type within the name pool.
javax.xml.transform.TransformerException

namespace

public void namespace(int namespaceCode,
                      int properties)
               throws javax.xml.transform.TransformerException
Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element.

Specified by:
namespace in interface Receiver
Parameters:
namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.
javax.xml.transform.TransformerException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      java.lang.CharSequence value,
                      int properties)
               throws javax.xml.transform.TransformerException
Notify an attribute. Attributes are notified after the startElement event, and before any children.

Specified by:
attribute in interface Receiver
Parameters:
nameCode - The name of the attribute, as held in the name pool
typeCode - The type of the attribute, as held in the name pool
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this attribute
NO_SPECIAL_CHARACTERS
Attribute value contains no special characters
javax.xml.transform.TransformerException

startContent

public void startContent()
                  throws javax.xml.transform.TransformerException
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Specified by:
startContent in interface Receiver
javax.xml.transform.TransformerException

endElement

public void endElement()
                throws javax.xml.transform.TransformerException
End of element

Specified by:
endElement in interface Receiver
javax.xml.transform.TransformerException

characters

public void characters(java.lang.CharSequence chars,
                       int properties)
                throws javax.xml.transform.TransformerException
Character data

Specified by:
characters in interface Receiver
Parameters:
chars - The characters
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this text node
USE_CDATA
Output as a CDATA section
NO_SPECIAL_CHARACTERS
Value contains no special characters
WHITESPACE
Text is all whitespace
javax.xml.transform.TransformerException

notifyNotWellFormed

protected void notifyNotWellFormed()
                            throws javax.xml.transform.TransformerException
The following function is called when it is found that the output is not a well-formed document. Unless the ContentHandler accepts "balanced content", this is a fatal error.

javax.xml.transform.TransformerException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  int properties)
                           throws javax.xml.transform.TransformerException
Processing Instruction

Specified by:
processingInstruction in interface Receiver
Parameters:
target - The PI name. This must be a legal name (it will not be checked).
data - The data portion of the processing instruction
properties - Additional information about the PI. The following bits are defined:
CHECKED
Data is known to be legal (e.g. doesn't contain "?>")
javax.xml.transform.TransformerException

comment

public void comment(java.lang.CharSequence chars,
                    int properties)
             throws javax.xml.transform.TransformerException
Output a comment. Passes it on to the ContentHandler provided that the ContentHandler is also a SAX2 LexicalHandler.

Specified by:
comment in interface Receiver
Parameters:
chars - The content of the comment
properties - Additional information about the comment. The following bits are defined:
CHECKED
Comment is known to be legal (e.g. doesn't contain "--")
javax.xml.transform.TransformerException

getPublicId

public java.lang.String getPublicId()
Specified by:
getPublicId in interface org.xml.sax.Locator

getLineNumber

public int getLineNumber()
Specified by:
getLineNumber in interface org.xml.sax.Locator

getColumnNumber

public int getColumnNumber()
Specified by:
getColumnNumber in interface org.xml.sax.Locator