org.apache.xalan.templates

Class StylesheetRoot

public class StylesheetRoot extends StylesheetComposed implements Serializable, Templates

This class represents the root object of the stylesheet tree.

UNKNOWN: general

Constructor Summary
StylesheetRoot(ErrorListener errorListener)
Uses an XSL stylesheet document.
StylesheetRoot(XSLTSchema schema, ErrorListener listener)
Creates a StylesheetRoot and retains a pointer to the schema used to create this StylesheetRoot.
Method Summary
booleancanStripWhiteSpace()
Get information about whether or not whitespace can be stripped.
ArrayListgetAttributeSetComposed(QName name)
Get a list "xsl:attribute-set" properties that match the qname.
HashMapgetAvailableElements()
Get the hashtable of available elements.
DecimalFormatSymbolsgetDecimalFormatComposed(QName name)
Given a valid element decimal-format name, return the decimalFormatSymbols with that name.
PropertiesgetDefaultOutputProps()
ElemTemplategetDefaultRootRule()
Get the default template for a root node.
ElemTemplategetDefaultRule()
Get the default template for elements.
ElemTemplategetDefaultTextRule()
Get the default template for text.
StringgetExtensionHandlerClass()
ExtensionNamespacesManagergetExtensionNamespacesManager()
Only instantiate an ExtensionNamespacesManager if one is called for (i.e., if the stylesheet contains extension functions and/or elements).
VectorgetExtensions()
Get the vector of extension namespaces.
StylesheetComposedgetGlobalImport(int i)
Get a stylesheet from the global import list.
intgetGlobalImportCount()
Get the total number of imports in the global import list.
intgetImportNumber(StylesheetComposed sheet)
Given a stylesheet, return the number of the stylesheet in the global import list.
booleangetIncremental()
VectorgetKeysComposed()
Get the composed "xsl:key" properties.
NamespaceAliasgetNamespaceAliasComposed(String uri)
Get the "xsl:namespace-alias" property.
booleangetOptimizer()
OutputPropertiesgetOutputComposed()
Get the combined "xsl:output" property with the properties combined from the included stylesheets.
PropertiesgetOutputProperties()
Get the static properties for xsl:output.
booleangetSource_location()
ElemTemplategetStartRule()
Get the default template for a root node.
ElemTemplategetTemplateComposed(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm)
Get an "xsl:template" property by node match.
ElemTemplategetTemplateComposed(XPathContext xctxt, int targetNode, QName mode, int maxImportLevel, int endImportLevel, boolean quietConflictWarnings, DTM dtm)
Get an "xsl:template" property by node match.
ElemTemplategetTemplateComposed(QName qname)
Get an "xsl:template" property.
TemplateListgetTemplateListComposed()
Accessor method to retrieve the TemplateList associated with this StylesheetRoot.
ElemVariablegetVariableOrParamComposed(QName qname)
Get an "xsl:variable" property.
VectorgetVariablesAndParamsComposed()
Get all global "xsl:variable" properties in scope for this stylesheet.
WhiteSpaceInfogetWhiteSpaceInfo(XPathContext support, int targetElement, DTM dtm)
Get information about whether or not an element should strip whitespace.
booleanisOutputMethodSet()
Find out if an output method has been set by the user.
booleanisRoot()
Tell if this is the root of the stylesheet tree.
booleanisSecureProcessing()
Return the state of the secure processing feature.
TransformernewTransformer()
Create a new transformation context for this Templates object.
voidrecompose()
Recompose the values of all "composed" properties, meaning properties that need to be combined or calculated from the combination of imported and included stylesheets.
StringsetExtensionHandlerClass(String handlerClassName)
This internal method allows the setting of the java class to handle the extension function (if other than the default one).
voidsetIncremental(boolean b)
voidsetOptimizer(boolean b)
voidsetSecureProcessing(boolean flag)
Set the state of the secure processing feature.
voidsetSource_location(boolean b)
voidsetTemplateListComposed(TemplateList templateList)
Mutator method to set the TemplateList associated with this StylesheetRoot.
booleanshouldCheckWhitespace()
Check to see if the caller should bother with check for whitespace nodes.
booleanshouldStripWhiteSpace(XPathContext support, int targetElement)
Get information about whether or not an element should strip whitespace.

Constructor Detail

StylesheetRoot

public StylesheetRoot(ErrorListener errorListener)
Uses an XSL stylesheet document.

Throws: TransformerConfigurationException if the baseIdentifier can not be resolved to a URL.

StylesheetRoot

public StylesheetRoot(XSLTSchema schema, ErrorListener listener)
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: TransformerConfigurationException if the baseIdentifier can not be resolved to a URL.

Method Detail

canStripWhiteSpace

public boolean canStripWhiteSpace()
Get information about whether or not whitespace can be stripped.

Returns: true if the whitespace can be stripped.

See Also: strip in XSLT Specification

getAttributeSetComposed

public ArrayList getAttributeSetComposed(QName name)
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

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.

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.

getDefaultOutputProps

public Properties getDefaultOutputProps()

getDefaultRootRule

public final ElemTemplate getDefaultRootRule()
Get the default template for a root node.

Returns: The default template for a root node.

UNKNOWN: advanced

getDefaultRule

public final ElemTemplate getDefaultRule()
Get the default template for elements.

Returns: the default template for elements.

UNKNOWN: advanced

getDefaultTextRule

public final ElemTemplate getDefaultTextRule()
Get the default template for text.

Returns: the default template for text.

UNKNOWN: advanced

getExtensionHandlerClass

public String getExtensionHandlerClass()

UNKNOWN: internal

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.

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

getIncremental

public boolean getIncremental()

Returns: Incremental flag

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

getOptimizer

public boolean getOptimizer()

Returns: Optimization flag

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

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

Returns: A Properties object, not null.

getSource_location

public boolean getSource_location()

Returns: source location flag

getStartRule

public final ElemTemplate getStartRule()
Get the default template for a root node.

Returns: The default template for a root node.

UNKNOWN: advanced

getTemplateComposed

public ElemTemplate getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm)
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)
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

getTemplateListComposed

public final TemplateList getTemplateListComposed()
Accessor method to retrieve the TemplateList associated with this StylesheetRoot.

Returns: The composed TemplateList.

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

getWhiteSpaceInfo

public WhiteSpaceInfo getWhiteSpaceInfo(XPathContext support, int targetElement, DTM dtm)
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

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

UNKNOWN: internal

isRoot

public boolean isRoot()
Tell if this is the root of the stylesheet tree.

Returns: True since this is the root of the stylesheet tree.

isSecureProcessing

public boolean isSecureProcessing()
Return the state of the secure processing feature.

newTransformer

public Transformer newTransformer()
Create a new transformation context for this Templates object.

Returns: A Transformer instance, never null.

recompose

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

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

UNKNOWN: internal

setIncremental

public void setIncremental(boolean b)

Parameters: b Incremental flag

setOptimizer

public void setOptimizer(boolean b)

Parameters: b Optimization flag

setSecureProcessing

public void setSecureProcessing(boolean flag)
Set the state of the secure processing feature.

setSource_location

public void setSource_location(boolean b)

Parameters: b Source location flag

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.

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.

shouldStripWhiteSpace

public boolean shouldStripWhiteSpace(XPathContext support, int targetElement)
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

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