|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.event.ContentHandlerProxy
public class ContentHandlerProxy
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 TypedContentHandler
Nested Class Summary | |
---|---|
static class |
ContentHandlerProxy.ContentHandlerProxyTraceListener
Create a TraceListener that will collect information about the current location in the source document. |
Field Summary | |
---|---|
protected ContentHandler |
handler
|
protected LexicalHandler |
lexicalHandler
|
protected AttributeCollectionImpl |
pendingAttributes
|
Fields inherited from interface javax.xml.transform.Result |
---|
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
Constructor Summary | |
---|---|
ContentHandlerProxy()
|
Method Summary | |
---|---|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
CharSequence value,
int locationId,
int properties)
Notify an attribute. |
void |
characters(CharSequence chars,
int locationId,
int properties)
Character data |
void |
close()
Notify the end of the event stream |
void |
comment(CharSequence chars,
int locationId,
int properties)
Output a comment. |
void |
endDocument()
Notify the end of the document |
void |
endElement()
End of element |
Configuration |
getConfiguration()
Get the Saxon configuration |
long |
getCurrentLocationId()
Get the current location identifier |
LocationProvider |
getLocationProvider()
Get the location provider |
PipelineConfiguration |
getPipelineConfiguration()
Get the pipeline configuration |
String |
getSystemId()
Get the System ID of the destination tree |
ContentHandlerProxy.ContentHandlerProxyTraceListener |
getTraceListener()
Get the associated TraceListener that receives notification of trace events |
ContentHandler |
getUnderlyingContentHandler()
Get the underlying content handler |
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. |
boolean |
isUndeclareNamespaces()
Ask whether namespace undeclaration events (for a non-null prefix) should be notified. |
void |
namespace(NamespaceBinding namespaceBinding,
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 |
open()
Notify the start of the event stream |
void |
processingInstruction(String target,
CharSequence data,
int locationId,
int properties)
Processing Instruction |
void |
setLexicalHandler(LexicalHandler handler)
Set the Lexical Handler to be used. |
void |
setOutputProperties(Properties details)
Set the output details. |
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration |
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. |
void |
setSystemId(String systemId)
Set the System ID of the destination tree |
void |
setUndeclareNamespaces(boolean undeclareNamespaces)
Set whether namespace undeclaration events (for a non-null prefix) should be notified. |
void |
setUnderlyingContentHandler(ContentHandler handler)
Set the underlying content handler. |
void |
setUnparsedEntity(String name,
String systemID,
String publicID)
Notify an unparsed entity URI. |
void |
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces. |
void |
startDocument(int properties)
Notify the start of the document. |
void |
startElement(NodeName nameCode,
SchemaType typeCode,
int locationId,
int properties)
Notify the start of an element |
boolean |
usesTypeAnnotations()
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 |
Field Detail |
---|
protected ContentHandler handler
protected LexicalHandler lexicalHandler
protected AttributeCollectionImpl pendingAttributes
Constructor Detail |
---|
public ContentHandlerProxy()
Method Detail |
---|
public void setUnderlyingContentHandler(ContentHandler handler)
LexicalHandler
, then it will also receive
notification of lexical events such as comments.
handler
- the SAX content handler to which all events will be directedpublic ContentHandler getUnderlyingContentHandler()
public void setLexicalHandler(LexicalHandler handler)
handler
- the SAX lexical handler to which lexical events (such as comments) will
be notified.public void setPipelineConfiguration(PipelineConfiguration pipe)
setPipelineConfiguration
in interface Receiver
pipe
- the pipeline configurationpublic PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
in interface Receiver
public Configuration getConfiguration()
public void setSystemId(String systemId)
setSystemId
in interface Result
setSystemId
in interface Receiver
systemId
- the system ID (effectively the base URI)public String getSystemId()
getSystemId
in interface Result
public ContentHandlerProxy.ContentHandlerProxyTraceListener getTraceListener()
public LocationProvider getLocationProvider()
public long getCurrentLocationId()
public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
setUnparsedEntity
in interface Receiver
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity
XPathException
- if an error occurspublic void setOutputProperties(Properties details) throws XPathException
details
- the serialization properties. The only values used by this implementation are
SaxonOutputKeys.REQUIRE_WELL_FORMED
and SaxonOutputKeys.UNDECLARE_PREFIXES
.
XPathException
public boolean isRequireWellFormed()
public void setRequireWellFormed(boolean wellFormed)
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.public boolean isUndeclareNamespaces()
public void setUndeclareNamespaces(boolean undeclareNamespaces)
undeclareNamespaces
- true if namespace undeclarations (xmlns:p="") are to be outputpublic void open() throws XPathException
open
in interface Receiver
XPathException
- if an error occurspublic void close() throws XPathException
close
in interface Receiver
XPathException
- if an error occurspublic void startDocument(int properties) throws XPathException
startDocument
in interface Receiver
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occurspublic void endDocument() throws XPathException
endDocument
in interface Receiver
XPathException
- if an error occurspublic void startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
startElement
in interface Receiver
nameCode
- the name of the element.typeCode
- the type annotation of the element.locationId
- an integer which can be interpreted using a LocationProvider
to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- bit-significant properties of the element node. If there are no revelant
properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occurspublic void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
namespace
in interface Receiver
namespaceBinding
- contains the namespace prefix and namespace URIproperties
- The most important property is REJECT_DUPLICATES. If this property is set, the
namespace declaration will be rejected if it conflicts with a previous declaration of the same
prefix. If the property is not set, the namespace declaration will be ignored if it conflicts
with a previous declaration. This reflects the fact that when copying a tree, namespaces for child
elements are emitted before the namespaces of their parent element. Unfortunately this conflicts
with the XSLT rule for complex content construction, where the recovery action in the event of
conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
XPathException
- if an error occurspublic void attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
attribute
in interface Receiver
nameCode
- The name of the attributetypeCode
- The type of the attribute, as held in the name pool. The additional bit
NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.value
- the string value of the attributelocationId
- an integer which can be interpreted using a LocationProvider
to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void startContent() throws XPathException
startContent
in interface Receiver
XPathException
- if an error occurspublic void endElement() throws XPathException
endElement
in interface Receiver
XPathException
- if an error occurspublic void characters(CharSequence chars, int locationId, int properties) throws XPathException
characters
in interface Receiver
chars
- The characterslocationId
- an integer which can be interpreted using a LocationProvider
to return information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occursprotected void notifyNotWellFormed() throws XPathException
XPathException
public void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException
processingInstruction
in interface Receiver
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- an integer which can be interpreted using a LocationProvider
to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Additional information about the PI.
XPathException
- if an error occurspublic void comment(CharSequence chars, int locationId, int properties) throws XPathException
comment
in interface Receiver
chars
- The content of the commentlocationId
- an integer which can be interpreted using a LocationProvider
to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.properties
- Additional information about the comment.
XPathException
- if an error occurspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |