net.sf.saxon.style

Class StyleNodeFactory

java.lang.Object

net.sf.saxon.style.StyleNodeFactory

All Implemented Interfaces:

NodeFactory

Direct Known Subclasses:

StyleNodeFactoryPE

public class StyleNodeFactory
extends Object
implements NodeFactory

Class StyleNodeFactory.
A Factory for nodes in the stylesheet tree.
Currently only allows Element nodes to be user-constructed.

Author:

Michael H. Kay

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	config
protected NamePool	namePool

Constructor Summary

Constructors

Constructor and Description
StyleNodeFactory(Configuration config, Compilation compilation) Create the node factory for representing an XSLT stylesheet as a tree structure

Method Summary

Methods

Modifier and Type	Method and Description
void	compileContentValueTemplate(TextImpl node, List<Expression> contents) Compile a content value text node.
Compilation	getCompilation()
Configuration	getConfiguration()
int	getXsltProcessorVersion() Get the XSLT processor version to be used by this node factory.
boolean	isElementAvailable(String uri, String localName, boolean instructionsOnly) Method to support the element-available() function
boolean	isTopLevelModule() Ask whether this is the top-level module of a package
boolean	isXSLOverride(NodeImpl node) Test whether an element is an XSLOverride element
IAccumulatorRegistry	makeAccumulatorManager()
Expression	makeConditionalBlock(List<Expression> content) Make an expression representing a sequence constructor with contained xsl:on-empty and xsl:on-non-empty instructions
ElementImpl	makeElementNode(NodeInfo parent, NodeName elemName, SchemaType elemType, boolean isNilled, AttributeCollectionImpl attlist, NamespaceBinding[] namespaces, int namespacesUsed, PipelineConfiguration pipe, Location location, int sequence) Create an Element node.
TextImpl	makeTextNode(NodeInfo parent, CharSequence content) Make a text node
protected StyleElement	makeXSLElement(int f, NodeImpl parent) Make an XSL element node
PrincipalStylesheetModule	newPrincipalModule(XSLPackage node) Create a stylesheet package
void	setTopLevelModule(boolean topLevelModule) Say that this is the top-level module of a package
boolean	validateTextNode(NodeInfo node) Validate a text node in the stylesheet

Methods inherited from class java.lang.Object

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

Field Detail

config

protected Configuration config

namePool

protected NamePool namePool

Constructor Detail

StyleNodeFactory

public StyleNodeFactory(Configuration config,
                Compilation compilation)

Create the node factory for representing an XSLT stylesheet as a tree structure

Parameters:

config - the Saxon configuration

compilation - the compilation episode (compiling one package)

Method Detail

setTopLevelModule

public void setTopLevelModule(boolean topLevelModule)

Say that this is the top-level module of a package

Parameters:

topLevelModule - true if this stylesheet module is the top level of a package; false if it is included or imported

isTopLevelModule

public boolean isTopLevelModule()

Ask whether this is the top-level module of a package

Returns:

true if this stylesheet module is the top level of a package; false if it is included or imported

getCompilation

public Compilation getCompilation()

getConfiguration

public Configuration getConfiguration()

getXsltProcessorVersion

public int getXsltProcessorVersion()

Get the XSLT processor version to be used by this node factory.

Returns:

the processor version, times ten. (Always 2.0 or 3.0 once the stylesheet version attribute has been read)

makeElementNode

public ElementImpl makeElementNode(NodeInfo parent,
                          NodeName elemName,
                          SchemaType elemType,
                          boolean isNilled,
                          AttributeCollectionImpl attlist,
                          NamespaceBinding[] namespaces,
                          int namespacesUsed,
                          PipelineConfiguration pipe,
                          Location location,
                          int sequence)

Create an Element node. Note, if there is an error detected while constructing the Element, we add the element anyway, and return success, but flag the element with a validation error. This allows us to report more than one error from a single compilation.

Specified by:

makeElementNode in interface NodeFactory

Parameters:

parent - The parent element

elemName - The element name

elemType - The type annotation of the element

isNilled - true if the element is to be marked as nilled

attlist - The attribute collection, excluding any namespace attributes

namespaces - List of new namespace declarations for this element, as a sequence of namespace codes representing pairs of strings: (prefix1, uri1), (prefix2, uri2)...

namespacesUsed - the number of elemnts of the namespaces array actually used

pipe - The pipeline configuration (provides access to the error listener and the location provider)

location - Indicates the source document and line number containing the node

sequence - Sequence number to be assigned to represent document order.

makeXSLElement

protected StyleElement makeXSLElement(int f,
                          NodeImpl parent)

Make an XSL element node

Parameters:

f - the fingerprint of the node name

parent - the parent node

Returns:

the constructed element node

makeTextNode

public TextImpl makeTextNode(NodeInfo parent,
                    CharSequence content)

Make a text node

Specified by:

makeTextNode in interface NodeFactory

Parameters:

content - the content of the text node

Returns:

the constructed text node

isElementAvailable

public boolean isElementAvailable(String uri,
                         String localName,
                         boolean instructionsOnly)

Method to support the element-available() function

Parameters:

uri - the namespace URI

localName - the local Name

instructionsOnly - true if only instruction elements qualify

Returns:

true if an extension element of this name is recognized

makeAccumulatorManager

public IAccumulatorRegistry makeAccumulatorManager()

validateTextNode

public boolean validateTextNode(NodeInfo node)
                         throws XPathException

Validate a text node in the stylesheet

Parameters:

node - the text node

Returns:

true if the node is a text value template containing one or more expressions

Throws:

XPathException - if the node is invalid

compileContentValueTemplate

public void compileContentValueTemplate(TextImpl node,
                               List<Expression> contents)
                                 throws XPathException

Compile a content value text node. Dummy implementation (these can exist only in Saxon-PE or higher)

Parameters:

node - the text node potentially containing the template

contents - a list to which expressions representing the fixed and variable parts of the content template will be appended

Throws:

XPathException - if a static error is found

isXSLOverride

public boolean isXSLOverride(NodeImpl node)

Test whether an element is an XSLOverride element

Parameters:

node - the element to be tested

Returns:

true if the element is an xsl:override element

newPrincipalModule

public PrincipalStylesheetModule newPrincipalModule(XSLPackage node)
                                             throws XPathException

Create a stylesheet package

Parameters:

node - the XSLPackage element

Returns:

a new stylesheet package

Throws:

XPathException

makeConditionalBlock

public Expression makeConditionalBlock(List<Expression> content)
                                throws XPathException

Make an expression representing a sequence constructor with contained xsl:on-empty and xsl:on-non-empty instructions

Parameters:

content - the full list of compiled instructions, including OnEmpty and OnNotEmpty expressions

Returns:

the expression to evaluate the extended sequence constructor

Throws:

XPathException - if (for example) XSLT 3.0 is not enabled.