net.sf.saxon.style

Class PrincipalStylesheetModule

java.lang.Object

net.sf.saxon.style.StylesheetModule

net.sf.saxon.style.PrincipalStylesheetModule

All Implemented Interfaces:

GlobalVariableManager

Direct Known Subclasses:

PrincipalStylesheetModuleEE

public class PrincipalStylesheetModule
extends StylesheetModule
implements GlobalVariableManager

Represents both the stylesheet module at the root of the import tree, that is, the module that includes or imports all the others, and also the XSLT package that has this stylesheet module as its root.

This version of the StylesheetPackage class represents a trivial package that is constructed by the system to wrap an ordinary (non-package) stylesheet, as available in XSLT 2.0. A subclass is used for "real" packages, currently available only in Saxon-EE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrincipalStylesheetModule.Action A class that simply encapsulates a callback action of any kind

Field Summary

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

topLevel

Constructor Summary

Constructors

Constructor and Description
PrincipalStylesheetModule(XSLPackage sourceElement) Create a PrincipalStylesheetModule

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompletionAction(PrincipalStylesheetModule.Action action) Register a callback action to be performed during the completion phase
void	addFixupAction(PrincipalStylesheetModule.Action action) Register a callback action to be performed during the fixup phase
void	addGlobalVariable(GlobalVariable variable) Add a global variable to the collection
protected void	addImportedSchema(String targetNamespace)
protected void	addNamespaceAlias(ComponentDeclaration node)
void	adjustExposedVisibility() Adjust visibility of components by applying xsl:expose rules
int	allocateUniqueParameterNumber(StructuredQName qName) Allocate a unique number to a local parameter name.
boolean	checkAcceptableModeForPackage(XSLTemplate template, Mode mode) Check that it is legitimate to add a given template rule to a given mode
protected void	checkStreamability(AttributeSet aSet) Check the streamability of an attribute set declared within this stylesheet module.
protected void	compile(Compilation compilation) Compile the source XSLT stylesheet package
protected void	compileError(String message, String errorCode) Compile time error, specifying an error code
protected void	compileError(XPathException error) Report an error with diagnostic information
protected void	complete()
void	declareXQueryFunction(XQueryFunction function) Declare an imported XQuery function
void	findKeyablePatterns(Compilation compilation) Find possibly keyable patterns, accumulating them in the PatternOptimization and then emitting the necessary key definitions
protected void	fixup()
Properties	gatherOutputProperties(StructuredQName formatQName) Create an output properties object representing the xsl:output elements in the stylesheet.
IAccumulatorRegistry	getAccumulatorManager() Get the class that manages accumulator functions
List<ComponentDeclaration>	getAttributeSetDeclarations(StructuredQName name) Return all the attribute set declarations in the package having a particular QName
protected boolean	getAttributeSets(StructuredQName name, List<ComponentDeclaration> list) Get the list of attribute-set declarations associated with a given QName.
ComponentDeclaration	getCharacterMap(StructuredQName name) Get a character map, identified by the fingerprint of its name.
CharacterMapIndex	getCharacterMapIndex() Get an index of character maps declared using xsl:character-map entries in this package
Component	getComponent(SymbolicName name) Search the package for a component with a given name
DecimalFormatManager	getDecimalFormatManager() Get the decimal format manager used to manage xsl:decimal-format declarations in this package
GlobalVariable	getGlobalVariable(StructuredQName name) Get the global variable with a specific name
SourceBinding	getGlobalVariableBinding(StructuredQName qName) Get the global variable or parameter with a given name (taking precedence rules into account).
Collection<StructuredQName>	getGlobalVariableNames() Get the names of all global variables in the collection
protected Set<String>	getImportedSchemaTable()
KeyManager	getKeyManager() Get the key manager used to manage xsl:key declarations in this package
NamedTemplate	getNamedTemplate(StructuredQName name) Get the named template with a given name
protected NamespaceBinding	getNamespaceAlias(String uri) Get the declared namespace alias for a given namespace URI code if there is one.
PrincipalStylesheetModule	getPrincipalStylesheetModule() Get the outermost stylesheet module in a package
RuleManager	getRuleManager() Get the rule manager used to manage modes declared explicitly or implicitly in this package
SlotManager	getSlotManager()
XSLModuleRoot	getStylesheetDocument(DocumentURI key) Get a module from the cache of stylesheet modules
StylesheetPackage	getStylesheetPackage() Get the stylesheet package
protected boolean	hasNamespaceAliases()
protected void	importSchemata() Process import-schema declarations
protected void	indexAttributeSet(ComponentDeclaration decl) Add an attribute set to the index
protected void	indexFunction(ComponentDeclaration decl) Add a stylesheet function to the index
void	indexMode(ComponentDeclaration decl) Handle an explicitly-declared mode
protected void	indexNamedTemplate(ComponentDeclaration decl) Add a named template to the index
protected void	indexVariableDeclaration(ComponentDeclaration decl) Index a global xsl:variable or xsl:param element
protected boolean	isAliasResultNamespace(String uri) Determine if a namespace is included in the result-prefix of a namespace-alias
boolean	isAttributeSetDeclaredStreamable(StructuredQName name) Ask whether a particular attribute set exists and is declared streamable
boolean	isDeclaredModes() Ask whether it is required that modes be explicitly declared
protected boolean	isImportedSchema(String targetNamespace) Get an imported schema with a given namespace
boolean	isRootPackage()
void	optimizeTopLevel()
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	putStylesheetDocument(DocumentURI key, XSLStylesheet module) Add a module to the cache of stylesheet modules
void	removeGlobalVariable(ComponentDeclaration decl) Remove a global variable if it is found to be redundant, i.e.
void	setAccumulatorManager(IAccumulatorRegistry accumulatorManager) Set the class that manages accumulator functions
void	setNeedsDynamicOutputProperties(boolean b) Say that this stylesheet package needs dynamic output properties
protected void	spliceUsePackages(XSLPackage xslpackage, Compilation compilation) Incorporate declarations from used packages

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

getAssociatedStylesheet, getConfiguration, getImporter, getInputTypeAnnotations, getMinImportPrecedence, getPrecedence, getRootElement, getStylesheetElement, loadStylesheet, loadStylesheetModule, setImporter, setInputTypeAnnotations, setMinImportPrecedence, setWasIncluded, spliceIncludes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrincipalStylesheetModule

public PrincipalStylesheetModule(XSLPackage sourceElement)
                          throws XPathException

Create a PrincipalStylesheetModule

Parameters:

sourceElement - the xsl:package element at the root of the package manifest

Throws:

XPathException

Method Detail

getComponent

public Component getComponent(SymbolicName name)

Search the package for a component with a given name

Parameters:

name - the symbolic name of the required component

Returns:

the requested component if found, or null otherwise

removeGlobalVariable

public void removeGlobalVariable(ComponentDeclaration decl)

Remove a global variable if it is found to be redundant, i.e. it is private to the package and not referenced

Parameters:

decl - the global variable to be removed

getPrincipalStylesheetModule

public PrincipalStylesheetModule getPrincipalStylesheetModule()

Get the outermost stylesheet module in a package

Overrides:

getPrincipalStylesheetModule in class StylesheetModule

Returns:

this module (this class represents both the package and its outermost module)

getStylesheetPackage

public StylesheetPackage getStylesheetPackage()

Get the stylesheet package

Returns:

the associated stylesheet package

getKeyManager

public KeyManager getKeyManager()

Get the key manager used to manage xsl:key declarations in this package

Returns:

the key manager

getDecimalFormatManager

public DecimalFormatManager getDecimalFormatManager()

Get the decimal format manager used to manage xsl:decimal-format declarations in this package

Returns:

the decimal format manager

getRuleManager

public RuleManager getRuleManager()

Get the rule manager used to manage modes declared explicitly or implicitly in this package

Returns:

the rule manager

isDeclaredModes

public boolean isDeclaredModes()

Ask whether it is required that modes be explicitly declared

Returns:

true if modes referenced within this package must be explicitly declared

addFixupAction

public void addFixupAction(PrincipalStylesheetModule.Action action)

Register a callback action to be performed during the fixup phase

Parameters:

action - the callback action

addCompletionAction

public void addCompletionAction(PrincipalStylesheetModule.Action action)

Register a callback action to be performed during the completion phase

Parameters:

action - the callback action

setNeedsDynamicOutputProperties

public void setNeedsDynamicOutputProperties(boolean b)

Say that this stylesheet package needs dynamic output properties

Parameters:

b - true if this stylesheet needs dynamic output properties

getCharacterMapIndex

public CharacterMapIndex getCharacterMapIndex()

Get an index of character maps declared using xsl:character-map entries in this package

Returns:

the character map index

declareXQueryFunction

public void declareXQueryFunction(XQueryFunction function)
                           throws XPathException

Declare an imported XQuery function

Parameters:

function - the imported function

Throws:

XPathException - if an error occurs

putStylesheetDocument

public void putStylesheetDocument(DocumentURI key,
                         XSLStylesheet module)

Add a module to the cache of stylesheet modules

Parameters:

key - the key to be used (based on the absolute URI)

module - the stylesheet document tree corresponding to this absolute URI

getStylesheetDocument

public XSLModuleRoot getStylesheetDocument(DocumentURI key)

Get a module from the cache of stylesheet modules

Parameters:

key - the key to be used (based on the absolute URI)

Returns:

the stylesheet document tree corresponding to this absolute URI

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 - if errors are found in the stylesheet

spliceUsePackages

protected void spliceUsePackages(XSLPackage xslpackage,
                     Compilation compilation)
                          throws XPathException

Incorporate declarations from used packages

Parameters:

xslpackage - the used package

compilation - this compilation

Throws:

XPathException - if any error is detected in the used package

importSchemata

protected void importSchemata()
                       throws XPathException

Process import-schema declarations

Throws:

XPathException - if errors are detected

processAllAttributes

public void processAllAttributes()
                          throws XPathException

Process the attributes of every node in the stylesheet

Throws:

XPathException - if static errors are found in the stylesheet

indexFunction

protected void indexFunction(ComponentDeclaration decl)
                      throws XPathException

Add a stylesheet function to the index

Parameters:

decl - The declaration wrapping an XSLFunction object

Throws:

XPathException - if errors are found

indexVariableDeclaration

protected void indexVariableDeclaration(ComponentDeclaration decl)
                                 throws XPathException

Index a global xsl:variable or xsl:param element

Parameters:

decl - The Declaration referencing the XSLVariable or XSLParam element

Throws:

XPathException - if an error occurs

getGlobalVariableBinding

public SourceBinding getGlobalVariableBinding(StructuredQName qName)

Get the global variable or parameter with a given name (taking precedence rules into account). This will only return global variables declared in the same package where they are used.

Parameters:

qName - name of the global variable or parameter

Returns:

the variable declaration, or null if it does not exist

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

indexNamedTemplate

protected void indexNamedTemplate(ComponentDeclaration decl)
                           throws XPathException

Add a named template to the index

Parameters:

decl - the declaration of the Template object

Throws:

XPathException - if an error occurs

getNamedTemplate

public NamedTemplate getNamedTemplate(StructuredQName name)

Get the named template with a given name

Parameters:

name - the name of the required template

Returns:

the template with the given name, if there is one, or null otherwise. If there are several templates with the same name, the one with highest import precedence is returned. Note that this template may subsequently be overridden in another package, but only by another template with a compatible signature.

indexAttributeSet

protected void indexAttributeSet(ComponentDeclaration decl)
                          throws XPathException

Add an attribute set to the index

Parameters:

decl - the declaration of the attribute set object

Throws:

XPathException - if an error occurs

getAttributeSetDeclarations

public List<ComponentDeclaration> getAttributeSetDeclarations(StructuredQName name)

Return all the attribute set declarations in the package having a particular QName

Parameters:

name - the name of the required declarations

Returns:

the set of declarations having this name, or null if there are none

isAttributeSetDeclaredStreamable

public boolean isAttributeSetDeclaredStreamable(StructuredQName name)

Ask whether a particular attribute set exists and is declared streamable

Parameters:

name - the name of the required attribute set

Returns:

true if it exists and is declared streamable

checkStreamability

protected void checkStreamability(AttributeSet aSet)
                           throws XPathException

Check the streamability of an attribute set declared within this stylesheet module. (Null implementation for Saxon-HE).

Parameters:

aSet - the attribute set to be checked

Throws:

XPathException - if the streamability rules are not satisifed

getAttributeSets

protected boolean getAttributeSets(StructuredQName name,
                       List<ComponentDeclaration> list)
                            throws XPathException

Get the list of attribute-set declarations associated with a given QName. This is used for xsl:element, xsl:copy, xsl:attribute-set, and on literal result elements

Parameters:

name - the name of the required attribute set

list - a list to hold the list of XSLAttributeSet elements in the stylesheet tree.

Returns:

true if any declarations were found and added to the list; false if none were found

Throws:

XPathException - if an error occurs

indexMode

public void indexMode(ComponentDeclaration decl)
               throws XPathException

Handle an explicitly-declared mode

Parameters:

decl - the declaration of the Mode object

Throws:

XPathException - if an error occurs

checkAcceptableModeForPackage

public boolean checkAcceptableModeForPackage(XSLTemplate template,
                                    Mode mode)
                                      throws XPathException

Check that it is legitimate to add a given template rule to a given mode

Parameters:

template - the template rule

mode - the mode

Returns:

true if all is well

Throws:

XPathException - if the mode is declared in a used package and the template is not declared within the relevant xsl:mode declaration

getAccumulatorManager

public IAccumulatorRegistry getAccumulatorManager()

Get the class that manages accumulator functions

Returns:

the class that manages accumulators. Always null in Saxon-HE

setAccumulatorManager

public void setAccumulatorManager(IAccumulatorRegistry accumulatorManager)

Set the class that manages accumulator functions

Parameters:

accumulatorManager - the manager of accumulator functions

addNamespaceAlias

protected void addNamespaceAlias(ComponentDeclaration node)

getNamespaceAlias

protected NamespaceBinding getNamespaceAlias(String uri)

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:

uri - The uri used in the stylesheet.

Returns:

The namespace binding to be used (prefix and uri): return null if no alias is defined

isAliasResultNamespace

protected boolean isAliasResultNamespace(String uri)

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

Parameters:

uri - the namespace URI

Returns:

true if an xsl:namespace-alias has been defined for this namespace URI

hasNamespaceAliases

protected boolean hasNamespaceAliases()

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

compile

protected void compile(Compilation compilation)
                throws XPathException

Compile the source XSLT stylesheet package

Parameters:

compilation - the compilation episode

Throws:

XPathException - if compilation fails for any reason

optimizeTopLevel

public void optimizeTopLevel()
                      throws XPathException

Throws:

XPathException

isImportedSchema

protected boolean isImportedSchema(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(String targetNamespace)

getImportedSchemaTable

protected Set<String> getImportedSchemaTable()

getCharacterMap

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

adjustExposedVisibility

public void adjustExposedVisibility()
                             throws XPathException

Adjust visibility of components by applying xsl:expose rules

Throws:

XPathException

compileError

protected void compileError(String message,
                String errorCode)
                     throws XPathException

Compile time error, specifying an error code

Parameters:

message - the error message

errorCode - the error code. May be null if not known or not defined

Throws:

XPathException - unconditionally

compileError

protected void compileError(XPathException error)
                     throws XPathException

Report an error with diagnostic information

Parameters:

error - contains information about the error

Throws:

XPathException - unconditionally, after reporting the error to the ErrorListener

isRootPackage

public boolean isRootPackage()

fixup

protected void fixup()
              throws XPathException

Throws:

XPathException

complete

protected void complete()
                 throws XPathException

Throws:

XPathException

getSlotManager

public SlotManager getSlotManager()

getGlobalVariableNames

public Collection<StructuredQName> getGlobalVariableNames()

Description copied from interface: GlobalVariableManager

Get the names of all global variables in the collection

Specified by:

getGlobalVariableNames in interface GlobalVariableManager

Returns:

the collections of global variables

getGlobalVariable

public GlobalVariable getGlobalVariable(StructuredQName name)

Description copied from interface: GlobalVariableManager

Get the global variable with a specific name

Specified by:

getGlobalVariable in interface GlobalVariableManager

Parameters:

name - the name of the required global variable

Returns:

the global variable in question

addGlobalVariable

public void addGlobalVariable(GlobalVariable variable)

Description copied from interface: GlobalVariableManager

Add a global variable to the collection

Specified by:

addGlobalVariable in interface GlobalVariableManager

Parameters:

variable - the variable to be added

findKeyablePatterns

public void findKeyablePatterns(Compilation compilation)
                         throws XPathException

Find possibly keyable patterns, accumulating them in the PatternOptimization and then emitting the necessary key definitions

Parameters:

compilation -

Throws:

XPathException