|
||||||||||
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 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 |
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 javax.xml.transform.TransformerException
setOutputProperties
in class Emitter
javax.xml.transform.TransformerException
public 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(org.xml.sax.Locator locator)
setDocumentLocator
in interface Receiver
setDocumentLocator
in class Emitter
public void startDocument() throws javax.xml.transform.TransformerException
startDocument
in interface Receiver
javax.xml.transform.TransformerException
public void endDocument() throws javax.xml.transform.TransformerException
endDocument
in interface Receiver
javax.xml.transform.TransformerException
public void startElement(int nameCode, int typeCode, int properties) throws javax.xml.transform.TransformerException
startElement
in interface Receiver
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
public void namespace(int namespaceCode, int properties) throws javax.xml.transform.TransformerException
namespace
in interface Receiver
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
public void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int properties) throws javax.xml.transform.TransformerException
attribute
in interface Receiver
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolproperties
- Bit significant value. The following bits are defined:
javax.xml.transform.TransformerException
public void startContent() throws javax.xml.transform.TransformerException
startContent
in interface Receiver
javax.xml.transform.TransformerException
public void endElement() throws javax.xml.transform.TransformerException
endElement
in interface Receiver
javax.xml.transform.TransformerException
public void characters(java.lang.CharSequence chars, int properties) throws javax.xml.transform.TransformerException
characters
in interface Receiver
chars
- The charactersproperties
- Bit significant value. The following bits are defined:
javax.xml.transform.TransformerException
protected void notifyNotWellFormed() throws javax.xml.transform.TransformerException
javax.xml.transform.TransformerException
public void processingInstruction(java.lang.String target, java.lang.CharSequence data, int properties) throws javax.xml.transform.TransformerException
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 instructionproperties
- Additional information about the PI. The following bits are
defined:
javax.xml.transform.TransformerException
public void comment(java.lang.CharSequence chars, int properties) throws javax.xml.transform.TransformerException
comment
in interface Receiver
chars
- The content of the commentproperties
- Additional information about the comment. The following bits are
defined:
javax.xml.transform.TransformerException
public java.lang.String getPublicId()
getPublicId
in interface org.xml.sax.Locator
public int getLineNumber()
getLineNumber
in interface org.xml.sax.Locator
public 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 |