Package org.apache.xalan.templates
Class StylesheetRoot
- java.lang.Object
-
- org.apache.xml.utils.UnImplNode
-
- org.apache.xalan.templates.ElemTemplateElement
-
- org.apache.xalan.templates.Stylesheet
-
- org.apache.xalan.templates.StylesheetComposed
-
- org.apache.xalan.templates.StylesheetRoot
-
- All Implemented Interfaces:
java.io.Serializable
,javax.xml.transform.SourceLocator
,javax.xml.transform.Templates
,XSLTVisitable
,PrefixResolver
,ExpressionNode
,WhitespaceStrippingElementMatcher
,org.w3c.dom.Document
,org.w3c.dom.Element
,org.w3c.dom.Node
,org.w3c.dom.NodeList
public class StylesheetRoot extends StylesheetComposed implements java.io.Serializable, javax.xml.transform.Templates
This class represents the root object of the stylesheet tree.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.xalan.templates.Stylesheet
STYLESHEET_EXT
-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Constructor Summary
Constructors Constructor Description StylesheetRoot(javax.xml.transform.ErrorListener errorListener)
Uses an XSL stylesheet document.StylesheetRoot(XSLTSchema schema, javax.xml.transform.ErrorListener listener)
Creates a StylesheetRoot and retains a pointer to the schema used to create this StylesheetRoot.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canStripWhiteSpace()
Get information about whether or not whitespace can be stripped.java.util.ArrayList
getAttributeSetComposed(QName name)
Get a list "xsl:attribute-set" properties that match the qname.java.util.HashMap
getAvailableElements()
Get the hashtable of available elements.java.text.DecimalFormatSymbols
getDecimalFormatComposed(QName name)
Given a valid element decimal-format name, return the decimalFormatSymbols with that name.java.util.Properties
getDefaultOutputProps()
ElemTemplate
getDefaultRootRule()
Get the default template for a root node.ElemTemplate
getDefaultRule()
Get the default template for elements.ElemTemplate
getDefaultTextRule()
Get the default template for text.java.lang.String
getExtensionHandlerClass()
ExtensionNamespacesManager
getExtensionNamespacesManager()
Only instantiate an ExtensionNamespacesManager if one is called for (i.e., if the stylesheet contains extension functions and/or elements).java.util.Vector
getExtensions()
Get the vector of extension namespaces.StylesheetComposed
getGlobalImport(int i)
Get a stylesheet from the global import list.int
getGlobalImportCount()
Get the total number of imports in the global import list.int
getImportNumber(StylesheetComposed sheet)
Given a stylesheet, return the number of the stylesheet in the global import list.boolean
getIncremental()
java.util.Vector
getKeysComposed()
Get the composed "xsl:key" properties.NamespaceAlias
getNamespaceAliasComposed(java.lang.String uri)
Get the "xsl:namespace-alias" property.boolean
getOptimizer()
OutputProperties
getOutputComposed()
Get the combined "xsl:output" property with the properties combined from the included stylesheets.java.util.Properties
getOutputProperties()
Get the static properties for xsl:output.boolean
getSource_location()
ElemTemplate
getStartRule()
Get the default template for a root node.ElemTemplate
getTemplateComposed(QName qname)
Get an "xsl:template" property.ElemTemplate
getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm)
Get an "xsl:template" property by node match.ElemTemplate
getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, int maxImportLevel, int endImportLevel, boolean quietConflictWarnings, DTM dtm)
Get an "xsl:template" property by node match.TemplateList
getTemplateListComposed()
Accessor method to retrieve theTemplateList
associated with this StylesheetRoot.ElemVariable
getVariableOrParamComposed(QName qname)
Get an "xsl:variable" property.java.util.Vector
getVariablesAndParamsComposed()
Get all global "xsl:variable" properties in scope for this stylesheet.WhiteSpaceInfo
getWhiteSpaceInfo(XPathContext support, int targetElement, DTM dtm)
Get information about whether or not an element should strip whitespace.boolean
isOutputMethodSet()
Find out if an output method has been set by the user.boolean
isRoot()
Tell if this is the root of the stylesheet tree.boolean
isSecureProcessing()
Return the state of the secure processing feature.javax.xml.transform.Transformer
newTransformer()
Create a new transformation context for this Templates object.void
recompose()
Recompose the values of all "composed" properties, meaning properties that need to be combined or calculated from the combination of imported and included stylesheets.java.lang.String
setExtensionHandlerClass(java.lang.String handlerClassName)
This internal method allows the setting of the java class to handle the extension function (if other than the default one).void
setIncremental(boolean b)
void
setOptimizer(boolean b)
void
setSecureProcessing(boolean flag)
Set the state of the secure processing feature.void
setSource_location(boolean b)
void
setTemplateListComposed(TemplateList templateList)
Mutator method to set theTemplateList
associated with this StylesheetRoot.boolean
shouldCheckWhitespace()
Check to see if the caller should bother with check for whitespace nodes.boolean
shouldStripWhiteSpace(XPathContext support, int targetElement)
Get information about whether or not an element should strip whitespace.-
Methods inherited from class org.apache.xalan.templates.StylesheetComposed
getEndImportCountComposed, getImportComposed, getImportCountComposed, getIncludeComposed, getIncludeCountComposed, isAggregatedType, recompose, recomposeTemplates
-
Methods inherited from class org.apache.xalan.templates.Stylesheet
containsExcludeResultPrefix, containsExtensionElementURI, getAttributeSet, getAttributeSetCount, getCompatibleMode, getDecimalFormat, getDecimalFormat, getDecimalFormatCount, getExcludeResultPrefix, getExcludeResultPrefixCount, getExtensionElementPrefix, getExtensionElementPrefixCount, getHref, getId, getImport, getImportCount, getInclude, getIncludeCount, getKey, getKeyCount, getNamespaceAlias, getNamespaceAliasCount, getNodeName, getNodeType, getNonXslTopLevel, getOutput, getOutputCount, getParam, getPreserveSpace, getPreserveSpaceCount, getStripSpace, getStripSpaceCount, getStylesheet, getStylesheetComposed, getStylesheetParent, getStylesheetRoot, getTemplate, getTemplateCount, getVariable, getVariableOrParam, getVariableOrParam, getVariableOrParamCount, getVersion, getXmlnsXsl, getXSLToken, replaceTemplate, setAttributeSet, setDecimalFormat, setExcludeResultPrefixes, setExtensionElementPrefixes, setHref, setId, setImport, setInclude, setKey, setLocaterInfo, setNamespaceAlias, setNonXslTopLevel, setOutput, setParam, setPreserveSpaces, setStripSpaces, setStylesheetParent, setStylesheetRoot, setTemplate, setVariable, setVersion, setXmlnsXsl
-
Methods inherited from class org.apache.xalan.templates.ElemTemplateElement
appendChild, appendChild, callVisitors, canAcceptVariables, compareTo, compose, endCompose, error, error, execute, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getBaseIdentifier, getChildNodes, getColumnNumber, getDeclaredPrefixes, getDOMBackPointer, getEndColumnNumber, getEndLineNumber, getFirstChild, getFirstChildElem, getLastChild, getLastChildElem, getLength, getLineNumber, getLocalName, getNamespaceForPrefix, getNamespaceForPrefix, getNextSibling, getNextSiblingElem, getOwnerDocument, getOwnerXSLTemplate, getParentElem, getParentNode, getParentNodeElem, getPreviousSibling, getPreviousSiblingElem, getPublicId, getSystemId, getTagName, getUid, getXmlSpace, handlesNullPrefixes, hasChildNodes, hasTextLitOnly, hasVariableDecl, insertBefore, isCompiledTemplate, item, recompose, removeChild, replaceChild, replaceChild, resolvePrefixTables, runtimeInit, setDOMBackPointer, setEndLocaterInfo, setParentElem, setPrefixes, setPrefixes, setUid, setXmlSpace, shouldStripWhiteSpace
-
Methods inherited from class org.apache.xml.utils.UnImplNode
adoptNode, appendData, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, getActualEncoding, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getImplementation, getInputEncoding, getNamespaceURI, getNodeValue, getOwnerElement, getPrefix, getSchemaTypeInfo, getSpecified, getStrictErrorChecking, getTextContent, getUserData, getWholeText, getXmlEncoding, getXmlStandalone, getXmlVersion, hasAttribute, hasAttributeNS, hasAttributes, importNode, insertData, isDefaultNamespace, isEqualNode, isId, isSameNode, isSupported, isWhitespaceInElementContent, lookupNamespaceURI, lookupPrefix, normalize, normalizeDocument, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, renameNode, replaceData, replaceWholeText, setActualEncoding, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setData, setDocumentURI, setIdAttribute, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInputEncoding, setNodeValue, setPrefix, setStrictErrorChecking, setTextContent, setUserData, setValue, setXmlEncoding, setXmlStandalone, setXmlVersion, splitText, substringData
-
-
-
-
Constructor Detail
-
StylesheetRoot
public StylesheetRoot(javax.xml.transform.ErrorListener errorListener) throws javax.xml.transform.TransformerConfigurationException
Uses an XSL stylesheet document.- Throws:
javax.xml.transform.TransformerConfigurationException
- if the baseIdentifier can not be resolved to a URL.
-
StylesheetRoot
public StylesheetRoot(XSLTSchema schema, javax.xml.transform.ErrorListener listener) throws javax.xml.transform.TransformerConfigurationException
Creates a StylesheetRoot and retains a pointer to the schema used to create this StylesheetRoot. The schema may be needed later for an element-available() function call.- Parameters:
schema
- The schema used to create this stylesheet- Throws:
javax.xml.transform.TransformerConfigurationException
- if the baseIdentifier can not be resolved to a URL.
-
-
Method Detail
-
isRoot
public boolean isRoot()
Tell if this is the root of the stylesheet tree.- Overrides:
isRoot
in classStylesheet
- Returns:
- True since this is the root of the stylesheet tree.
-
setSecureProcessing
public void setSecureProcessing(boolean flag)
Set the state of the secure processing feature.
-
isSecureProcessing
public boolean isSecureProcessing()
Return the state of the secure processing feature.
-
getAvailableElements
public java.util.HashMap getAvailableElements()
Get the hashtable of available elements.- Returns:
- table of available elements, keyed by qualified names, and with values of the same qualified names.
-
getExtensionNamespacesManager
public ExtensionNamespacesManager getExtensionNamespacesManager()
Only instantiate an ExtensionNamespacesManager if one is called for (i.e., if the stylesheet contains extension functions and/or elements).
-
getExtensions
public java.util.Vector getExtensions()
Get the vector of extension namespaces. Used to provide the extensions table access to a list of extension namespaces encountered during composition of a stylesheet.
-
newTransformer
public javax.xml.transform.Transformer newTransformer()
Create a new transformation context for this Templates object.- Specified by:
newTransformer
in interfacejavax.xml.transform.Templates
- Returns:
- A Transformer instance, never null.
-
getDefaultOutputProps
public java.util.Properties getDefaultOutputProps()
-
getOutputProperties
public java.util.Properties getOutputProperties()
Get the static properties for xsl:output. The object returned will be a clone of the internal values, and thus it can be mutated without mutating the Templates object, and then handed in to the process method.For XSLT, Attribute Value Templates attribute values will be returned unexpanded (since there is no context at this point).
- Specified by:
getOutputProperties
in interfacejavax.xml.transform.Templates
- Returns:
- A Properties object, not null.
-
recompose
public void recompose() throws javax.xml.transform.TransformerException
Recompose the values of all "composed" properties, meaning properties that need to be combined or calculated from the combination of imported and included stylesheets. This method determines the proper import precedence of all imported stylesheets. It then iterates through all of the elements and properties in the proper order and triggers the individual recompose methods.- Throws:
javax.xml.transform.TransformerException
-
getGlobalImport
public StylesheetComposed getGlobalImport(int i)
Get a stylesheet from the global import list. TODO: JKESS PROPOSES SPECIAL-CASE FOR NO IMPORT LIST, TO MATCH COUNT.- Parameters:
i
- Index of stylesheet to get from global import list- Returns:
- The stylesheet at the given index
-
getGlobalImportCount
public int getGlobalImportCount()
Get the total number of imports in the global import list.- Returns:
- The total number of imported stylesheets, including the root stylesheet, thus the number will always be 1 or greater. TODO: JKESS PROPOSES SPECIAL-CASE FOR NO IMPORT LIST, TO MATCH DESCRIPTION.
-
getImportNumber
public int getImportNumber(StylesheetComposed sheet)
Given a stylesheet, return the number of the stylesheet in the global import list.- Parameters:
sheet
- The stylesheet which will be located in the global import list.- Returns:
- The index into the global import list of the given stylesheet, or -1 if it is not found (which should never happen).
-
getOutputComposed
public OutputProperties getOutputComposed()
Get the combined "xsl:output" property with the properties combined from the included stylesheets. If a xsl:output is not declared in this stylesheet or an included stylesheet, look in the imports. Please note that this returns a reference to the OutputProperties object, not a cloned object, like getOutputProperties does.- Returns:
- non-null reference to composed output properties object.
- See Also:
- output in XSLT Specification
-
isOutputMethodSet
public boolean isOutputMethodSet()
Find out if an output method has been set by the user.- Returns:
- Value indicating whether an output method has been set by the user
-
getAttributeSetComposed
public java.util.ArrayList getAttributeSetComposed(QName name) throws java.lang.ArrayIndexOutOfBoundsException
Get a list "xsl:attribute-set" properties that match the qname.- Parameters:
name
- Qualified name of attribute set properties to get- Returns:
- A vector of attribute sets matching the given name
- Throws:
java.lang.ArrayIndexOutOfBoundsException
- See Also:
- attribute-sets in XSLT Specification
-
getDecimalFormatComposed
public java.text.DecimalFormatSymbols getDecimalFormatComposed(QName name)
Given a valid element decimal-format name, return the decimalFormatSymbols with that name.It is an error to declare either the default decimal-format or a decimal-format with a given name more than once (even with different import precedence), unless it is declared every time with the same value for all attributes (taking into account any default values).
Which means, as far as I can tell, the decimal-format properties are not additive.
- Parameters:
name
- Qualified name of the decimal format to find- Returns:
- DecimalFormatSymbols object matching the given name or null if name is not found.
-
getKeysComposed
public java.util.Vector getKeysComposed()
Get the composed "xsl:key" properties.- Returns:
- A vector of the composed "xsl:key" properties.
- See Also:
- key in XSLT Specification
-
getNamespaceAliasComposed
public NamespaceAlias getNamespaceAliasComposed(java.lang.String uri)
Get the "xsl:namespace-alias" property. Return the NamespaceAlias for a given namespace uri.- Parameters:
uri
- non-null reference to namespace that is to be aliased.- Returns:
- NamespaceAlias that matches uri, or null if no match.
- See Also:
- literal-result-element in XSLT Specification
-
getTemplateListComposed
public final TemplateList getTemplateListComposed()
Accessor method to retrieve theTemplateList
associated with this StylesheetRoot.- Returns:
- The composed
TemplateList
.
-
setTemplateListComposed
public final void setTemplateListComposed(TemplateList templateList)
Mutator method to set theTemplateList
associated with this StylesheetRoot. This method should only be used by the compiler. Normally, the template list is built during the recompose process and should not be altered by the user.- Parameters:
templateList
- The newTemplateList
for this StylesheetRoot.
-
getTemplateComposed
public ElemTemplate getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm) throws javax.xml.transform.TransformerException
Get an "xsl:template" property by node match. This looks in the imports as well as this stylesheet.- Parameters:
xctxt
- non-null reference to XPath runtime execution context.targetNode
- non-null reference of node that the template must match.mode
- qualified name of the node, or null.quietConflictWarnings
- true if conflict warnings should not be reported.- Returns:
- reference to ElemTemplate that is the best match for targetNode, or null if no match could be made.
- Throws:
javax.xml.transform.TransformerException
- See Also:
- section-Defining-Template-Rules in XSLT Specification
-
getTemplateComposed
public ElemTemplate getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, int maxImportLevel, int endImportLevel, boolean quietConflictWarnings, DTM dtm) throws javax.xml.transform.TransformerException
Get an "xsl:template" property by node match. This looks in the imports as well as this stylesheet.- Parameters:
xctxt
- non-null reference to XPath runtime execution context.targetNode
- non-null reference of node that the template must match.mode
- qualified name of the node, or null.maxImportLevel
- The maximum importCountComposed that we should consider or -1 if we should consider all import levels. This is used by apply-imports to access templates that have been overridden.endImportLevel
- The count of composed importsquietConflictWarnings
- true if conflict warnings should not be reported.- Returns:
- reference to ElemTemplate that is the best match for targetNode, or null if no match could be made.
- Throws:
javax.xml.transform.TransformerException
- See Also:
- section-Defining-Template-Rules in XSLT Specification
-
getTemplateComposed
public ElemTemplate getTemplateComposed(QName qname)
Get an "xsl:template" property. This looks in the imports as well as this stylesheet.- Parameters:
qname
- non-null reference to qualified name of template.- Returns:
- reference to named template, or null if not found.
- See Also:
- section-Defining-Template-Rules in XSLT Specification
-
getVariableOrParamComposed
public ElemVariable getVariableOrParamComposed(QName qname)
Get an "xsl:variable" property.- Parameters:
qname
- Qualified name of variable or param- Returns:
- The ElemVariable with the given qualified name
- See Also:
- top-level-variables in XSLT Specification
-
getVariablesAndParamsComposed
public java.util.Vector getVariablesAndParamsComposed()
Get all global "xsl:variable" properties in scope for this stylesheet.- Returns:
- Vector of all variables and params in scope
- See Also:
- top-level-variables in XSLT Specification
-
shouldCheckWhitespace
public boolean shouldCheckWhitespace()
Check to see if the caller should bother with check for whitespace nodes.- Returns:
- Whether the caller should bother with check for whitespace nodes.
-
getWhiteSpaceInfo
public WhiteSpaceInfo getWhiteSpaceInfo(XPathContext support, int targetElement, DTM dtm) throws javax.xml.transform.TransformerException
Get information about whether or not an element should strip whitespace.- Parameters:
support
- The XPath runtime state.targetElement
- Element to check- Returns:
- WhiteSpaceInfo for the given element
- Throws:
javax.xml.transform.TransformerException
- See Also:
- strip in XSLT Specification
-
shouldStripWhiteSpace
public boolean shouldStripWhiteSpace(XPathContext support, int targetElement) throws javax.xml.transform.TransformerException
Get information about whether or not an element should strip whitespace.- Parameters:
support
- The XPath runtime state.targetElement
- Element to check- Returns:
- true if the whitespace should be stripped.
- Throws:
javax.xml.transform.TransformerException
- See Also:
- strip in XSLT Specification
-
canStripWhiteSpace
public boolean canStripWhiteSpace()
Get information about whether or not whitespace can be stripped.- Specified by:
canStripWhiteSpace
in interfaceWhitespaceStrippingElementMatcher
- Overrides:
canStripWhiteSpace
in classElemTemplateElement
- Returns:
- true if the whitespace can be stripped.
- See Also:
- strip in XSLT Specification
-
getDefaultTextRule
public final ElemTemplate getDefaultTextRule()
Get the default template for text.- Returns:
- the default template for text.
-
getDefaultRule
public final ElemTemplate getDefaultRule()
Get the default template for elements.- Returns:
- the default template for elements.
-
getDefaultRootRule
public final ElemTemplate getDefaultRootRule()
Get the default template for a root node.- Returns:
- The default template for a root node.
-
getStartRule
public final ElemTemplate getStartRule()
Get the default template for a root node.- Returns:
- The default template for a root node.
-
setExtensionHandlerClass
public java.lang.String setExtensionHandlerClass(java.lang.String handlerClassName)
This internal method allows the setting of the java class to handle the extension function (if other than the default one).
-
getExtensionHandlerClass
public java.lang.String getExtensionHandlerClass()
-
getOptimizer
public boolean getOptimizer()
- Returns:
- Optimization flag
-
setOptimizer
public void setOptimizer(boolean b)
- Parameters:
b
- Optimization flag
-
getIncremental
public boolean getIncremental()
- Returns:
- Incremental flag
-
getSource_location
public boolean getSource_location()
- Returns:
- source location flag
-
setIncremental
public void setIncremental(boolean b)
- Parameters:
b
- Incremental flag
-
setSource_location
public void setSource_location(boolean b)
- Parameters:
b
- Source location flag
-
-