public abstract class ToSAXHandler extends SerializerBase
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CDATA_CONTINUE
To insert ]]> in a CDATA section by ending the last CDATA section with
]] and starting the next CDATA section with >
|
static java.lang.String |
CDATA_DELIMITER_CLOSE
The constant "]]>"
|
static java.lang.String |
CDATA_DELIMITER_OPEN |
static java.lang.String |
DEFAULT_SAX_SERIALIZER |
static java.lang.String |
EMPTYSTRING |
static java.lang.String |
ENTITY_AMP |
static java.lang.String |
ENTITY_CRLF |
static java.lang.String |
ENTITY_GT |
static java.lang.String |
ENTITY_LT |
static java.lang.String |
ENTITY_QUOT |
static java.lang.String |
XML_PREFIX |
static java.lang.String |
XMLNS_PREFIX |
static java.lang.String |
XMLNS_URI |
static java.lang.String |
XMLVERSION10 |
static java.lang.String |
XMLVERSION11
Define the XML version.
|
PKG_NAME, PKG_PATH
HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS
Constructor and Description |
---|
ToSAXHandler() |
ToSAXHandler(ContentHandler hdlr,
LexicalHandler lex,
java.lang.String encoding) |
ToSAXHandler(ContentHandler handler,
java.lang.String encoding) |
Modifier and Type | Method and Description |
---|---|
void |
addUniqueAttribute(java.lang.String qName,
java.lang.String value,
int flags)
Add a unique attribute
|
void |
characters(Node node)
This method gets the node's value as a String and uses that String as if
it were an input character notification.
|
void |
characters(java.lang.String characters)
Receive notification of character data.
|
void |
comment(java.lang.String comment)
Receive notification of a comment.
|
void |
error(SAXParseException exc)
Receive notification of a recoverable error.
|
void |
fatalError(SAXParseException exc)
Receive notification of a non-recoverable error.
|
void |
flushPending()
This method flushes any pending events, which can be startDocument()
closing the opening tag of an element, or closing an open CDATA section.
|
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Do nothing as this is an abstract class.
|
boolean |
reset()
Try's to reset the super class and reset this class for
re-use, so that you don't need to create a new serializer
(mostly for performance reasons).
|
void |
setCdataSectionElements(java.util.Vector URI_and_localNames)
Does nothing.
|
void |
setContentHandler(ContentHandler _saxHandler)
Sets the SAX ContentHandler.
|
void |
setLexHandler(LexicalHandler _lexHandler)
Sets the LexicalHandler.
|
void |
setShouldOutputNSAttr(boolean doOutputNSAttr)
Set whether or not namespace declarations (e.g.
|
void |
setTransformState(TransformStateSetter ts)
Pass in a reference to a TransformState object, which
can be used during SAX ContentHandler events to obtain
information about he state of the transformation.
|
void |
startDTD(java.lang.String arg0,
java.lang.String arg1,
java.lang.String arg2)
Do nothing.
|
void |
startElement(java.lang.String qName)
An element starts, but attributes are not fully known yet.
|
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
Receives notification that an element starts, but attributes are not
fully known yet.
|
void |
startElement(java.lang.String arg0,
java.lang.String arg1,
java.lang.String arg2,
Attributes arg3)
Receive notification of the beginning of an element, although this is a
SAX method additional namespace or attribute information can occur before
or after this call, that is associated with this element.
|
void |
warning(SAXParseException exc)
Receive notification of a warning.
|
addAttribute, addAttribute, addAttribute, addAttributeAlways, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, close, documentIsEmpty, endEntity, entityReference, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getIndentAmount, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getStandalone, getTransformer, getVersion, namespaceAfterStartElement, notationDecl, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setDTDEntityExpansion, setEncoding, setIndent, setIndentAmount, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setTransformer, setVersion, startDocument, unparsedEntityDecl
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
serialize, setEscaping
endElement, startPrefixMapping
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, skippedEntity, startPrefixMapping
comment, endCDATA, endDTD, startCDATA, startEntity
attributeDecl, elementDecl, externalEntityDecl, internalEntityDecl
getOutputFormat, getOutputStream, getWriter, setOutputFormat, setOutputStream, setWriter
public static final java.lang.String CDATA_CONTINUE
public static final java.lang.String CDATA_DELIMITER_CLOSE
public static final java.lang.String CDATA_DELIMITER_OPEN
public static final java.lang.String EMPTYSTRING
public static final java.lang.String ENTITY_AMP
public static final java.lang.String ENTITY_CRLF
public static final java.lang.String ENTITY_GT
public static final java.lang.String ENTITY_LT
public static final java.lang.String ENTITY_QUOT
public static final java.lang.String XML_PREFIX
public static final java.lang.String XMLNS_PREFIX
public static final java.lang.String XMLNS_URI
public static final java.lang.String DEFAULT_SAX_SERIALIZER
public static final java.lang.String XMLVERSION11
public static final java.lang.String XMLVERSION10
public ToSAXHandler()
public ToSAXHandler(ContentHandler hdlr, LexicalHandler lex, java.lang.String encoding)
public ToSAXHandler(ContentHandler handler, java.lang.String encoding)
public void startDTD(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2) throws SAXException
arg0
- The document type name.arg1
- The declared public identifier for the
external DTD subset, or null if none was declared.arg2
- The declared system identifier for the
external DTD subset, or null if none was declared.
(Note that this is not resolved against the document
base URI.)SAXException
- The application may raise an
exception.LexicalHandler.startDTD(String, String, String)
public void characters(java.lang.String characters) throws SAXException
characters
- The string of characters to process.SAXException
ExtendedContentHandler.characters(String)
public void comment(java.lang.String comment) throws SAXException
comment
in interface ExtendedLexicalHandler
comment
in class SerializerBase
comment
- the comment, but unlike the SAX comment() method this
method takes a String rather than a character array.SAXException
ExtendedLexicalHandler.comment(String)
public void processingInstruction(java.lang.String target, java.lang.String data) throws SAXException
target
- the processing instruction targetdata
- the processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the targetSAXException
- any SAX exception, possibly
wrapping another exceptionContentHandler.processingInstruction(String, String)
public void startElement(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2, Attributes arg3) throws SAXException
arg0
- the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedarg1
- the local name (without prefix), or the
empty string if Namespace processing is not being
performedarg2
- the qualified name (with prefix), or the
empty string if qualified names are not availablearg3
- the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefinedSAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
,
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
AttributeList
,
ContentHandler.startElement(String,String,String,Attributes)
public void setLexHandler(LexicalHandler _lexHandler)
_lexHandler
- The LexicalHandler to setpublic void setContentHandler(ContentHandler _saxHandler)
_saxHandler
- The ContentHandler to setSerializer.asContentHandler()
,
ToSAXHandler
public void setCdataSectionElements(java.util.Vector URI_and_localNames)
URI_and_localNames
- pairs of namespace URI and local names that
identify elements whose text elements are to be output as CDATA sections.
The namespace of the local element must be the given URI to match. The
qName is not given because the prefix does not matter, only the namespace
URI to which that prefix would map matters, so the prefix itself is not
relevant in specifying which elements have their text to be output as
CDATA sections.XSLOutputAttributes.setCdataSectionElements(java.util.Vector)
public void setShouldOutputNSAttr(boolean doOutputNSAttr)
doOutputNSAttr
- whether or not namespace declarations
should appear as attributespublic void flushPending() throws SAXException
SAXException
public void setTransformState(TransformStateSetter ts)
ts
- A reference to a TransformState objectpublic void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws SAXException
uri
- the URI of the namespace of the element (optional)localName
- the element name, but without prefix (optional)qName
- the element name, with prefix, if any (required)SAXException
ExtendedContentHandler.startElement(String, String, String)
public void startElement(java.lang.String qName) throws SAXException
qName
- the element name, with prefix (if any).SAXException
ExtendedContentHandler.startElement(String)
public void characters(Node node) throws SAXException
characters
in interface ExtendedContentHandler
characters
in class SerializerBase
node
- the Node to serializeSAXException
public void fatalError(SAXParseException exc) throws SAXException
ErrorHandler
There is an apparent contradiction between the
documentation for this method and the documentation for ContentHandler.endDocument()
. Until this ambiguity
is resolved in a future major release, clients should make no
assumptions about whether endDocument() will or will not be
invoked when the parser has reported a fatalError() or thrown
an exception.
This corresponds to the definition of "fatal error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a parser would use this callback to report the violation of a well-formedness constraint.
The application must assume that the document is unusable after the parser has invoked this method, and should continue (if at all) only for the sake of collecting additional error messages: in fact, SAX parsers are free to stop reporting any other events once this method has been invoked.
fatalError
in interface ErrorHandler
fatalError
in class SerializerBase
exc
- The error information encapsulated in a
SAX parse exception.SAXException
- Any SAX exception, possibly
wrapping another exception.ErrorHandler.fatalError(SAXParseException)
public void error(SAXParseException exc) throws SAXException
ErrorHandler
This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.
The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.
Filters may use this method to report other, non-XML errors as well.
error
in interface ErrorHandler
error
in class SerializerBase
exc
- The error information encapsulated in a
SAX parse exception.SAXException
- Any SAX exception, possibly
wrapping another exception.ErrorHandler.error(SAXParseException)
public void warning(SAXParseException exc) throws SAXException
ErrorHandler
SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.
The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.
Filters may use this method to report other, non-XML warnings as well.
warning
in interface ErrorHandler
warning
in class SerializerBase
exc
- The warning information encapsulated in a
SAX parse exception.SAXException
- Any SAX exception, possibly
wrapping another exception.ErrorHandler.warning(SAXParseException)
public boolean reset()
reset
in interface Serializer
reset
in class SerializerBase
Serializer.reset()
public void addUniqueAttribute(java.lang.String qName, java.lang.String value, int flags) throws SAXException
qName
- the fully qualified attribute name.value
- the attribute valueflags
- a bitwise flagSAXException
Copyright © 2014 Apache XML Project. All Rights Reserved.