net.sf.saxon.style
Class XSLStylesheet

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

All Implemented Interfaces:

Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, NamespaceResolver, NodeInfo, ValueRepresentation, InstructionInfo, Locator

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. However, much of the functionality (and the fields) are relevant only to the top-level module.

See Also:

Serialized Form

Field Summary

static int	ANNOTATION_PRESERVE
static int	ANNOTATION_STRIP

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

REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE

Fields inherited from class net.sf.saxon.tree.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

XSLStylesheet()

Method Summary

void	addChild(NodeImpl node, int index) Add a child node to this node.
int	allocateGlobalSlot(StructuredQName qName) 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
int	allocateUniqueParameterNumber(StructuredQName qName) Allocate a unique number to a local parameter name.
boolean	allowsAllBuiltInTypes() Determine whether the use of non-primitive built-in types has been enabled for this stylesheet (This is relevant only for Saxon-B: such types are always permitted in Saxon-SA)
void	compact(int size) Compact the space used by this node
Expression	compile(Executable exec) Dummy compile() method to satisfy the interface
Executable	compileStylesheet() Compile the stylesheet to create an executable.
Properties	gatherOutputProperties(StructuredQName formatQName) Create an output properties object representing the xsl:output elements in the stylesheet.
XSLCharacterMap	getCharacterMap(StructuredQName name) Get a character map, identified by the fingerprint of its name.
CollationMap	getCollationMap() Get the collation map
DecimalFormatManager	getDecimalFormatManager() Get the DecimalFormatManager which handles decimal-format definitions
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
NodeInfo	getFirstChild() Get the first child node of the element
FunctionLibrary	getFunctionLibrary() Get the function library.
XSLVariableDeclaration	getGlobalVariable(StructuredQName qName) Get the global variable or parameter with a given name (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
NodeInfo	getLastChild() Get the last child node of the element
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
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
String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
List	getTopLevel() Get the top level elements in this stylesheet, after applying include/import
boolean	hasChildNodes() Determine if the node has any children.
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(String name, StringCollator collation) Register a named collation (actually a StringCollator)
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	setNeedsDynamicOutputProperties(boolean b) Set that this stylesheet needs dynamic output properties
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

allocatePatternSlots, allocateSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkTopLevel, checkWithinTemplate, compileSequenceConstructor, fixupReferences, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeValue, getConstructType, getContainingSlotManager, getContainingStylesheet, getHostLanguage, getLineNumber, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getObjectName, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, isExcludedNamespace, isExtensionNamespace, isInstruction, isTopLevel, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, postValidate, replaceSubExpression, reportAbsence, setLineNumber, setObjectName, substituteFor, typeCheck, typeCheck, validateSubtree

Methods inherited from class net.sf.saxon.tree.ElementWithAttributes

copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, setNamespaceDeclarations

Methods inherited from class net.sf.saxon.tree.ElementImpl

generateId, getBaseURI, getDocumentRoot, getNameCode, getNodeKind, getRoot, getSystemId, setNameCode, setSystemId

Methods inherited from class net.sf.saxon.tree.NodeImpl

atomize, compareOrder, equals, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

Parameters:

sheet - the PreparedStylesheet

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

Returns:

the executable

getFunctionLibrary

public FunctionLibrary getFunctionLibrary()

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

Returns:

the function library

getLocationMap

public LocationMap getLocationMap()

Get the locationMap object

Returns:

the LocationMap

getRuleManager

public RuleManager getRuleManager()

Get the RuleManager which handles template rules

Returns:

the template rule manager

stripsWhitespace

public boolean stripsWhitespace()

Determine whether this stylesheet does any whitespace stripping

Returns:

true if this stylesheet strips whitespace from source documents

getKeyManager

public KeyManager getKeyManager()

Get the KeyManager which handles key definitions

Returns:

the key manager

getDecimalFormatManager

public DecimalFormatManager getDecimalFormatManager()

Get the DecimalFormatManager which handles decimal-format definitions

Returns:

the DecimalFormatManager for this stylesheet

getCollationMap

public CollationMap getCollationMap()

Get the collation map

Returns:

the CollationMap

setCollation

public void setCollation(String name,
                         StringCollator collation)

Register a named collation (actually a StringCollator)

Parameters:

name - the name of the collation

collation - the StringCollator that implements this collation

getDefaultCollationName

public String getDefaultCollationName()

Get the name of the default collation

Returns:

the name of the default collation

getCharacterMap

public XSLCharacterMap getCharacterMap(StructuredQName name)

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

Parameters:

name - The character map name being sought

Returns:

the identified character map, or null if not found

setPrecedence

public void setPrecedence(int prec)

Set the import precedence of this stylesheet

Parameters:

prec - the import precedence. Higher numbers indicate higher precedence, but the actual number has no significance

getPrecedence

public int getPrecedence()

Get the import precedence of this stylesheet

Overrides:

getPrecedence in class StyleElement

Returns:

the import precedence. The actual numeric value is arbitrary, but a higher number indicates a higher precedence.

getMinImportPrecedence

public int getMinImportPrecedence()

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

Returns:

the minimum precedence of imported stylesheet modules

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

Parameters:

precedence - the precedence of the first stylesheet module that this one imports

setImporter

public void setImporter(XSLStylesheet importer)

Set the StyleSheet that included or imported this one.

Parameters:

importer - the stylesheet module that included or imported this module

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 List getTopLevel()

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

Returns:

a list of top-level elements in this stylesheet module or in those modules that it includes or imports

allocateGlobalSlot

public int allocateGlobalSlot(StructuredQName qName)

Allocate a slot number for a global variable or parameter

Parameters:

qName - the name of the variable or parameter

Returns:

int the allocated slot number

allocatePatternSlots

public void allocatePatternSlots(int n)

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

Parameters:

n - the number of slots to be allocated

prepareAttributes

public void prepareAttributes()
                       throws XPathException

Prepare the attributes on the stylesheet element

Throws:

XPathException

getDefaultValidation

public int getDefaultValidation()

Get the value of the default validation attribute

Returns:

the value of the default-validation attribute, as a constant such as Validation.STRIP

getInputTypeAnnotationsAttribute

public int getInputTypeAnnotationsAttribute()
                                     throws XPathException

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

Returns:

the value if the input-type-annotations attribute in this stylesheet module

Throws:

XPathException

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

Returns:

the value of the input-type-annotations attribute, for this module combined with that of all included/imported modules

setInputTypeAnnotations

public void setInputTypeAnnotations(int annotations)
                             throws XPathException

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

Parameters:

annotations - the value of the input-type-annotations attribute, for this module combined with that of all included/imported modules.

Throws:

XPathException

allowsAllBuiltInTypes

public boolean allowsAllBuiltInTypes()

Determine whether the use of non-primitive built-in types has been enabled for this stylesheet (This is relevant only for Saxon-B: such types are always permitted in Saxon-SA)

Returns:

true if all built-in types can be used

validate

public void validate()
              throws XPathException

Validate this element

Overrides:

validate in class StyleElement

Throws:

XPathException

preprocess

public void preprocess()
                throws XPathException

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:

XPathException

spliceIncludes

public void spliceIncludes()
                    throws XPathException

Process xsl:include and xsl:import elements.

Throws:

XPathException

processAllAttributes

public void processAllAttributes()
                          throws XPathException

Process the attributes of every node in the stylesheet

Throws:

XPathException - in the event of a static error being detected

getGlobalVariable

public XSLVariableDeclaration getGlobalVariable(StructuredQName qName)

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

Parameters:

qName - name of the global variable or parameter

Returns:

the variable declaration

setNeedsDynamicOutputProperties

public void setNeedsDynamicOutputProperties(boolean b)

Set that this stylesheet needs dynamic output properties

Parameters:

b - true if this stylesheet needs dynamic output properties

gatherOutputProperties

public Properties gatherOutputProperties(StructuredQName formatQName)
                                  throws XPathException

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

Parameters:

formatQName - The name of the output format required. If set to null, gathers information for the unnamed output format

Returns:

the Properties object containing the details of the specified output format

Throws:

XPathException - if a named output format does not exist in the stylesheet

compileStylesheet

public Executable compileStylesheet()
                             throws XPathException

Compile the stylesheet to create an executable.

Returns:

the Executable representing the compiled stylesheet

Throws:

XPathException

compile

public Expression compile(Executable exec)

Dummy compile() method to satisfy the interface

Specified by:

compile in class StyleElement

Parameters:

exec - the Executable

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.

allocateUniqueParameterNumber

public int allocateUniqueParameterNumber(StructuredQName qName)

Allocate a unique number to a local parameter name. This should only be called on the principal stylesheet module.

Parameters:

qName - the local parameter name

Returns:

an integer that uniquely identifies this parameter name within the stylesheet

hasChildNodes

public final boolean hasChildNodes()

Determine if the node has any children.

Specified by:

hasChildNodes in interface NodeInfo

Overrides:

hasChildNodes in class NodeImpl

Returns:

true if the node has any children, false if the node has no children.

getFirstChild

public final NodeInfo getFirstChild()

Get the first child node of the element

Overrides:

getFirstChild in class NodeImpl

Returns:

the first child node of the required type, or null if there are no children

getLastChild

public final NodeInfo getLastChild()

Get the last child node of the element

Overrides:

getLastChild in class NodeImpl

Returns:

the last child of the element, or null if there are no children

getStringValue

public String getStringValue()

Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.

Returns:

the accumulated character content of the element, including descendant elements.

See Also:

Item.getStringValueCS()

getStringValueCS

public CharSequence getStringValueCS()

Description copied from class: NodeImpl

Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.

Specified by:

getStringValueCS in interface Item

Specified by:

getStringValueCS in interface ValueRepresentation

Overrides:

getStringValueCS in class NodeImpl

Returns:

the string value of the item

See Also:

Item.getStringValue()

addChild

public void addChild(NodeImpl node,
                     int index)

Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.

Parameters:

node - the node to be added as a child of this node

index - the position where the child is to be added

compact

public void compact(int size)

Compact the space used by this node

Parameters:

size - the number of actual children