TransformerHandler

AI-generated Key Takeaways

• TransformerHandler listens for SAX ContentHandler parse events and transforms them into a Result object.

• It provides methods to set and retrieve the base system ID for resolving relative URLs during the transformation.

• Users can access the associated Transformer object to configure parameters and output properties.

• A Result object, specifying the transformation output destination, can be set using the setResult method.

public interface TransformerHandler implements ContentHandler LexicalHandler DTDHandler

A TransformerHandler listens for SAX ContentHandler parse events and transforms them to a Result.

Public Method Summary

abstract String	getSystemId() Get the base ID (URI or system ID) from where relative URLs will be resolved.
abstract Transformer	getTransformer() Get the Transformer associated with this handler, which is needed in order to set parameters and output properties.
abstract void	setResult(Result result) Set the Result associated with this TransformerHandler to be used for the transformation.
abstract void	setSystemId(String systemID) Set the base ID (URI or system ID) from where relative URLs will be resolved.

Inherited Method Summary

From interface org.xml.sax.ContentHandler

abstract void	characters(char[] ch, int start, int length) Receive notification of character data.
abstract void	endDocument() Receive notification of the end of a document.
abstract void	endElement(String uri, String localName, String qName) Receive notification of the end of an element.
abstract void	endPrefixMapping(String prefix) End the scope of a prefix-URI mapping.
abstract void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
abstract void	processingInstruction(String target, String data) Receive notification of a processing instruction.
abstract void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
abstract void	skippedEntity(String name) Receive notification of a skipped entity.
abstract void	startDocument() Receive notification of the beginning of a document.
abstract void	startElement(String uri, String localName, String qName, Attributes atts) Receive notification of the beginning of an element.
abstract void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.

From interface org.xml.sax.ext.LexicalHandler

abstract void	comment(char[] ch, int start, int length) Report an XML comment anywhere in the document.
abstract void	endCDATA() Report the end of a CDATA section.
abstract void	endDTD() Report the end of DTD declarations.
abstract void	endEntity(String name) Report the end of an entity.
abstract void	startCDATA() Report the start of a CDATA section.
abstract void	startDTD(String name, String publicId, String systemId) Report the start of DTD declarations, if any.
abstract void	startEntity(String name) Report the beginning of some internal and external XML entities.

From interface org.xml.sax.DTDHandler

abstract void	notationDecl(String name, String publicId, String systemId) Receive notification of a notation declaration event.
abstract void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName) Receive notification of an unparsed entity declaration event.

Public Methods

public abstract String getSystemId ()

Get the base ID (URI or system ID) from where relative URLs will be resolved.

Returns

• The systemID that was set with setSystemId(String).

public abstract Transformer getTransformer ()

Get the Transformer associated with this handler, which is needed in order to set parameters and output properties.

Returns

• Transformer associated with this TransformerHandler.

public abstract void setResult (Result result)

Set the Result associated with this TransformerHandler to be used for the transformation.

Parameters

result	A Result instance, should not be null.

Throws

IllegalArgumentException	if result is invalid for some reason.

public abstract void setSystemId (String systemID)

Set the base ID (URI or system ID) from where relative URLs will be resolved.

Parameters

systemID	Base URI for the source tree.