Top Description Fields Methods
com.sun.org.apache.xml.internal.serializer

pack-priv Interface ExtendedContentHandler

extends ContentHandler
Known Direct Subinterfaces
com.sun.org.apache.xml.internal.serializer.SerializationHandler
Imports
javax.xml.transform.SourceLocator, org.xml.sax.SAXException

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)

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int

Method Summary

Modifier and TypeMethod and Description
public void
addAttribute(String
the namespace URI of the attribute name
uri
,
String
the local name of the attribute (without prefix)
localName
,
String
the qualified name of the attribute
rawName
,
String
the attribute type typically character data (CDATA)
type
,
String
the value of the attribute
value
,
boolean
true if the added attribute is coming from an xsl:attribute element
XSLAttribute
)

Add at attribute to the current element

public void
addAttribute(String qName, String value)

Add an attribute to the current element.

public void
addAttribute(String
the namespace URI of the attribute name
uri
,
String
the local name of the attribute (without prefix)
localName
,
String
the qualified name of the attribute
rawName
,
String
the attribute type typically character data (CDATA)
type
,
String
the value of the attribute
value
)

Add at attribute to the current element, not from an xsl:attribute element.

public void
addAttributes(Attributes
the attributes to add.
atts
)

Add attributes to the current element

public void
addUniqueAttribute(String
the fully qualified attribute name.
qName
,
String
the attribute value
value
,
int
a bitwise flag
flags
)

Add a unique attribute to the current element.

public void
addXSLAttribute(String
the qualified attribute name (prefix:localName)
qName
,
final String
the attributes value
value
,
final String
the uri that the prefix of the qName is mapped to.
uri
)

Add an attribute from an xsl:attribute element.

public void
characters(String
the character data
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.

public void
characters(Node
a DOM Node containing text.
node
)

This method is used to notify of a character event, but passing the data as a DOM Node rather than the standard character array.

public void
endElement(String
the fully qualified element name.
elemName
)

This method is used to notify that an element has ended.

public void
entityReference(String
the name of the entity
entityName
)

Notify of an entity reference.

public NamespaceMappings

Returns:

NamespaceMappings an object that has the current namespace mappings in effect.
getNamespaceMappings
()

This method returns an object that has the current namespace mappings in effect.

public String

Returns:

String the namespace URI associated with the element or attribute.
getNamespaceURI
(String
the qualified name of an element, or attribute
name
,
boolean
true if it is an element name, false if it is an atttribute name
isElement
)

This method gets the prefix associated with a current element or attribute name.

public String

Returns:

String the namespace URI currently associated with the prefix.
getNamespaceURIFromPrefix
(String
a prefix of an element or attribute.
prefix
)

This method returns the namespace URI currently associated with the prefix.

public String

Returns:

String the prefix that currently maps to the given URI.
getPrefix
(String
the namespace URI
uri
)

This method returns the prefix that currently maps to the given namespace URI.

public void
namespaceAfterStartElement(String
the namespace URI being declared
uri
,
String
the prefix that maps to the given namespace
prefix
)

This method is used to notify that a prefix mapping is to start, but after an element is started.

public void
setSourceLocator(SourceLocator
the source locator
locator
)

This method is used to set the source locator, which might be used to generated an error message.

public void
startElement(String
the namespace URI of the element
uri
,
String
the local name (without prefix) of the element
localName
,
String
the qualified name of the element
qName
)

This method is used to notify that an element is starting.

public void
startElement(String
the fully qualified name of the element
qName
)

This method is used to notify of the start of an element

public boolean

Returns:

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.
startPrefixMapping
(String
the prefix that maps to the given URI
prefix
,
String
the namespace URI of the given prefix
uri
,
boolean
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.
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.

Inherited from org.xml.sax.ContentHandler:
charactersdeclarationendDocumentendElementendPrefixMappingignorableWhitespaceprocessingInstructionsetDocumentLocatorskippedEntitystartDocumentstartElementstartPrefixMapping

Field Detail

HTML_ATTREMPTYback to summary
public static final int HTML_ATTREMPTY
HTML_ATTRURLback to summary
public static final int HTML_ATTRURL
NO_BAD_CHARSback to summary
public static final int NO_BAD_CHARS

Method Detail

addAttributeback to summary
public void addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute) throws SAXException

Add at attribute to the current element

Parameters
uri:String

the namespace URI of the attribute name

localName:String

the local name of the attribute (without prefix)

rawName:String

the qualified name of the attribute

type:String

the attribute type typically character data (CDATA)

value:String

the value of the attribute

XSLAttribute:boolean

true if the added attribute is coming from an xsl:attribute element

addAttributeback to summary
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".

addAttributeback to summary
public void addAttribute(String uri, String localName, String rawName, String type, String value) throws SAXException

Add at attribute to the current element, not from an xsl:attribute element.

Parameters
uri:String

the namespace URI of the attribute name

localName:String

the local name of the attribute (without prefix)

rawName:String

the qualified name of the attribute

type:String

the attribute type typically character data (CDATA)

value:String

the value of the attribute

addAttributesback to summary
public void addAttributes(Attributes atts) throws SAXException

Add attributes to the current element

Parameters
atts:Attributes

the attributes to add.

addUniqueAttributeback to summary
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.

Parameters
qName:String

the fully qualified attribute name.

value:String

the attribute value

flags:int

a bitwise flag

addXSLAttributeback to summary
public void addXSLAttribute(String qName, final String value, final String uri)

Add an attribute from an xsl:attribute element.

Parameters
qName:String

the qualified attribute name (prefix:localName)

value:String

the attributes value

uri:String

the uri that the prefix of the qName is mapped to.

charactersback to summary
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.

Parameters
chars:String

the character data

charactersback to summary
public void characters(Node node) throws SAXException

This method is used to notify of a character event, but passing the data as a DOM Node rather than the standard character array.

Parameters
node:Node

a DOM Node containing text.

endElementback to summary
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.
Parameters
elemName:String

the fully qualified element name.

entityReferenceback to summary
public void entityReference(String entityName) throws SAXException

Notify of an entity reference.

Parameters
entityName:String

the name of the entity

getNamespaceMappingsback to summary
public NamespaceMappings getNamespaceMappings()

This method returns an object that has the current namespace mappings in effect.

Returns:NamespaceMappings

NamespaceMappings an object that has the current namespace mappings in effect.

getNamespaceURIback to summary
public String getNamespaceURI(String name, boolean isElement)

This method gets the prefix associated with a current element or attribute name.

Parameters
name:String

the qualified name of an element, or attribute

isElement:boolean

true if it is an element name, false if it is an atttribute name

Returns:String

String the namespace URI associated with the element or attribute.

getNamespaceURIFromPrefixback to summary
public String getNamespaceURIFromPrefix(String prefix)

This method returns the namespace URI currently associated with the prefix.

Parameters
prefix:String

a prefix of an element or attribute.

Returns:String

String the namespace URI currently associated with the prefix.

getPrefixback to summary
public String getPrefix(String uri)

This method returns the prefix that currently maps to the given namespace URI.

Parameters
uri:String

the namespace URI

Returns:String

String the prefix that currently maps to the given URI.

namespaceAfterStartElementback to summary
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")
Parameters
uri:String

the namespace URI being declared

prefix:String

the prefix that maps to the given namespace

setSourceLocatorback to summary
public void setSourceLocator(SourceLocator locator)

This method is used to set the source locator, which might be used to generated an error message.

Parameters
locator:SourceLocator

the source locator

startElementback to summary
public void startElement(String uri, String localName, String qName) throws 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.
Parameters
uri:String

the namespace URI of the element

localName:String

the local name (without prefix) of the element

qName:String

the qualified name of the element

startElementback to summary
public void startElement(String qName) throws SAXException

This method is used to notify of the start of an element

Parameters
qName:String

the fully qualified name of the element

startPrefixMappingback to summary
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.

Parameters
prefix:String

the prefix that maps to the given URI

uri:String

the namespace URI of the given prefix

shouldFlush:boolean

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.

Returns:boolean

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.