org.apache.xml.serializer
Interface ExtendedContentHandler
- org.xml.sax.ContentHandler
- SerializationHandler
- AdaptiveResultTreeImpl, EmptySerializer, SerializerBase, SimpleResultTreeImpl, StringValueHandler, ToHTMLSAXHandler, ToHTMLStream, ToSAXHandler, ToStream, ToTextSAXHandler, ToTextStream, ToUnknownStream, ToXMLSAXHandler, ToXMLStream
public interface ExtendedContentHandler
extends org.xml.sax.ContentHandler
This interface describes extensions to the SAX ContentHandler interface.
It is intended to be used by a serializer. The methods on this interface will
implement SAX- like behavior. This allows the gradual collection of
information rather than having it all up front. For example the call
startElement(namespaceURI,localName,qName,atts)
could be replaced with the calls
startElement(namespaceURI,localName,qName)
addAttributes(atts)
If there are no attributes the second call can be dropped. If attributes are
to be added one at a time with calls to
addAttribute(namespaceURI, localName, qName, type, value)
void | addAttribute(String qName, String value) - Add an attribute to the current element.
|
void | addAttribute(String uri, String localName, String rawName, String type, String value) - Add at attribute to the current element
|
void | addAttributes(org.xml.sax.Attributes atts) - Add attributes to the current element
|
void | addUniqueAttribute(String qName, String value, int flags) - Add a unique attribute to the current element.
|
void | characters(String chars) - This method is used to notify of a character event, but passing the data
as a character String rather than the standard character array.
|
void | endElement(String elemName) - This method is used to notify that an element has ended.
|
void | entityReference(String entityName) - Notify of an entity reference.
|
NamespaceMappings | getNamespaceMappings() - This method returns an object that has the current namespace mappings in
effect.
|
String | getNamespaceURI(String name, boolean isElement) - This method gets the prefix associated with a current element or
attribute name.
|
String | getNamespaceURIFromPrefix(String prefix) - This method returns the namespace URI currently associated with the
prefix.
|
String | getPrefix(String uri) - This method returns the prefix that currently maps to the given namespace
URI.
|
void | namespaceAfterStartElement(String uri, String prefix) - This method is used to notify that a prefix mapping is to start, but
after an element is started.
|
void | setSourceLocator(SourceLocator locator) - This method is used to set the source locator, which might be used to
generated an error message.
|
void | startElement(String qName) - This method is used to notify of the start of an element
|
void | startElement(String uri, String localName, String qName) - This method is used to notify that an element is starting.
|
boolean | startPrefixMapping(String prefix, String uri, boolean shouldFlush) - This method is used to notify that a prefix maping is to start, which can
be for the current element, or for the one to come.
|
HTML_ATTREMPTY
public static final int HTML_ATTREMPTY
HTML_ATTRURL
public static final int HTML_ATTRURL
NO_BAD_CHARS
public static final int NO_BAD_CHARS
addAttribute
public void addAttribute(String qName,
String value)
Add an attribute to the current element. The namespace URI of the
attribute will be calculated from the prefix of qName. The local name
will be derived from qName and the type will be assumed to be "CDATA".
addAttribute
public void addAttribute(String uri,
String localName,
String rawName,
String type,
String value)
throws SAXException
Add at attribute to the current element
uri
- the namespace URI of the attribute namelocalName
- the local name of the attribute (without prefix)rawName
- the qualified name of the attributetype
- the attribute type typically character data (CDATA)value
- the value of the attribute
addAttributes
public void addAttributes(org.xml.sax.Attributes atts)
throws org.xml.sax.SAXException
Add attributes to the current element
atts
- the attributes to add.
addUniqueAttribute
public void addUniqueAttribute(String qName,
String value,
int flags)
throws SAXException
Add a unique attribute to the current element.
The attribute is guaranteed to be unique here. The serializer can write
it out immediately without saving it in a table first. The integer
flag contains information about the attribute, which helps the serializer
to decide whether a particular processing is needed.
qName
- the fully qualified attribute name.value
- the attribute valueflags
- a bitwise flag
characters
public void characters(String chars)
throws SAXException
This method is used to notify of a character event, but passing the data
as a character String rather than the standard character array.
chars
- the character data
endElement
public void endElement(String elemName)
throws SAXException
This method is used to notify that an element has ended. Unlike the
standard SAX method
endElement(namespaceURI,localName,qName)
only the last parameter is passed. If needed the serializer can derive
the localName from the qualified name and derive the namespaceURI from
its implementation.
elemName
- the fully qualified element name.
entityReference
public void entityReference(String entityName)
throws SAXException
Notify of an entity reference.
entityName
- the name of the entity
getNamespaceMappings
public NamespaceMappings getNamespaceMappings()
This method returns an object that has the current namespace mappings in
effect.
- NamespaceMappings an object that has the current namespace
mappings in effect.
getNamespaceURI
public String getNamespaceURI(String name,
boolean isElement)
This method gets the prefix associated with a current element or
attribute name.
name
- the qualified name of an element, or attributeisElement
- true if it is an element name, false if it is an
atttribute name
- String the namespace URI associated with the element or
attribute.
getNamespaceURIFromPrefix
public String getNamespaceURIFromPrefix(String prefix)
This method returns the namespace URI currently associated with the
prefix.
prefix
- a prefix of an element or attribute.
- String the namespace URI currently associated with the prefix.
getPrefix
public String getPrefix(String uri)
This method returns the prefix that currently maps to the given namespace
URI.
- String the prefix that currently maps to the given URI.
namespaceAfterStartElement
public void namespaceAfterStartElement(String uri,
String prefix)
throws SAXException
This method is used to notify that a prefix mapping is to start, but
after an element is started. The SAX method call
startPrefixMapping(prefix,uri)
is used just before an element starts and applies to the element to come,
not to the current element. This method applies to the current element.
For example one could make the calls in this order:
startElement("prfx8:elem9")
namespaceAfterStartElement("http://namespace8","prfx8")
uri
- the namespace URI being declaredprefix
- the prefix that maps to the given namespace
setSourceLocator
public void setSourceLocator(SourceLocator locator)
This method is used to set the source locator, which might be used to
generated an error message.
locator
- the source locator
startElement
public void startElement(String qName)
throws SAXException
This method is used to notify of the start of an element
qName
- the fully qualified name of the element
startElement
public void startElement(String uri,
String localName,
String qName)
throws org.xml.sax.SAXException
This method is used to notify that an element is starting.
This method is just like the standard SAX method
startElement(uri,localName,qname,atts)
but without the attributes.
uri
- the namespace URI of the elementlocalName
- the local name (without prefix) of the elementqName
- the qualified name of the element
startPrefixMapping
public boolean startPrefixMapping(String prefix,
String uri,
boolean shouldFlush)
throws SAXException
This method is used to notify that a prefix maping is to start, which can
be for the current element, or for the one to come.
prefix
- the prefix that maps to the given URIuri
- the namespace URI of the given prefixshouldFlush
- if true this call is like the SAX
startPrefixMapping(prefix,uri) call and the mapping applies to the
element to come. If false the mapping applies to the current element.
- boolean false if the prefix mapping was already in effect (in
other words we are just re-declaring), true if this is a new, never
before seen mapping for the element.
Copyright B) 2004 Apache XML Project. All Rights Reserved.