Package net.sf.saxon.event
Class ContentHandlerProxy
- java.lang.Object
-
- net.sf.saxon.event.ContentHandlerProxy
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
- Direct Known Subclasses:
TypedContentHandler
public class ContentHandlerProxy extends java.lang.Object implements Receiver
A ContentHandlerProxy is a Receiver that converts events into the form expected by an underlying SAX2 ContentHandler. Relevant events (notably comments) can also be fed to a LexicalHandler.Note that in general the output passed to a Receiver 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, unless the saxon:require-well-formed output property is set to "no".
This ContentHandlerProxy provides no access to type information. For a ContentHandler that makes type information available, see
TypedContentHandlerThe ContentHandlerProxy can also be nominated as a TraceListener, to receive notification of trace events.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classContentHandlerProxy.ContentHandlerProxyTraceListenerCreate a TraceListener that will collect information about the current location in the source document.
-
Field Summary
Fields Modifier and Type Field Description protected org.xml.sax.ContentHandlerhandlerprotected org.xml.sax.ext.LexicalHandlerlexicalHandler
-
Constructor Summary
Constructors Constructor Description ContentHandlerProxy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Character datavoidclose()Notify the end of the event streamvoidcomment(java.lang.CharSequence chars, Location locationId, int properties)Output a comment.voidendDocument()Notify the end of the documentvoidendElement()End of elementConfigurationgetConfiguration()Get the Saxon configurationLocationgetCurrentLocation()Get the current location identifierPipelineConfigurationgetPipelineConfiguration()Get the pipeline configurationjava.lang.StringgetSystemId()Get the System ID of the destination treeContentHandlerProxy.ContentHandlerProxyTraceListenergetTraceListener()Get the associated TraceListener that receives notification of trace eventsorg.xml.sax.ContentHandlergetUnderlyingContentHandler()Get the underlying content handlerbooleanisRequireWellFormed()Ask 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.booleanisUndeclareNamespaces()Ask whether namespace undeclaration events (for a non-null prefix) should be notified.protected voidnotifyNotWellFormed()The following function is called when it is found that the output is not a well-formed document.voidopen()Notify the start of the event streamvoidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Processing InstructionvoidsetLexicalHandler(org.xml.sax.ext.LexicalHandler handler)Set the Lexical Handler to be used.voidsetOutputProperties(java.util.Properties details)Set the output details.voidsetPipelineConfiguration(PipelineConfiguration pipe)Set the pipeline configurationvoidsetRequireWellFormed(boolean wellFormed)Set 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.voidsetSystemId(java.lang.String systemId)Set the System ID of the destination treevoidsetUndeclareNamespaces(boolean undeclareNamespaces)Set whether namespace undeclaration events (for a non-null prefix) should be notified.voidsetUnderlyingContentHandler(org.xml.sax.ContentHandler handler)Set the underlying content handler.voidsetUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID)Notify an unparsed entity URI.voidstartDocument(int properties)Notify the start of the document.voidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an elementbooleanusesTypeAnnotations()Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.event.Receiver
append, append, handlesAppend
-
-
-
-
Method Detail
-
setUnderlyingContentHandler
public void setUnderlyingContentHandler(org.xml.sax.ContentHandler handler)
Set the underlying content handler. This call is mandatory before using this Receiver. If the content handler is an instance ofLexicalHandler, then it will also receive notification of lexical events such as comments.- Parameters:
handler- the SAX content handler to which all events will be directed
-
getUnderlyingContentHandler
public org.xml.sax.ContentHandler getUnderlyingContentHandler()
Get the underlying content handler- Returns:
- the SAX content handler to which all events are being directed
-
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()- Parameters:
handler- the SAX lexical handler to which lexical events (such as comments) will be notified.
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration- Specified by:
setPipelineConfigurationin interfaceReceiver- Parameters:
pipe- the pipeline configuration
-
getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()
Get the pipeline configuration- Specified by:
getPipelineConfigurationin interfaceReceiver- Returns:
- the pipeline configuration
-
getConfiguration
public Configuration getConfiguration()
Get the Saxon configuration- Returns:
- the Saxon configuration
-
setSystemId
public void setSystemId(java.lang.String systemId)
Set the System ID of the destination tree- Specified by:
setSystemIdin interfaceReceiver- Specified by:
setSystemIdin interfacejavax.xml.transform.Result- Parameters:
systemId- the system ID (effectively the base URI)
-
getSystemId
public java.lang.String getSystemId()
Get the System ID of the destination tree- Specified by:
getSystemIdin interfacejavax.xml.transform.Result- Returns:
- the system ID (effectively the base URI)
-
getTraceListener
public ContentHandlerProxy.ContentHandlerProxyTraceListener getTraceListener()
Get the associated TraceListener that receives notification of trace events- Returns:
- the trace listener. If there is no existing trace listener, then a new one will be created.
-
getCurrentLocation
public Location getCurrentLocation()
Get the current location identifier- Returns:
- the location identifier of the most recent event.
-
setUnparsedEntity
public void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathExceptionNotify an unparsed entity URI.- Specified by:
setUnparsedEntityin interfaceReceiver- Parameters:
name- The name of the unparsed entitysystemID- The system identifier of the unparsed entitypublicID- The public identifier of the unparsed entity- Throws:
XPathException- if an error occurs
-
setOutputProperties
public void setOutputProperties(java.util.Properties details)
Set the output details.- Parameters:
details- the serialization properties. The only values used by this implementation areSaxonOutputKeys.REQUIRE_WELL_FORMEDandSaxonOutputKeys.UNDECLARE_PREFIXES.
-
isRequireWellFormed
public boolean isRequireWellFormed()
Ask 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.- Returns:
- true if the content handler requires the event stream to represent a well-formed XML document (containing exactly one top-level element node and no top-level text nodes)
-
setRequireWellFormed
public void setRequireWellFormed(boolean wellFormed)
Set 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. The default is false.- Parameters:
wellFormed- set to true if the content handler requires the event stream to represent a well-formed XML document (containing exactly one top-level element node and no top-level text nodes). Otherwise, multiple top-level elements and text nodes are allowed, as in the XDM model.
-
isUndeclareNamespaces
public boolean isUndeclareNamespaces()
Ask 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 to be output
-
setUndeclareNamespaces
public void setUndeclareNamespaces(boolean undeclareNamespaces)
Set 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
-
open
public void open() throws XPathExceptionNotify the start of the event stream- Specified by:
openin interfaceReceiver- Throws:
XPathException- if an error occurs
-
close
public void close() throws XPathExceptionNotify the end of the event stream- Specified by:
closein interfaceReceiver- Throws:
XPathException- if an error occurs
-
startDocument
public void startDocument(int properties) throws XPathExceptionNotify the start of the document.- Specified by:
startDocumentin interfaceReceiver- Parameters:
properties-- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionNotify the end of the document- Specified by:
endDocumentin interfaceReceiver- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Notify the start of an element- Specified by:
startElementin interfaceReceiver- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endElement
public void endElement() throws XPathExceptionEnd of element- Specified by:
endElementin interfaceReceiver- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionCharacter data- Specified by:
charactersin interfaceReceiver- Parameters:
chars- The characterslocationId- provides information such as line number and system ID.properties- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException- if an error occurs
-
notifyNotWellFormed
protected void notifyNotWellFormed() throws XPathExceptionThe 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.- Throws:
XPathException
-
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionProcessing Instruction- Specified by:
processingInstructionin interfaceReceiver- Parameters:
target- The PI name. This must be a legal name (it will not be checked).data- The data portion of the processing instructionlocationId- provides information such as line number and system ID.properties- Additional information about the PI.- Throws:
XPathException- if an error occurs
-
comment
public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionOutput a comment. Passes it on to the ContentHandler provided that the ContentHandler is also a SAX2 LexicalHandler.- Specified by:
commentin interfaceReceiver- Parameters:
chars- The content of the commentlocationId- provides information such as line number and system ID.properties- Additional information about the comment.- Throws:
XPathException- if an error occurs
-
usesTypeAnnotations
public boolean usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events- Specified by:
usesTypeAnnotationsin interfaceReceiver- Returns:
- true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation
-
-