|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--net.sf.saxon.event.Emitter
|
+--net.sf.saxon.event.ContentHandlerProxy
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 locationId,
int properties)
Notify an attribute. |
void |
characters(java.lang.CharSequence chars,
int locationId,
int properties)
Character data |
void |
close()
End of document |
void |
comment(java.lang.CharSequence chars,
int locationId,
int properties)
Output a comment. |
void |
endDocument()
Notify the end of a document node |
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 |
open()
Start of document |
void |
processingInstruction(java.lang.String target,
java.lang.CharSequence data,
int locationId,
int properties)
Processing Instruction |
void |
setDocumentLocator(LocationProvider provider)
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(int properties)
Start of a document node. |
void |
startElement(int nameCode,
int typeCode,
int locationId,
int properties)
Notify the start of an element |
| Methods inherited from class net.sf.saxon.event.Emitter |
getConfiguration, getDocumentLocator, 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 |
protected org.xml.sax.ContentHandler handler
protected org.xml.sax.ext.LexicalHandler lexicalHandler
protected org.xml.sax.Locator locator
| Constructor Detail |
public ContentHandlerProxy()
| Method Detail |
public void setUnderlyingContentHandler(org.xml.sax.ContentHandler handler)
public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler)
public void setOutputProperties(java.util.Properties details)
throws XPathException
setOutputProperties in class EmitterXPathExceptionpublic boolean isRequireWellFormed()
public void setRequireWellFormed(boolean wellFormed)
public boolean isUndeclareNamespaces()
public void setUndeclareNamespaces(boolean undeclareNamespaces)
undeclareNamespaces - true if namespace undeclarations (xmlns:p="") are to be outputpublic void setDocumentLocator(LocationProvider provider)
setDocumentLocator in interface ReceiversetDocumentLocator in class Emitter
public void open()
throws XPathException
open in interface ReceiverXPathException
public void close()
throws XPathException
close in interface ReceiverXPathException
public void startDocument(int properties)
throws XPathException
startDocument in interface ReceiverXPathException
public void endDocument()
throws XPathException
endDocument in interface ReceiverXPathException
public void startElement(int nameCode,
int typeCode,
int locationId,
int properties)
throws XPathException
startElement in interface ReceivernameCode - integer code identifying the name of the element within the name pool.typeCode - integer code identifying the element's type within the name pool. The value -1
indicates the default type, xdt:untyped.locationId - an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.
XPathException
public void namespace(int namespaceCode,
int properties)
throws XPathException
namespace in interface ReceivernamespaceCode - 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.
XPathException
public void attribute(int nameCode,
int typeCode,
java.lang.CharSequence value,
int locationId,
int properties)
throws XPathException
attribute in interface ReceivernameCode - The name of the attribute, as held in the name pooltypeCode - The type of the attribute, as held in the name poollocationId - an integer which can be interpreted using a LocationMap 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
public void startContent()
throws XPathException
startContent in interface ReceiverXPathException
public void endElement()
throws XPathException
endElement in interface ReceiverXPathException
public void characters(java.lang.CharSequence chars,
int locationId,
int properties)
throws XPathException
characters in interface Receiverchars - The characterslocationId - an integer which can be interpreted using a LocationMap 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
protected void notifyNotWellFormed()
throws XPathException
XPathException
public void processingInstruction(java.lang.String target,
java.lang.CharSequence data,
int locationId,
int properties)
throws XPathException
processingInstruction in interface Receivertarget - 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 LocationMap 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. The following bits are
defined:
XPathException
public void comment(java.lang.CharSequence chars,
int locationId,
int properties)
throws XPathException
comment in interface Receiverchars - The content of the commentlocationId - an integer which can be interpreted using a LocationMap 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. The following bits are
defined:
XPathExceptionpublic java.lang.String getPublicId()
getPublicId in interface org.xml.sax.Locatorpublic int getLineNumber()
getLineNumber in interface org.xml.sax.Locatorpublic int getColumnNumber()
getColumnNumber in interface org.xml.sax.Locator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||