## net.sf.saxon.style
Class XSLStylesheet

    java.lang.Object
      net.sf.saxon.tree.NodeImpl
          net.sf.saxon.tree.ParentNodeImpl
              net.sf.saxon.tree.ElementImpl
                  net.sf.saxon.tree.ElementWithAttributes
                      net.sf.saxon.style.StyleElement
                          net.sf.saxon.style.XSLStylesheet

All Implemented Interfaces:
  Container, FingerprintedNode, InstructionInfo, Item, LocationProvider, org.xml.sax.Locator, NodeInfo, SaxonLocator, javax.xml.transform.Source, javax.xml.transform.SourceLocator, ValueRepresentation

public class XSLStylesheet
extends StyleElement

An xsl:stylesheet or xsl:transform element in the stylesheet.
Note this element represents a stylesheet module, not necessarily the whole stylesheet.

Field Summary
`static int` `ANNOTATION_PRESERVE`
`static int` `ANNOTATION_STRIP`

Fields inherited from class net.sf.saxon.style.StyleElement
`defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version`

Fields inherited from class net.sf.saxon.tree.ElementWithAttributes
`attributeList, namespaceList`

Fields inherited from class net.sf.saxon.tree.ElementImpl
`nameCode, root, sequence`

Fields inherited from class net.sf.saxon.tree.NodeImpl
`index, NODE_LETTER, parent`

Fields inherited from interface net.sf.saxon.om.NodeInfo
`ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, LOCAL_NAMESPACES, NO_NAMESPACES`

Constructor Summary
`XSLStylesheet()`

Method Summary
`protected void` `addImportedSchema(java.lang.String targetNamespace)`
`int` `allocateGlobalSlot(int fingerprint)` Allocate a slot number for a global variable or parameter
`void` `allocatePatternSlots(int n)` Ensure there is enough space for local variables or parameters when evaluating the match pattern of template rules
`Expression` `compile(Executable exec)` Dummy compile() method to satisfy the interface
`Executable` `compileStylesheet()` Compile the stylesheet to create an executable.
`protected void` `declareJavaClass(java.lang.String uri, java.lang.Class theClass)` Declare a URI that maps to a Java class containing extension functions
`protected void` `declareXQueryFunction(XQueryFunction function)` Declare an imported XQuery function
`protected java.util.Comparator` `findCollation(java.lang.String name)` Find a named collation.
`java.util.Properties` `gatherOutputProperties(int fingerprint)` Create an output properties object representing the xsl:output elements in the stylesheet.
`XSLCharacterMap` `getCharacterMap(int fingerprint)` Get a character map, identified by the fingerprint of its name.
`DecimalFormatManager` `getDecimalFormatManager()` Get the DecimalFormatManager which handles decimal-format definitions
`java.lang.String` `getDefaultCollationName()` Get the name of the default collation
`int` `getDefaultValidation()` Get the value of the default validation attribute
`Executable` `getExecutable()` Get the run-time Executable object
`FunctionLibrary` `getFunctionLibrary()` Get the function library.
`XSLVariableDeclaration` `getGlobalVariable(int fingerprint)` Get the global variable or parameter with a given fingerprint (taking precedence rules into account)
`XSLStylesheet` `getImporter()` Get the StyleSheet that included or imported this one.
`int` `getInputTypeAnnotations()` Get the value of the input-type-annotations attribute, for this module combined with that of all included/imported modules.
`int` `getInputTypeAnnotationsAttribute()` Get the value of the input-type-annotations attribute, for this module alone.
`KeyManager` `getKeyManager()` Get the KeyManager which handles key definitions
`LocationMap` `getLocationMap()` Get the locationMap object
`int` `getMinImportPrecedence()` Get the minimum import precedence of this stylesheet, that is, the lowest precedence of any stylesheet imported by this one
`protected int` `getNamespaceAlias(short uriCode)` Get the declared namespace alias for a given namespace URI code if there is one.
`int` `getPrecedence()` Get the import precedence of this stylesheet
`PreparedStylesheet` `getPreparedStylesheet()` Get the owning PreparedStylesheet object
`RuleManager` `getRuleManager()` Get the RuleManager which handles template rules
`protected Mode` `getStripperRules()` Get the rules determining which nodes are to be stripped from the tree
`NamePool` `getTargetNamePool()` Get the namepool to be used at run-time, this namepool holds the names used in all XPath expressions and patterns
`java.util.List` `getTopLevel()` Get the top level elements in this stylesheet, after applying include/import
`protected boolean` `hasNamespaceAliases()`
`protected boolean` `isAliasResultNamespace(short uriCode)` Determine if a namespace is included in the result-prefix of a namespace-alias
`protected boolean` `isImportedSchema(java.lang.String targetNamespace)` Get an imported schema with a given namespace
`void` `prepareAttributes()` Prepare the attributes on the stylesheet element
`void` `preprocess()` Preprocess does all the processing possible before the source document is available.
`void` `processAllAttributes()` Process the attributes of every node in the stylesheet
`void` `setCollation(java.lang.String name, java.util.Comparator collation, boolean isDefault)` Register a named collation (actually a Comparator)
`void` `setImporter(XSLStylesheet importer)` Set the StyleSheet that included or imported this one.
`void` `setInputTypeAnnotations(int annotations)` Set the value of the input-type-annotations attribute, for this module combined with that of all included/imported modules.
`void` `setMinImportPrecedence(int precedence)` Set the minimum import precedence of this stylesheet, that is, the lowest precedence of any stylesheet imported by this one
`void` `setPrecedence(int prec)` Set the import precedence of this stylesheet
`void` `setPreparedStylesheet(PreparedStylesheet sheet)` Create link to the owning PreparedStylesheet object
`void` `setWasIncluded()` Indicate that this stylesheet was included (by its "importer") using an xsl:include statement as distinct from xsl:import
`void` `spliceIncludes()` Process xsl:include and xsl:import elements.
`boolean` `stripsWhitespace()` Determine whether this stylesheet does any whitespace stripping
`void` `validate()` Validate this element

Methods inherited from class net.sf.saxon.style.StyleElement

`allocateLocationId, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getCommonChildItemType, getConstructType, getContainingSlotManager, getContainingStylesheet, getDefaultXPathNamespace, getInstructionFingerprint, getLastChildInstruction, getLineNumber, getLineNumber, getNamespaceResolver, getObjectFingerprint, getObjectNameCode, getPrincipalStylesheet, getProperties, getProperty, getReturnedItemType, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, getWithParamInstructions, isExcludedNamespace, isExtensionNamespace, isInstruction, isPermittedChild, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeNameCode, makeNamespaceContext, makePattern, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, mayContainSequenceConstructor, postValidate, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, reportAbsence, setLineNumber, setObjectNameCode, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree`

Methods inherited from class net.sf.saxon.tree.ElementWithAttributes
`copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, sendNamespaceDeclarations, setNamespaceDeclarations`

Methods inherited from class net.sf.saxon.tree.ElementImpl
`addChild, compact, enumerateChildren, generateId, getBaseURI, getDocumentRoot, getFirstChild, getLastChild, getNameCode, getNodeKind, getNthChild, getRoot, getSequenceNumber, getStringValue, getStringValueCS, getSystemId, hasChildNodes, setNameCode, setSystemId, useChildrenArray`

Methods inherited from class net.sf.saxon.tree.NodeImpl
`compareOrder, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, isSameNodeInfo, iterateAxis, iterateAxis`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.xml.sax.Locator
`getColumnNumber, getPublicId, getSystemId`

Methods inherited from interface javax.xml.transform.SourceLocator
`getColumnNumber, getPublicId, getSystemId`

Methods inherited from interface net.sf.saxon.trace.InstructionInfo
`getSystemId`

Field Detail

### ANNOTATION_STRIP

    public static final int ANNOTATION_STRIP

See Also:
  Constant Field Values

### ANNOTATION_PRESERVE

    public static final int ANNOTATION_PRESERVE

See Also:
  Constant Field Values

Constructor Detail

### XSLStylesheet

    public XSLStylesheet()

Method Detail

### setPreparedStylesheet

    public void setPreparedStylesheet(PreparedStylesheet sheet)

  Create link to the owning PreparedStylesheet object

### getPreparedStylesheet

    public PreparedStylesheet getPreparedStylesheet()

  Get the owning PreparedStylesheet object

  Overrides:
    `getPreparedStylesheet` in class `StyleElement`
  Returns:
    the PreparedStylesheet to which this stylesheet element belongs

### getExecutable

    public Executable getExecutable()

  Get the run-time Executable object

  Specified by:
    `getExecutable` in interface `Container`
  Overrides:
    `getExecutable` in class `StyleElement`

### getFunctionLibrary

    public FunctionLibrary getFunctionLibrary()

  Get the function library. Available only on the principal stylesheet module

### getLocationMap

    public LocationMap getLocationMap()

  Get the locationMap object

### getTargetNamePool

    public NamePool getTargetNamePool()

  Get the namepool to be used at run-time, this namepool holds the names used in all XPath expressions and patterns

  Overrides:
    `getTargetNamePool` in class `StyleElement`

### getRuleManager

    public RuleManager getRuleManager()

  Get the RuleManager which handles template rules

### getStripperRules

    protected Mode getStripperRules()

  Get the rules determining which nodes are to be stripped from the tree

### stripsWhitespace

    public boolean stripsWhitespace()

  Determine whether this stylesheet does any whitespace stripping

### getKeyManager

    public KeyManager getKeyManager()

  Get the KeyManager which handles key definitions

### getDecimalFormatManager

    public DecimalFormatManager getDecimalFormatManager()

  Get the DecimalFormatManager which handles decimal-format definitions

### setCollation

    public void setCollation(java.lang.String name,
                             java.util.Comparator collation,
                             boolean isDefault)

  Register a named collation (actually a Comparator)

### findCollation

    protected java.util.Comparator findCollation(java.lang.String name)

  Find a named collation. Note this method should only be used at compile-time, before declarations have been pre-processed. After that time, use getCollation().

  Parameters:
    `name` - identifies the name of the collation required; null indicates that the default collation is required
  Returns:
    null if the collation is not found

### getDefaultCollationName

    public java.lang.String getDefaultCollationName()

  Get the name of the default collation

  Overrides:
    `getDefaultCollationName` in class `StyleElement`

### getCharacterMap

    public XSLCharacterMap getCharacterMap(int fingerprint)

  Get a character map, identified by the fingerprint of its name. Search backwards through the stylesheet.

  Parameters:
    `fingerprint` - The fingerprint of the character map name, in the target namepool.
  Returns:
    the identified character map, or null if not found

### setPrecedence

    public void setPrecedence(int prec)

  Set the import precedence of this stylesheet

### getPrecedence

    public int getPrecedence()

  Get the import precedence of this stylesheet

  Overrides:
    `getPrecedence` in class `StyleElement`

### getMinImportPrecedence

    public int getMinImportPrecedence()

  Get the minimum import precedence of this stylesheet, that is, the lowest precedence of any stylesheet imported by this one

### setMinImportPrecedence

    public void setMinImportPrecedence(int precedence)

  Set the minimum import precedence of this stylesheet, that is, the lowest precedence of any stylesheet imported by this one

### setImporter

    public void setImporter(XSLStylesheet importer)

  Set the StyleSheet that included or imported this one.

### getImporter

    public XSLStylesheet getImporter()

  Get the StyleSheet that included or imported this one.

  Returns:
    null if this is the principal stylesheet

### setWasIncluded

    public void setWasIncluded()

  Indicate that this stylesheet was included (by its "importer") using an xsl:include statement as distinct from xsl:import

### getTopLevel

    public java.util.List getTopLevel()

  Get the top level elements in this stylesheet, after applying include/import

### allocateGlobalSlot

    public int allocateGlobalSlot(int fingerprint)

  Allocate a slot number for a global variable or parameter

### allocatePatternSlots

    public void allocatePatternSlots(int n)

  Ensure there is enough space for local variables or parameters when evaluating the match pattern of template rules

### prepareAttributes

    public void prepareAttributes()
                           throws javax.xml.transform.TransformerConfigurationException

  Prepare the attributes on the stylesheet element

  Specified by:
    `prepareAttributes` in class `StyleElement`
  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### getDefaultValidation

    public int getDefaultValidation()

  Get the value of the default validation attribute

### getInputTypeAnnotationsAttribute

    public int getInputTypeAnnotationsAttribute()
                                         throws javax.xml.transform.TransformerConfigurationException

  Get the value of the input-type-annotations attribute, for this module alone. The value is an or-ed combination of the two bits `ANNOTATION_STRIP` and `ANNOTATION_PRESERVE`

  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### getInputTypeAnnotations

    public int getInputTypeAnnotations()

  Get the value of the input-type-annotations attribute, for this module combined with that of all included/imported modules. The value is an or-ed combination of the two bits `ANNOTATION_STRIP` and `ANNOTATION_PRESERVE`

### setInputTypeAnnotations

    public void setInputTypeAnnotations(int annotations)
                                 throws javax.xml.transform.TransformerConfigurationException

  Set the value of the input-type-annotations attribute, for this module combined with that of all included/imported modules. The value is an or-ed combination of the two bits `ANNOTATION_STRIP` and `ANNOTATION_PRESERVE`

  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### getNamespaceAlias

    protected int getNamespaceAlias(short uriCode)

  Get the declared namespace alias for a given namespace URI code if there is one. If there is more than one, we get the last.

  Parameters:
    `uriCode` - The code of the uri used in the stylesheet.
  Returns:
    The namespace code to be used (prefix in top half, uri in bottom half): return -1 if no alias is defined

### isAliasResultNamespace

    protected boolean isAliasResultNamespace(short uriCode)

  Determine if a namespace is included in the result-prefix of a namespace-alias

### validate

    public void validate()
                  throws javax.xml.transform.TransformerConfigurationException

  Validate this element

  Overrides:
    `validate` in class `StyleElement`
  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### preprocess

    public void preprocess()
                    throws javax.xml.transform.TransformerConfigurationException

  Preprocess does all the processing possible before the source document is available. It is done once per stylesheet, so the stylesheet can be reused for multiple source documents. The method is called only on the XSLStylesheet element representing the principal stylesheet module

  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### spliceIncludes

    public void spliceIncludes()
                        throws javax.xml.transform.TransformerConfigurationException

  Process xsl:include and xsl:import elements.

  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### hasNamespaceAliases

    protected boolean hasNamespaceAliases()

### processAllAttributes

    public void processAllAttributes()
                              throws javax.xml.transform.TransformerConfigurationException

  Process the attributes of every node in the stylesheet

  Overrides:
    `processAllAttributes` in class `StyleElement`
  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### getGlobalVariable

    public XSLVariableDeclaration getGlobalVariable(int fingerprint)

  Get the global variable or parameter with a given fingerprint (taking precedence rules into account)

### gatherOutputProperties

    public java.util.Properties gatherOutputProperties(int fingerprint)
                                                throws javax.xml.transform.TransformerConfigurationException

  Create an output properties object representing the xsl:output elements in the stylesheet.

  Parameters:
    `fingerprint` - The name of the output format required. If set to -1, gathers information for the unnamed output format
  Returns:
    the Properties object containing the details of the specified output format
  Throws:
    `javax.xml.transform.TransformerConfigurationException` - if a named output format does not exist in the stylesheet

### declareXQueryFunction

    protected void declareXQueryFunction(XQueryFunction function)
                                  throws XPathException

  Declare an imported XQuery function

  Throws:
    `XPathException`

### declareJavaClass

    protected void declareJavaClass(java.lang.String uri,
                                    java.lang.Class theClass)

  Declare a URI that maps to a Java class containing extension functions

### isImportedSchema

    protected boolean isImportedSchema(java.lang.String targetNamespace)

  Get an imported schema with a given namespace

  Parameters:
    `targetNamespace` - The target namespace of the required schema. Supply an empty string for the default namespace
  Returns:
    the required Schema, or null if no such schema has been imported

### addImportedSchema

    protected void addImportedSchema(java.lang.String targetNamespace)

### compileStylesheet

    public Executable compileStylesheet()
                                 throws javax.xml.transform.TransformerConfigurationException

  Compile the stylesheet to create an executable.

  Throws:
    `javax.xml.transform.TransformerConfigurationException`

### compile

    public Expression compile(Executable exec)

  Dummy compile() method to satisfy the interface

  Specified by:
    `compile` in class `StyleElement`
  Returns:
    either a ComputedExpression, or null. The value null is returned when compiling an instruction that returns a no-op, or when compiling a top-level object such as an xsl:template that compiles into something other than an instruction.