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:
Serializable, SourceLocator, Templates, XSLTVisitable, PrefixResolver, ExpressionNode, WhitespaceStrippingElementMatcher, Document, Element, Node, NodeList
public class StylesheetRoot
extends StylesheetComposed
implements Serializable, Templates
This class represents the root object of the stylesheet tree.
See Also:
Serialized Form

  • Constructor Details

  • Method Details

    • isRoot

      public boolean isRoot()
      Tell if this is the root of the stylesheet tree.
      Overrides:
      isRoot in class Stylesheet
      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 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 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 Transformer newTransformer()
      Create a new transformation context for this Templates object.
      Specified by:
      newTransformer in interface Templates
      Returns:
      A Transformer instance, never null.

    • getDefaultOutputProps

      public Properties getDefaultOutputProps()

    • getOutputProperties

      public 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 interface Templates
      Returns:
      A Properties object, not null.

    • recompose

      public void recompose() throws 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:
      TransformerException

    • addImports

      protected void addImports​(Stylesheet stylesheet, boolean addToList, Vector importList)
      Add the imports in the given sheet to the working importList vector. The will be added from highest import precedence to least import precedence. This is a post-order traversal of the import tree as described in the XSLT Recommendation.

      For example, suppose

      stylesheet A imports stylesheets B and C in that order;

      stylesheet B imports stylesheet D;

      stylesheet C imports stylesheet E.

      Then the order of import precedence (highest first) is A, C, E, B, D.

      Parameters:
      stylesheet - Stylesheet to examine for imports.
      addToList - true if this template should be added to the import list
      importList - The working import list. Templates are added here in the reverse order of priority. When we're all done, we'll reverse this to the correct priority in an array.

    • 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 ArrayList getAttributeSetComposed​(QName name) throws 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:
      ArrayIndexOutOfBoundsException
      See Also:
      attribute-sets in XSLT Specification

    • getDecimalFormatComposed

      public 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 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​(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 the TemplateList associated with this StylesheetRoot.
      Returns:
      The composed TemplateList.

    • setTemplateListComposed

      public final void setTemplateListComposed​(TemplateList templateList)
      Mutator method to set the TemplateList 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 new TemplateList for this StylesheetRoot.

    • getTemplateComposed

      public ElemTemplate getTemplateComposed​(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm) throws 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:
      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 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 imports
      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:
      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 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 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:
      TransformerException
      See Also:
      strip in XSLT Specification

    • shouldStripWhiteSpace

      public boolean shouldStripWhiteSpace​(XPathContext support, int targetElement) throws 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:
      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 interface WhitespaceStrippingElementMatcher
      Overrides:
      canStripWhiteSpace in class ElemTemplateElement
      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 String setExtensionHandlerClass​(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 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