com.icl.saxon.style

Class StyleElement

public abstract class StyleElement extends ElementWithAttributes implements Locator

Abstract superclass for all element nodes in the stylesheet.
Note: this class implements Locator. The element retains information about its own location in the stylesheet, which is useful when an XSL error is found.
Field Summary
protected VectorattributeSets
protected short[]extensionNamespaces
protected intreportingCircumstances
static intREPORT_ALWAYS
static intREPORT_IF_INSTANTIATED
static intREPORT_UNLESS_FORWARDS_COMPATIBLE
protected StaticContextstaticContext
protected TransformerConfigurationExceptionvalidationError
protected Stringversion
Constructor Summary
StyleElement()
Constructor
Method Summary
BindingbindVariable(int fingerprint)
Bind a variable used in this element to the XSLVariable element in which it is declared
voidcheckEmpty()
Convenience method to check that the stylesheet element is empty
voidcheckNotTopLevel()
Convenience method to check that the stylesheet element is not at the top level
voidcheckTopLevel()
Convenience method to check that the stylesheet element is at the top level
protected voidcheckUnknownAttribute(int nc)
Check whether an unknown attribute is permitted.
voidcheckWithinTemplate()
Check that the stylesheet element is within a template body
protected voidcompileError(TransformerException error)
Construct an exception with diagnostic information
protected voidcompileError(String message)
protected booleandefinesExcludedNamespace(short uriCode)
Check whether this node excludes a particular namespace from the result.
protected booleandefinesExtensionElement(short uriCode)
Check whether a particular extension element namespace is defined on this node.
booleandoesPostProcessing()
Determine whether this element does any processing after instantiating any children.
protected voidfallbackProcessing(StyleElement instruction, Context context)
Perform fallback processing
protected voidfindAttributeSets(String use)
Determine the list of attribute-sets associated with this element.
booleanforwardsCompatibleModeIsEnabled()
Determine whether forwards-compatible mode is enabled for this element
XSLStyleSheetgetContainingStyleSheet()
Get the containing XSLStyleSheet element
intgetPrecedence()
Get the import precedence of this stylesheet element.
PreparedStyleSheetgetPreparedStyleSheet()
Get the PreparedStyleSheet object.
protected XSLStyleSheetgetPrincipalStyleSheet()
Get the principal XSLStyleSheet node.
StandardNamesgetStandardNames()
Get the StandardNames object
FunctiongetStyleSheetFunction(int fingerprint)
Get a Function declared using a saxon:function element in the stylesheet
BindinggetVariableBinding(int fprint)
Bind a variable used in this element to the XSLVariable element in which it is declared
Enumeration[]getVariableNames()
List the variables that are in scope for this stylesheet element.
StringgetVersion()
Get the version number on this element, or inherited from its ancestors
protected ExpressionhandleSortKeys(Expression select)
Modify the "select" expression to include any sort keys specified.
booleanisExcludedNamespace(short uriCode)
Check whether a namespace uri defines an namespace excluded from the result.
booleanisExtensionNamespace(short uriCode)
Check whether a namespace uri defines an extension element.
booleanisInstruction()
Determine whether this node is an instruction.
booleanisTopLevel()
Test whether this is a top-level element
ExpressionmakeAttributeValueTemplate(String expression)
Make an attribute value template in the context of this stylesheet element
ExpressionmakeExpression(String expression)
Make an expression in the context of this stylesheet element
PatternmakePattern(String pattern)
Make a pattern in the context of this stylesheet element
booleanmayContainTemplateBody()
Determine whether this type of element is allowed to contain a template-body
abstract voidprepareAttributes()
Set the attribute list for the element.
voidpreprocess()
Default preprocessing method does nothing.
abstract voidprocess(Context context)
Process: called to do the real work of this stylesheet element.
voidprocessAllAttributes()
Process the attributes of this element and all its children
voidprocessAttributes()
Process the attribute list for the element.
protected voidprocessAttributeSets(Context context)
Expand the attribute sets referenced in this element's use-attribute-sets attribute
voidprocessChildren(Context context)
Process the children of this node in the stylesheet
protected voidprocessExcludedNamespaces(int nc)
Process the [xsl:]exclude-result-prefixes attribute if there is one
protected voidprocessExtensionElementAttribute(int nc)
Process the [xsl:]extension-element-prefixes attribute if there is one
protected voidprocessVersionAttribute(int nc)
Process the [xsl:]version attribute if there is one
voidreportAbsence(String attribute)
Convenience method to report the absence of a mandatory attribute
protected voidsetValidationError(TransformerException reason, int circumstances)
Set a validation error
protected TransformerExceptionstyleError(TransformerException error)
Construct an exception with diagnostic information
protected TransformerExceptionstyleError(String message)
voidsubstituteFor(StyleElement temp)
Make this node a substitute for a temporary one previously added to the tree.
voidvalidate()
Check that the element is valid.
protected voidvalidateChildren()
voidvalidateSubtree()
Recursive walk through the stylesheet to validate all nodes

Field Detail

attributeSets

protected Vector attributeSets

extensionNamespaces

protected short[] extensionNamespaces

reportingCircumstances

protected int reportingCircumstances

REPORT_ALWAYS

public static final int REPORT_ALWAYS

REPORT_IF_INSTANTIATED

public static final int REPORT_IF_INSTANTIATED

REPORT_UNLESS_FORWARDS_COMPATIBLE

public static final int REPORT_UNLESS_FORWARDS_COMPATIBLE

staticContext

protected StaticContext staticContext

validationError

protected TransformerConfigurationException validationError

version

protected String version

Constructor Detail

StyleElement

public StyleElement()
Constructor

Method Detail

bindVariable

public Binding bindVariable(int fingerprint)
Bind a variable used in this element to the XSLVariable element in which it is declared

Parameters: fingerprint The fingerprint of the name of the variable

Returns: a Binding for the variable

Throws: XPathException if the variable has not been declared

checkEmpty

public void checkEmpty()
Convenience method to check that the stylesheet element is empty

Throws: TransformerConfigurationException if it is not empty

checkNotTopLevel

public void checkNotTopLevel()
Convenience method to check that the stylesheet element is not at the top level

Throws: TransformerConfigurationException if it is at the top level

checkTopLevel

public void checkTopLevel()
Convenience method to check that the stylesheet element is at the top level

Throws: TransformerConfigurationException if not at top level

checkUnknownAttribute

protected void checkUnknownAttribute(int nc)
Check whether an unknown attribute is permitted.

Parameters: nc The name code of the attribute name

checkWithinTemplate

public void checkWithinTemplate()
Check that the stylesheet element is within a template body

Throws: TransformerConfigurationException if not within a template body

compileError

protected void compileError(TransformerException error)
Construct an exception with diagnostic information

compileError

protected void compileError(String message)

definesExcludedNamespace

protected boolean definesExcludedNamespace(short uriCode)
Check whether this node excludes a particular namespace from the result. This method checks this node only, not the ancestor nodes.

Parameters: uriCode the code of the namespace URI being tested

definesExtensionElement

protected boolean definesExtensionElement(short uriCode)
Check whether a particular extension element namespace is defined on this node. This checks this node only, not the ancestor nodes. The implementation checks whether the prefix is included in the [xsl:]extension-element-prefixes attribute.

Parameters: uriCode the namespace URI code being tested

doesPostProcessing

public boolean doesPostProcessing()
Determine whether this element does any processing after instantiating any children. The default implementation says it does. Tail recursion only works if call-template is nested entirely in elements that do no such processing. (If the element is empty, this property is irrelevant, because the element cannot contain an xsl:call-template).

fallbackProcessing

protected void fallbackProcessing(StyleElement instruction, Context context)
Perform fallback processing

findAttributeSets

protected void findAttributeSets(String use)
Determine the list of attribute-sets associated with this element. This is used for xsl:element, xsl:copy, xsl:attribute-set, and on literal result elements

forwardsCompatibleModeIsEnabled

public boolean forwardsCompatibleModeIsEnabled()
Determine whether forwards-compatible mode is enabled for this element

getContainingStyleSheet

public XSLStyleSheet getContainingStyleSheet()
Get the containing XSLStyleSheet element

getPrecedence

public int getPrecedence()
Get the import precedence of this stylesheet element.

getPreparedStyleSheet

public PreparedStyleSheet getPreparedStyleSheet()
Get the PreparedStyleSheet object.

Returns: the PreparedStyleSheet to which this stylesheet element belongs

getPrincipalStyleSheet

protected XSLStyleSheet getPrincipalStyleSheet()
Get the principal XSLStyleSheet node. This gets the principal style sheet, i.e. the one originally loaded, that forms the root of the import/include tree

getStandardNames

public final StandardNames getStandardNames()
Get the StandardNames object

getStyleSheetFunction

public Function getStyleSheetFunction(int fingerprint)
Get a Function declared using a saxon:function element in the stylesheet

Parameters: fingerprint the fingerprint of the name of the function

Returns: the Function object represented by this saxon:function; or null if not found

getVariableBinding

public Binding getVariableBinding(int fprint)
Bind a variable used in this element to the XSLVariable element in which it is declared

Parameters: fprint The absolute name of the variable (as a namepool fingerprint)

Returns: a Binding for the variable, or null if it has not been declared

getVariableNames

public Enumeration[] getVariableNames()
List the variables that are in scope for this stylesheet element. Designed for a debugger, not used by the processor.

Returns: two Enumeration of Strings, the global ones [0] and the local ones [1]

getVersion

public String getVersion()
Get the version number on this element, or inherited from its ancestors

handleSortKeys

protected Expression handleSortKeys(Expression select)
Modify the "select" expression to include any sort keys specified. Used in XSLForEach and XSLApplyTemplates

isExcludedNamespace

public boolean isExcludedNamespace(short uriCode)
Check whether a namespace uri defines an namespace excluded from the result. This checks whether the namespace is defined as an excluded namespace on this or any ancestor node.

Parameters: uriCode the code of the namespace URI being tested

isExtensionNamespace

public boolean isExtensionNamespace(short uriCode)
Check whether a namespace uri defines an extension element. This checks whether the namespace is defined as an extension namespace on this or any ancestor node.

Parameters: uriCode the namespace URI code being tested

isInstruction

public boolean isInstruction()
Determine whether this node is an instruction. The default implementation says it isn't.

isTopLevel

public boolean isTopLevel()
Test whether this is a top-level element

makeAttributeValueTemplate

public Expression makeAttributeValueTemplate(String expression)
Make an attribute value template in the context of this stylesheet element

makeExpression

public Expression makeExpression(String expression)
Make an expression in the context of this stylesheet element

makePattern

public Pattern makePattern(String pattern)
Make a pattern in the context of this stylesheet element

mayContainTemplateBody

public boolean mayContainTemplateBody()
Determine whether this type of element is allowed to contain a template-body

prepareAttributes

public abstract void prepareAttributes()
Set the attribute list for the element. This is called to process the attributes (note the distinction from processAttributes in the superclass). Must be supplied in a subclass

preprocess

public void preprocess()
Default preprocessing method does nothing. It is implemented for those top-level elements that can be evaluated before the source document is available, for example xsl:key, xsl:attribute-set, xsl:template, xsl:locale

process

public abstract void process(Context context)
Process: called to do the real work of this stylesheet element. This method must be implemented in each subclass.

Parameters: context The context in the source XML document, giving access to the current node, the current variables, etc.

processAllAttributes

public void processAllAttributes()
Process the attributes of this element and all its children

processAttributes

public final void processAttributes()
Process the attribute list for the element. This is a wrapper method that calls prepareAttributes (provided in the subclass) and traps any exceptions

processAttributeSets

protected void processAttributeSets(Context context)
Expand the attribute sets referenced in this element's use-attribute-sets attribute

processChildren

public void processChildren(Context context)
Process the children of this node in the stylesheet

Parameters: context The context in the source XML document, giving access to the current node, the current variables, etc.

processExcludedNamespaces

protected void processExcludedNamespaces(int nc)
Process the [xsl:]exclude-result-prefixes attribute if there is one

Parameters: nc the name code of the attribute required

processExtensionElementAttribute

protected void processExtensionElementAttribute(int nc)
Process the [xsl:]extension-element-prefixes attribute if there is one

Parameters: nc the name code of the attribute required

processVersionAttribute

protected void processVersionAttribute(int nc)
Process the [xsl:]version attribute if there is one

Parameters: nc the name code of the attribute required

reportAbsence

public void reportAbsence(String attribute)
Convenience method to report the absence of a mandatory attribute

Throws: TransformerConfigurationException if the attribute is missing

setValidationError

protected void setValidationError(TransformerException reason, int circumstances)
Set a validation error

styleError

protected TransformerException styleError(TransformerException error)
Construct an exception with diagnostic information

styleError

protected TransformerException styleError(String message)

substituteFor

public void substituteFor(StyleElement temp)
Make this node a substitute for a temporary one previously added to the tree. See StyleNodeFactory for details. "A node like the other one in all things but its class". Note that at this stage, the node will not yet be known to its parent, though it will contain a reference to its parent; and it will have no children.

validate

public void validate()
Check that the element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.

validateChildren

protected void validateChildren()

validateSubtree

public void validateSubtree()
Recursive walk through the stylesheet to validate all nodes