org.apache.xalan.transformer

Class TransformerIdentityImpl

public class TransformerIdentityImpl extends Transformer implements TransformerHandler, DeclHandler

This class implements an identity transformer for javax.xml.transform.sax.SAXTransformerFactory#newTransformerHandler() and javax.xml.transform.TransformerFactory#newTransformer(). It simply feeds SAX events directly to a serializer ContentHandler, if the result is a stream. If the result is a DOM, it will send the events to DOMBuilder. If the result is another content handler, it will simply pass the events on.
Constructor Summary
TransformerIdentityImpl(boolean isSecureProcessing)
Constructor TransformerIdentityImpl creates an identity transform.
TransformerIdentityImpl()
Constructor TransformerIdentityImpl creates an identity transform.
Method Summary
voidattributeDecl(String eName, String aName, String type, String valueDefault, String value)
Report an attribute type declaration.
voidcharacters(char[] ch, int start, int length)
Receive notification of character data inside an element.
voidclearParameters()
Clear all parameters set with setParameter.
voidcomment(char[] ch, int start, int length)
Report an XML comment anywhere in the document.
voidelementDecl(String name, String model)
Report an element type declaration.
voidendCDATA()
Report the end of a CDATA section.
voidendDocument()
Receive notification of the end of the document.
voidendDTD()
Report the end of DTD declarations.
voidendElement(String uri, String localName, String qName)
Receive notification of the end of an element.
voidendEntity(String name)
Report the end of an entity.
voidendPrefixMapping(String prefix)
Receive notification of the end of a Namespace mapping.
voidexternalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.
ErrorListenergetErrorListener()
Get the error event handler in effect for the transformation.
PropertiesgetOutputProperties()
Get a copy of the output properties for the transformation.
StringgetOutputProperty(String name)
Get an output property that is in effect for the transformation.
ObjectgetParameter(String name)
Get a parameter that was explicitly set with setParameter or setParameters.
StringgetSystemId()
Get the base ID (URI or system ID) from where relative URLs will be resolved.
TransformergetTransformer()
Get the Transformer associated with this handler, which is needed in order to set parameters and output properties.
URIResolvergetURIResolver()
Get an object that will be used to resolve URIs used in document(), etc.
voidignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content.
voidinternalEntityDecl(String name, String value)
Report an internal entity declaration.
voidnotationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration.
voidprocessingInstruction(String target, String data)
Receive notification of a processing instruction.
voidreset()
Reset the status of the transformer.
voidsetDocumentLocator(Locator locator)
Receive a Locator object for document events.
voidsetErrorListener(ErrorListener listener)
Set the error event listener in effect for the transformation.
voidsetOutputProperties(Properties oformat)
Set the output properties for the transformation.
voidsetOutputProperty(String name, String value)
Set an output property that will be in effect for the transformation.
voidsetParameter(String name, Object value)
Add a parameter for the transformation.
voidsetResult(Result result)
Enables the user of the TransformerHandler to set the to set the Result for the transformation.
voidsetSystemId(String systemID)
Set the base ID (URI or system ID) from where relative URLs will be resolved.
voidsetURIResolver(URIResolver resolver)
Set an object that will be used to resolve URIs used in document().
voidskippedEntity(String name)
Receive notification of a skipped entity.
voidstartCDATA()
Report the start of a CDATA section.
voidstartDocument()
Receive notification of the beginning of the document.
voidstartDTD(String name, String publicId, String systemId)
Report the start of DTD declarations, if any.
voidstartElement(String uri, String localName, String qName, Attributes attributes)
Receive notification of the start of an element.
voidstartEntity(String name)
Report the beginning of an entity in content.
voidstartPrefixMapping(String prefix, String uri)
Receive notification of the start of a Namespace mapping.
voidtransform(Source source, Result outputTarget)
Process the source tree to the output result.
voidunparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.

Constructor Detail

TransformerIdentityImpl

public TransformerIdentityImpl(boolean isSecureProcessing)
Constructor TransformerIdentityImpl creates an identity transform.

TransformerIdentityImpl

public TransformerIdentityImpl()
Constructor TransformerIdentityImpl creates an identity transform.

Method Detail

attributeDecl

public void attributeDecl(String eName, String aName, String type, String valueDefault, String value)
Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION", or a parenthesized token group with the separator "|" and all whitespace removed.

Parameters: eName The name of the associated element. aName The name of the attribute. type A string representing the attribute type. valueDefault A string representing the attribute default ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies. value A string representing the attribute's default value, or null if there is none.

Throws: SAXException The application may raise an exception.

characters

public void characters(char[] ch, int start, int length)
Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

Parameters: ch The characters. start The start position in the character array. length The number of characters to use from the character array.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#characters

clearParameters

public void clearParameters()
Clear all parameters set with setParameter.

comment

public void comment(char[] ch, int start, int length)
Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).

Parameters: ch An array holding the characters in the comment. start The starting position in the array. length The number of characters to use from the array.

Throws: SAXException The application may raise an exception.

elementDecl

public void elementDecl(String name, String model)
Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all whitespace is removed,and will include the enclosing parentheses.

Parameters: name The element type name. model The content model as a normalized string.

Throws: SAXException The application may raise an exception.

endCDATA

public void endCDATA()
Report the end of a CDATA section.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl

endDocument

public void endDocument()
Receive notification of the end of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#endDocument

endDTD

public void endDTD()
Report the end of DTD declarations.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl

endElement

public void endElement(String uri, String localName, String qName)
Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

Parameters: uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. localName The local name (without prefix), or the empty string if Namespace processing is not being performed. qName The qualified name (with prefix), or the empty string if qualified names are not available.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#endElement

endEntity

public void endEntity(String name)
Report the end of an entity.

Parameters: name The name of the entity that is ending.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl

endPrefixMapping

public void endPrefixMapping(String prefix)
Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.

Parameters: prefix The Namespace prefix being declared.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#endPrefixMapping

externalEntityDecl

public void externalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

Parameters: name The name of the entity. If it is a parameter entity, the name will begin with '%'. publicId The declared public identifier of the entity, or null if none was declared. systemId The declared system identifier of the entity.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl org.xml.sax.DTDHandler#unparsedEntityDecl

getErrorListener

public ErrorListener getErrorListener()
Get the error event handler in effect for the transformation.

Returns: The current error handler, which should never be null.

getOutputProperties

public Properties getOutputProperties()
Get a copy of the output properties for the transformation.

The properties returned should contain properties set by the user, and properties set by the stylesheet, and these properties are "defaulted" by default properties specified by section 16 of the XSL Transformations (XSLT) W3C Recommendation. The properties that were specifically set by the user or the stylesheet should be in the base Properties list, while the XSLT default properties that were not specifically set should be the default Properties list. Thus, getOutputProperties().getProperty(String key) will obtain any property in that was set by TransformerIdentityImpl, TransformerIdentityImpl, in the stylesheet, or the default properties, while getOutputProperties().get(String key) will only retrieve properties that were explicitly set by TransformerIdentityImpl, TransformerIdentityImpl, or in the stylesheet.

Note that mutation of the Properties object returned will not effect the properties that the transformation contains.

If any of the argument keys are not recognized and are not namespace qualified, the property will be ignored. In other words the behaviour is not orthogonal with setOutputProperties.

Returns: A copy of the set of output properties in effect for the next transformation.

See Also: javax.xml.transform.OutputKeys java.util.Properties

getOutputProperty

public String getOutputProperty(String name)
Get an output property that is in effect for the transformation. The property specified may be a property that was set with setOutputProperty, or it may be a property specified in the stylesheet.

Parameters: name A non-null String that specifies an output property name, which may be namespace qualified.

Returns: The string value of the output property, or null if no property was found.

Throws: IllegalArgumentException If the property is not supported.

See Also: javax.xml.transform.OutputKeys

getParameter

public Object getParameter(String name)
Get a parameter that was explicitly set with setParameter or setParameters.

This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.

Parameters: name Name of the parameter.

Returns: A parameter that has been set with setParameter.

getSystemId

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

Returns: The systemID that was set with TransformerIdentityImpl.

getTransformer

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

Returns: non-null reference to the transformer.

getURIResolver

public URIResolver getURIResolver()
Get an object that will be used to resolve URIs used in document(), etc.

Returns: An object that implements the URIResolver interface, or null.

ignorableWhitespace

public void ignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).

Parameters: ch The whitespace characters. start The start position in the character array. length The number of characters to use from the character array.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#ignorableWhitespace

internalEntityDecl

public void internalEntityDecl(String name, String value)
Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported.

Parameters: name The name of the entity. If it is a parameter entity, the name will begin with '%'. value The replacement text of the entity.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl org.xml.sax.DTDHandler#unparsedEntityDecl

notationDecl

public void notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration.

By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.

Parameters: name The notation name. publicId The notation public identifier, or null if not available. systemId The notation system identifier.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.DTDHandler#notationDecl

processingInstruction

public void processingInstruction(String target, String data)
Receive notification of a processing instruction.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Parameters: target The processing instruction target. data The processing instruction data, or null if none is supplied.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#processingInstruction

reset

public void reset()
Reset the status of the transformer.

setDocumentLocator

public void setDocumentLocator(Locator locator)
Receive a Locator object for document events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.

Parameters: locator A locator for all SAX document events.

See Also: org.xml.sax.ContentHandler#setDocumentLocator org.xml.sax.Locator

setErrorListener

public void setErrorListener(ErrorListener listener)
Set the error event listener in effect for the transformation.

Parameters: listener The new error listener.

Throws: IllegalArgumentException if listener is null.

setOutputProperties

public void setOutputProperties(Properties oformat)
Set the output properties for the transformation. These properties will override properties set in the Templates with xsl:output.

If argument to this function is null, any properties previously set are removed, and the value will revert to the value defined in the templates object.

Pass a qualified property key name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.

For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.

Parameters: oformat A set of output properties that will be used to override any of the same properties in affect for the transformation.

Throws: IllegalArgumentException if any of the argument keys are not recognized and are not namespace qualified.

See Also: javax.xml.transform.OutputKeys java.util.Properties

setOutputProperty

public void setOutputProperty(String name, String value)
Set an output property that will be in effect for the transformation.

Pass a qualified property name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.

For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.

The Properties object that was passed to TransformerIdentityImpl won't be effected by calling this method.

Parameters: name A non-null String that specifies an output property name, which may be namespace qualified. value The non-null string value of the output property.

Throws: IllegalArgumentException If the property is not supported, and is not qualified with a namespace.

See Also: javax.xml.transform.OutputKeys

setParameter

public void setParameter(String name, Object value)
Add a parameter for the transformation.

Pass a qualified name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.

For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.

Parameters: name The name of the parameter, which may begin with a namespace URI in curly braces ({}). value The value object. This can be any valid Java object. It is up to the processor to provide the proper object coersion or to simply pass the object on for use in an extension.

setResult

public void setResult(Result result)
Enables the user of the TransformerHandler to set the to set the Result for the transformation.

Parameters: result A Result instance, should not be null.

Throws: IllegalArgumentException if result is invalid for some reason.

setSystemId

public 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.

setURIResolver

public void setURIResolver(URIResolver resolver)
Set an object that will be used to resolve URIs used in document().

If the resolver argument is null, the URIResolver value will be cleared, and the default behavior will be used.

Parameters: resolver An object that implements the URIResolver interface, or null.

skippedEntity

public void skippedEntity(String name)
Receive notification of a skipped entity.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Parameters: name The name of the skipped entity.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#processingInstruction

startCDATA

public void startCDATA()
Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular org.xml.sax.ContentHandler#characters characters event.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl

startDocument

public void startDocument()
Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#startDocument

startDTD

public void startDTD(String name, String publicId, String systemId)
Report the start of DTD declarations, if any.

Any declarations are assumed to be in the internal subset unless otherwise indicated by a startEntity event.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement event.

Parameters: name The document type name. publicId The declared public identifier for the external DTD subset, or null if none was declared. systemId The declared system identifier for the external DTD subset, or null if none was declared.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl TransformerIdentityImpl

startElement

public void startElement(String uri, String localName, String qName, Attributes attributes)
Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Parameters: uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. localName The local name (without prefix), or the empty string if Namespace processing is not being performed. qName The qualified name (with prefix), or the empty string if qualified names are not available. attributes The specified or defaulted attributes.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#startElement

startEntity

public void startEntity(String name)
Report the beginning of an entity in content.

NOTE: entity references in attribute values -- and the start and end of the document entity -- are never reported.

The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.

Note that skipped entities will be reported through the org.xml.sax.ContentHandler#skippedEntity skippedEntity event, which is part of the ContentHandler interface.

Parameters: name The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws: SAXException The application may raise an exception.

See Also: TransformerIdentityImpl org.xml.sax.ext.DeclHandler#internalEntityDecl org.xml.sax.ext.DeclHandler#externalEntityDecl

startPrefixMapping

public void startPrefixMapping(String prefix, String uri)
Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).

Parameters: prefix The Namespace prefix being declared. uri The Namespace URI mapped to the prefix.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.ContentHandler#startPrefixMapping

transform

public void transform(Source source, Result outputTarget)
Process the source tree to the output result.

Parameters: source The input for the source tree. outputTarget The output target.

Throws: TransformerException If an unrecoverable error occurs during the course of the transformation.

unparsedEntityDecl

public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.

By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.

Parameters: name The entity name. publicId The entity public identifier, or null if not available. systemId The entity system identifier. notationName The name of the associated notation.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. SAXException

See Also: org.xml.sax.DTDHandler#unparsedEntityDecl

Copyright B) 2006 Apache XML Project. All Rights Reserved.