org.apache.xalan.templates

Class ElemLiteralResult

Implemented Interfaces:
Document, Element, ExpressionNode, Node, NodeList, PrefixResolver, Serializable, SourceLocator, WhitespaceStrippingElementMatcher, XSLTVisitable
Known Direct Subclasses:
ElemExtensionCall, ElemUnknown

public class ElemLiteralResult
extends ElemUse

Implement a Literal Result Element.
See Also:
literal-result-element in XSLT Specification

Nested Class Summary

class
ElemLiteralResult.Attribute
class
ElemLiteralResult.LiteralElementAttributes

Method Summary

void
addLiteralResultAttribute(String att)
Set a literal result attribute (used for xsl attributes).
void
addLiteralResultAttribute(AVT avt)
Set a literal result attribute (AVTs only).
void
compose(StylesheetRoot sroot)
This function is called after everything else has been recomposed, and allows the template to set remaining values that may be based on some other property that depends on recomposition.
boolean
containsExcludeResultPrefix(String prefix, String uri)
Get whether or not the passed URL is flagged by the "extension-element-prefixes" or "exclude-result-prefixes" properties.
boolean
containsExtensionElementURI(String uri)
Find out if the given "extension-element-prefix" property is defined.
Iterator
enumerateLiteralResultAttributes()
Compiling templates requires that we be able to list the AVTs ADDED 9/5/2000 to support compilation experiment
void
execute(TransformerImpl transformer)
Copy a Literal Result Element into the Result tree, copy the non-excluded namespace attributes, copy the attributes not of the XSLT namespace, and execute the children of the LRE.
String
getAttribute(String rawName)
Return the raw value of the attribute.
String
getAttributeNS(String namespaceURI, String localName)
Return the raw value of the attribute.
NamedNodeMap
getAttributes()
String
getExtensionElementPrefix(int i)
Get an "extension-element-prefix" property.
int
getExtensionElementPrefixCount()
Get the number of "extension-element-prefixes" Strings.
boolean
getIsLiteralResultAsStylesheet()
Return whether this element represents a root element that is also the stylesheet element.
AVT
getLiteralResultAttribute(String name)
Get a literal result attribute by name.
AVT
getLiteralResultAttributeNS(String namespaceURI, String localName)
Get a literal result attribute by name.
String
getLocalName()
Get the local name of the Literal Result Element.
String
getNamespace()
Get the original namespace of the Literal Result Element.
String
getNodeName()
Return the node name.
String
getPrefix()
Get the prefix part of the raw name of the Literal Result Element.
String
getRawName()
Get the raw name of the Literal Result Element.
String
getVersion()
Get the "version" property.
int
getXSLToken()
Get an int constant identifying the type of element.
void
resolvePrefixTables()
Augment resolvePrefixTables, resolving the namespace aliases once the superclass has resolved the tables.
void
setExcludeResultPrefixes(StringVector v)
Set the "exclude-result-prefixes" property.
void
setExtensionElementPrefixes(StringVector v)
Set the "extension-element-prefixes" property.
void
setIsLiteralResultAsStylesheet(boolean b)
Set whether this element represents a root element that is also the stylesheet element.
void
setLocalName(String localName)
Set the local name of the LRE.
void
setNamespace(String ns)
Set the namespace URI of the result element to be created.
void
setRawName(String rawName)
Set the raw name of the LRE.
void
setVersion(String v)
Set the "version" property.
void
setXmlSpace(AVT avt)
Set the "xml:space" attribute.
void
throwDOMException(short code, String msg)
Throw a DOMException

Methods inherited from class org.apache.xalan.templates.ElemUse

applyAttrSets, execute, getUseAttributeSets, setUseAttributeSets, setUseAttributeSets

Methods inherited from class org.apache.xalan.templates.ElemTemplateElement

appendChild, appendChild, callVisitors, canAcceptVariables, canStripWhiteSpace, compareTo, compose, containsExcludeResultPrefix, endCompose, error, error, execute, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getBaseIdentifier, getChildNodes, getColumnNumber, getDOMBackPointer, getDeclaredPrefixes, getEndColumnNumber, getEndLineNumber, getFirstChild, getFirstChildElem, getLastChild, getLastChildElem, getLength, getLineNumber, getLocalName, getNamespaceForPrefix, getNamespaceForPrefix, getNextSibling, getNextSiblingElem, getNodeName, getNodeType, getOwnerDocument, getOwnerXSLTemplate, getParentElem, getParentNode, getParentNodeElem, getPreviousSibling, getPreviousSiblingElem, getPublicId, getStylesheet, getStylesheetComposed, getStylesheetRoot, getSystemId, getTagName, getUid, getXSLToken, getXmlSpace, handlesNullPrefixes, hasChildNodes, hasTextLitOnly, hasVariableDecl, insertBefore, isCompiledTemplate, item, recompose, removeChild, replaceChild, replaceChild, resolvePrefixTables, runtimeInit, setDOMBackPointer, setEndLocaterInfo, setLocaterInfo, setParentElem, setPrefixes, setPrefixes, setUid, setXmlSpace, shouldStripWhiteSpace

Methods inherited from class org.apache.xml.utils.UnImplNode

adoptNode, appendChild, appendData, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, error, error, getActualEncoding, getAttribute, getAttributeNS, getAttributeNode, getAttributeNodeNS, getAttributes, getBaseURI, getChildNodes, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getFirstChild, getImplementation, getInputEncoding, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerElement, getParentNode, getPrefix, getPreviousSibling, getSchemaTypeInfo, getSpecified, getStrictErrorChecking, getTagName, getTextContent, getUserData, getWholeText, getXmlEncoding, getXmlStandalone, getXmlVersion, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importNode, insertBefore, insertData, isDefaultNamespace, isEqualNode, isId, isSameNode, isSupported, isWhitespaceInElementContent, item, lookupNamespaceURI, lookupPrefix, normalize, normalizeDocument, removeAttribute, removeAttributeNS, removeAttributeNode, removeChild, renameNode, replaceChild, replaceData, replaceWholeText, setActualEncoding, setAttribute, setAttributeNS, setAttributeNode, setAttributeNodeNS, setData, setDocumentURI, setIdAttribute, setIdAttribute, setIdAttributeNS, setIdAttributeNode, setInputEncoding, setNodeValue, setPrefix, setStrictErrorChecking, setTextContent, setUserData, setValue, setXmlEncoding, setXmlStandalone, setXmlVersion, splitText, substringData

Method Details

addLiteralResultAttribute

public void addLiteralResultAttribute(String att)
Set a literal result attribute (used for xsl attributes).
Parameters:
att - literal result attribute to add

addLiteralResultAttribute

public void addLiteralResultAttribute(AVT avt)
Set a literal result attribute (AVTs only).
Parameters:
avt - literal result attribute to add (AVT only)

compose

public void compose(StylesheetRoot sroot)
            throws TransformerException
This function is called after everything else has been recomposed, and allows the template to set remaining values that may be based on some other property that depends on recomposition.
Overrides:
compose in interface ElemTemplateElement

containsExcludeResultPrefix

public boolean containsExcludeResultPrefix(String prefix,
                                           String uri)
Get whether or not the passed URL is flagged by the "extension-element-prefixes" or "exclude-result-prefixes" properties.
Overrides:
containsExcludeResultPrefix in interface ElemTemplateElement
Parameters:
prefix - non-null reference to prefix that might be excluded.(not currently used)
uri - reference to namespace that prefix maps to
Returns:
true if the prefix should normally be excluded.

containsExtensionElementURI

public boolean containsExtensionElementURI(String uri)
Find out if the given "extension-element-prefix" property is defined.
Parameters:
uri - The URI to find
Returns:
True if the given URI is found

enumerateLiteralResultAttributes

public Iterator enumerateLiteralResultAttributes()
Compiling templates requires that we be able to list the AVTs ADDED 9/5/2000 to support compilation experiment
Returns:
an Enumeration of the literal result attributes associated with this element.

execute

public void execute(TransformerImpl transformer)
            throws TransformerException
Copy a Literal Result Element into the Result tree, copy the non-excluded namespace attributes, copy the attributes not of the XSLT namespace, and execute the children of the LRE.
Overrides:
execute in interface ElemUse
Parameters:
transformer - non-null reference to the the current transform-time state.

getAttribute

public String getAttribute(String rawName)
Return the raw value of the attribute.
Overrides:
getAttribute in interface UnImplNode
Parameters:
Returns:
The Attr value as a string, or the empty string if that attribute does not have a specified or default value

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)
Return the raw value of the attribute.
Overrides:
getAttributeNS in interface UnImplNode
Parameters:
namespaceURI - Namespace URI of attribute node to get
localName - Local part of qualified name of attribute node to get
Returns:
The Attr value as a string, or the empty string if that attribute does not have a specified or default value

getAttributes

public NamedNodeMap getAttributes()
Overrides:
getAttributes in interface UnImplNode
Returns:
NamedNodeMap
See Also:
org.w3c.dom.Node

getExtensionElementPrefix

public String getExtensionElementPrefix(int i)
            throws ArrayIndexOutOfBoundsException
Get an "extension-element-prefix" property.
Parameters:
i - Index of URI ("extension-element-prefix" property) to get
Returns:
URI at given index ("extension-element-prefix" property)

getExtensionElementPrefixCount

public int getExtensionElementPrefixCount()
Get the number of "extension-element-prefixes" Strings.
Returns:
the number of "extension-element-prefixes" Strings

getIsLiteralResultAsStylesheet

public boolean getIsLiteralResultAsStylesheet()
Return whether this element represents a root element that is also the stylesheet element.
Returns:
boolean flag indicating whether this element represents a root element that is also the stylesheet element.

getLiteralResultAttribute

public AVT getLiteralResultAttribute(String name)
Get a literal result attribute by name. The name is namespaceURI:localname if namespace is not null.
Parameters:
name - Name of literal result attribute to get
Returns:
literal result attribute (AVT)

getLiteralResultAttributeNS

public AVT getLiteralResultAttributeNS(String namespaceURI,
                                       String localName)
Get a literal result attribute by name.
Parameters:
namespaceURI - Namespace URI of attribute node to get
localName - Local part of qualified name of attribute node to get
Returns:
literal result attribute (AVT)

getLocalName

public String getLocalName()
Get the local name of the Literal Result Element. Note that after resolvePrefixTables has been called, this will return the aliased name prefix, not the original stylesheet namespace prefix.
Overrides:
getLocalName in interface ElemTemplateElement
Returns:
The local name (without prefix) of the result element to be created.

getNamespace

public String getNamespace()
Get the original namespace of the Literal Result Element. %REVIEW% Why isn't this overriding the getNamespaceURI method rather than introducing a new one?
Returns:
The Namespace URI, or the empty string if the element has no Namespace URI.

getNodeName

public String getNodeName()
Return the node name.
Overrides:
getNodeName in interface ElemTemplateElement
Returns:
The element's name

getPrefix

public String getPrefix()
Get the prefix part of the raw name of the Literal Result Element.
Overrides:
getPrefix in interface UnImplNode
Returns:
The prefix, or the empty string if noprefix was provided.

getRawName

public String getRawName()
Get the raw name of the Literal Result Element.
Returns:
The qualified name (with prefix), or the empty string if qualified names are not available.

getVersion

public String getVersion()
Get the "version" property.
Returns:
Version property value

getXSLToken

public int getXSLToken()
Get an int constant identifying the type of element.
Overrides:
getXSLToken in interface ElemTemplateElement
Returns:
The token ID for this element
See Also:
Constants

resolvePrefixTables

public void resolvePrefixTables()
            throws TransformerException
Augment resolvePrefixTables, resolving the namespace aliases once the superclass has resolved the tables.
Overrides:
resolvePrefixTables in interface ElemTemplateElement

setExcludeResultPrefixes

public void setExcludeResultPrefixes(StringVector v)
Set the "exclude-result-prefixes" property. The designation of a namespace as an excluded namespace is effective within the subtree of the stylesheet rooted at the element bearing the exclude-result-prefixes or xsl:exclude-result-prefixes attribute; a subtree rooted at an xsl:stylesheet element does not include any stylesheets imported or included by children of that xsl:stylesheet element.
Parameters:
v - vector of prefixes that are resolvable to strings.

setExtensionElementPrefixes

public void setExtensionElementPrefixes(StringVector v)
Set the "extension-element-prefixes" property.
Parameters:
v - Vector of URIs (not prefixes) to set as the "extension-element-prefixes" property

setIsLiteralResultAsStylesheet

public void setIsLiteralResultAsStylesheet(boolean b)
Set whether this element represents a root element that is also the stylesheet element.
Parameters:
b - boolean flag indicating whether this element represents a root element that is also the stylesheet element.

setLocalName

public void setLocalName(String localName)
Set the local name of the LRE.
Parameters:
localName - The local name (without prefix) of the result element to be created.

setNamespace

public void setNamespace(String ns)
Set the namespace URI of the result element to be created. Note that after resolvePrefixTables has been called, this will return the aliased result namespace, not the original stylesheet namespace.
Parameters:
ns - The Namespace URI, or the empty string if the element has no Namespace URI.

setRawName

public void setRawName(String rawName)
Set the raw name of the LRE.
Parameters:
rawName - The qualified name (with prefix), or the empty string if qualified names are not available.

setVersion

public void setVersion(String v)
Set the "version" property.
Parameters:
v - Version property value to set

setXmlSpace

public void setXmlSpace(AVT avt)
Set the "xml:space" attribute. A text node is preserved if an ancestor element of the text node has an xml:space attribute with a value of preserve, and no closer ancestor element has xml:space with a value of default.
Parameters:
avt - Enumerated value, either Constants.ATTRVAL_PRESERVE or Constants.ATTRVAL_STRIP.

throwDOMException

public void throwDOMException(short code,
                              String msg)
Throw a DOMException
Parameters:
msg - key of the error that occured.

Copyright © 2006 Apache XML Project. All Rights Reserved.