public class TransformerIdentityImpl extends Transformer implements TransformerHandler, DeclHandler
SAXTransformerFactory.newTransformerHandler()
and 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 and Description |
---|
TransformerIdentityImpl()
Constructor TransformerIdentityImpl creates an identity transform.
|
TransformerIdentityImpl(boolean isSecureProcessing)
Constructor TransformerIdentityImpl creates an identity transform.
|
Modifier and Type | Method and Description |
---|---|
void |
attributeDecl(String eName,
String aName,
String type,
String valueDefault,
String value)
Report an attribute type declaration.
|
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data inside an element.
|
void |
clearParameters()
Clear all parameters set with setParameter.
|
void |
comment(char[] ch,
int start,
int length)
Report an XML comment anywhere in the document.
|
void |
elementDecl(String name,
String model)
Report an element type declaration.
|
void |
endCDATA()
Report the end of a CDATA section.
|
void |
endDocument()
Receive notification of the end of the document.
|
void |
endDTD()
Report the end of DTD declarations.
|
void |
endElement(String uri,
String localName,
String qName)
Receive notification of the end of an element.
|
void |
endEntity(String name)
Report the end of an entity.
|
void |
endPrefixMapping(String prefix)
Receive notification of the end of a Namespace mapping.
|
void |
externalEntityDecl(String name,
String publicId,
String systemId)
Report a parsed external entity declaration.
|
protected void |
flushStartDoc() |
ErrorListener |
getErrorListener()
Get the error event handler in effect for the transformation.
|
Properties |
getOutputProperties()
Get a copy of the output properties for the transformation.
|
String |
getOutputProperty(String name)
Get an output property that is in effect for the
transformation.
|
Object |
getParameter(String name)
Get a parameter that was explicitly set with setParameter
or setParameters.
|
String |
getSystemId()
Get the base ID (URI or system ID) from where relative
URLs will be resolved.
|
Transformer |
getTransformer()
Get the Transformer associated with this handler, which
is needed in order to set parameters and output properties.
|
URIResolver |
getURIResolver()
Get an object that will be used to resolve URIs used in
document(), etc.
|
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content.
|
void |
internalEntityDecl(String name,
String value)
Report an internal entity declaration.
|
void |
notationDecl(String name,
String publicId,
String systemId)
Receive notification of a notation declaration.
|
void |
processingInstruction(String target,
String data)
Receive notification of a processing instruction.
|
void |
reset()
Reset the status of the transformer.
|
void |
setDocumentLocator(Locator locator)
Receive a Locator object for document events.
|
void |
setErrorListener(ErrorListener listener)
Set the error event listener in effect for the transformation.
|
void |
setOutputProperties(Properties oformat)
Set the output properties for the transformation.
|
void |
setOutputProperty(String name,
String value)
Set an output property that will be in effect for the
transformation.
|
void |
setParameter(String name,
Object value)
Add a parameter for the transformation.
|
void |
setResult(Result result)
Enables the user of the TransformerHandler to set the
to set the Result for the transformation.
|
void |
setSystemId(String systemID)
Set the base ID (URI or system ID) from where relative
URLs will be resolved.
|
void |
setURIResolver(URIResolver resolver)
Set an object that will be used to resolve URIs used in
document().
|
void |
skippedEntity(String name)
Receive notification of a skipped entity.
|
void |
startCDATA()
Report the start of a CDATA section.
|
void |
startDocument()
Receive notification of the beginning of the document.
|
void |
startDTD(String name,
String publicId,
String systemId)
Report the start of DTD declarations, if any.
|
void |
startElement(String uri,
String localName,
String qName,
Attributes attributes)
Receive notification of the start of an element.
|
void |
startEntity(String name)
Report the beginning of an entity in content.
|
void |
startPrefixMapping(String prefix,
String uri)
Receive notification of the start of a Namespace mapping.
|
void |
transform(Source source,
Result outputTarget)
Process the source tree to the output result.
|
void |
unparsedEntityDecl(String name,
String publicId,
String systemId,
String notationName)
Receive notification of an unparsed entity declaration.
|
public TransformerIdentityImpl(boolean isSecureProcessing)
public TransformerIdentityImpl()
public void setResult(Result result) throws IllegalArgumentException
setResult
in interface TransformerHandler
result
- A Result instance, should not be null.IllegalArgumentException
- if result is invalid for some reason.public void setSystemId(String systemID)
setSystemId
in interface TransformerHandler
systemID
- Base URI for the source tree.public String getSystemId()
getSystemId
in interface TransformerHandler
setSystemId(java.lang.String)
.public Transformer getTransformer()
getTransformer
in interface TransformerHandler
public void reset()
reset
in class Transformer
public void transform(Source source, Result outputTarget) throws TransformerException
transform
in class Transformer
source
- The input for the source tree.outputTarget
- The output target.TransformerException
- If an unrecoverable error occurs
during the course of the transformation.public void setParameter(String name, Object value)
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.
setParameter
in class Transformer
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.public Object getParameter(String name)
This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.
getParameter
in class Transformer
name
- Name of the parameter.public void clearParameters()
clearParameters
in class Transformer
public void setURIResolver(URIResolver resolver)
If the resolver argument is null, the URIResolver value will be cleared, and the default behavior will be used.
setURIResolver
in class Transformer
resolver
- An object that implements the URIResolver interface,
or null.public URIResolver getURIResolver()
getURIResolver
in class Transformer
public void setOutputProperties(Properties oformat) throws IllegalArgumentException
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.
setOutputProperties
in class Transformer
oformat
- A set of output properties that will be
used to override any of the same properties in affect
for the transformation.IllegalArgumentException
- if any of the argument keys are not
recognized and are not namespace qualified.OutputKeys
,
Properties
public Properties getOutputProperties()
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 setOutputProperty(java.lang.String, java.lang.String)
,
setOutputProperties(java.util.Properties)
, in the stylesheet, or the default
properties, while
getOutputProperties().get(String key) will only retrieve properties
that were explicitly set by setOutputProperty(java.lang.String, java.lang.String)
,
setOutputProperties(java.util.Properties)
, 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.
getOutputProperties
in class Transformer
OutputKeys
,
Properties
public void setOutputProperty(String name, String value) throws IllegalArgumentException
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 setOutputProperties(java.util.Properties)
won't
be effected by calling this method.
setOutputProperty
in class Transformer
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.IllegalArgumentException
- If the property is not supported, and is
not qualified with a namespace.OutputKeys
public String getOutputProperty(String name) throws IllegalArgumentException
getOutputProperty
in class Transformer
name
- A non-null String that specifies an output
property name, which may be namespace qualified.IllegalArgumentException
- If the property is not supported.OutputKeys
public void setErrorListener(ErrorListener listener) throws IllegalArgumentException
setErrorListener
in class Transformer
listener
- The new error listener.IllegalArgumentException
- if listener is null.public ErrorListener getErrorListener()
getErrorListener
in class Transformer
public void notationDecl(String name, String publicId, String systemId) throws SAXException
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.
notationDecl
in interface DTDHandler
name
- The notation name.publicId
- The notation public identifier, or null if not
available.systemId
- The notation system identifier.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException
By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.
unparsedEntityDecl
in interface DTDHandler
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.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void setDocumentLocator(Locator locator)
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.
setDocumentLocator
in interface ContentHandler
locator
- A locator for all SAX document events.ContentHandler.setDocumentLocator(org.xml.sax.Locator)
,
Locator
public void startDocument() throws SAXException
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).
startDocument
in interface ContentHandler
SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.startDocument()
protected final void flushStartDoc() throws SAXException
SAXException
public void endDocument() throws SAXException
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).
endDocument
in interface ContentHandler
SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.endDocument()
public void startPrefixMapping(String prefix, String uri) throws SAXException
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).
startPrefixMapping
in interface ContentHandler
prefix
- The Namespace prefix being declared.uri
- The Namespace URI mapped to the prefix.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
public void endPrefixMapping(String prefix) throws SAXException
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.
endPrefixMapping
in interface ContentHandler
prefix
- The Namespace prefix being declared.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.endPrefixMapping(java.lang.String)
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
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).
startElement
in interface ContentHandler
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.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endElement(String uri, String localName, String qName) throws SAXException
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).
endElement
in interface ContentHandler
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.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
public void characters(char[] ch, int start, int length) throws SAXException
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).
characters
in interface ContentHandler
ch
- The characters.start
- The start position in the character array.length
- The number of characters to use from the
character array.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.characters(char[], int, int)
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
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).
ignorableWhitespace
in interface ContentHandler
ch
- The whitespace characters.start
- The start position in the character array.length
- The number of characters to use from the
character array.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.ignorableWhitespace(char[], int, int)
public void processingInstruction(String target, String data) throws SAXException
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.
processingInstruction
in interface ContentHandler
target
- The processing instruction target.data
- The processing instruction data, or null if
none is supplied.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.processingInstruction(java.lang.String, java.lang.String)
public void skippedEntity(String name) throws SAXException
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.
skippedEntity
in interface ContentHandler
name
- The name of the skipped entity.SAXException
- Any SAX exception, possibly
wrapping another exception.SAXException
ContentHandler.processingInstruction(java.lang.String, java.lang.String)
public void startDTD(String name, String publicId, String systemId) throws SAXException
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.
startDTD
in interface LexicalHandler
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.SAXException
- The application may raise an
exception.endDTD()
,
startEntity(java.lang.String)
public void endDTD() throws SAXException
endDTD
in interface LexicalHandler
SAXException
- The application may raise an exception.startDTD(java.lang.String, java.lang.String, java.lang.String)
public void startEntity(String name) throws SAXException
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
skippedEntity
event, which is part of the ContentHandler interface.
startEntity
in interface LexicalHandler
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.SAXException
- The application may raise an exception.endEntity(java.lang.String)
,
DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)
,
DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
public void endEntity(String name) throws SAXException
endEntity
in interface LexicalHandler
name
- The name of the entity that is ending.SAXException
- The application may raise an exception.startEntity(java.lang.String)
public void startCDATA() throws SAXException
The contents of the CDATA section will be reported through
the regular characters
event.
startCDATA
in interface LexicalHandler
SAXException
- The application may raise an exception.endCDATA()
public void endCDATA() throws SAXException
endCDATA
in interface LexicalHandler
SAXException
- The application may raise an exception.startCDATA()
public void comment(char[] ch, int start, int length) throws SAXException
This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).
comment
in interface LexicalHandler
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.SAXException
- The application may raise an exception.public void elementDecl(String name, String model) throws SAXException
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.
elementDecl
in interface DeclHandler
name
- The element type name.model
- The content model as a normalized string.SAXException
- The application may raise an exception.public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException
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.
attributeDecl
in interface DeclHandler
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.SAXException
- The application may raise an exception.public void internalEntityDecl(String name, String value) throws SAXException
Only the effective (first) declaration for each entity will be reported.
internalEntityDecl
in interface DeclHandler
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.value
- The replacement text of the entity.SAXException
- The application may raise an exception.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException
Only the effective (first) declaration for each entity will be reported.
externalEntityDecl
in interface DeclHandler
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.SAXException
- The application may raise an exception.internalEntityDecl(java.lang.String, java.lang.String)
,
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
Copyright © 2021 JBoss by Red Hat. All rights reserved.