Package net.sf.saxon.style
Class StyleElement
java.lang.Object
net.sf.saxon.tree.linked.NodeImpl
net.sf.saxon.tree.linked.ParentNodeImpl
net.sf.saxon.tree.linked.ElementImpl
net.sf.saxon.style.StyleElement
- All Implemented Interfaces:
Source
,SourceLocator
,GroundedValue
,Item
,MutableNodeInfo
,NamespaceResolver
,NodeInfo
,Sequence
,Location
,SteppingNode<NodeImpl>
,SiblingCountingNode
,Locator
- Direct Known Subclasses:
AbsentExtensionElement
,ExtensionInstruction
,LiteralResultElement
,XSLAcceptExpose
,XSLAccumulator
,XSLAccumulatorRule
,XSLAnalyzeString
,XSLApplyImports
,XSLApplyTemplates
,XSLAssert
,XSLAttributeSet
,XSLBreakOrContinue
,XSLCallTemplate
,XSLCatch
,XSLCharacterMap
,XSLChoose
,XSLContextItem
,XSLCopy
,XSLCopyOf
,XSLDecimalFormat
,XSLDocument
,XSLElement
,XSLEvaluate
,XSLFallback
,XSLForEach
,XSLForEachGroup
,XSLFork
,XSLFunction
,XSLGeneralIncorporate
,XSLGeneralVariable
,XSLGlobalVariable
,XSLIf
,XSLImportSchema
,XSLIterate
,XSLKey
,XSLLeafNodeConstructor
,XSLMap
,XSLMapEntry
,XSLMatchingSubstring
,XSLMerge
,XSLMergeAction
,XSLMergeSource
,XSLMessage
,XSLMode
,XSLModuleRoot
,XSLNamespaceAlias
,XSLNextMatch
,XSLNumber
,XSLOnCompletion
,XSLOtherwise
,XSLOutput
,XSLOutputCharacter
,XSLOverride
,XSLPerformSort
,XSLPreserveSpace
,XSLResultDocument
,XSLSequence
,XSLSortOrMergeKey
,XSLSourceDocument
,XSLTemplate
,XSLTry
,XSLUsePackage
,XSLWhen
,XSLWherePopulated
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 XSLT static error is found.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
protected int
protected String
protected StructuredQName
protected String
protected boolean
protected String[]
protected StyleElement.OnFailure
protected ExpressionContext
protected XmlProcessingIncident
protected int
(package private) static final String[]
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER
Fields inherited from interface net.sf.saxon.om.NodeInfo
IS_DTD_TYPE, IS_NILLED
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) void
Allocate slots in the local stack frame to range variables used in an XPath expressionprotected Location
Allocate a locationbindLocalVariable
(StructuredQName qName) Bind a variable reference used in this element to the compiled form of the XSLVariable element in which it is declared, considering only local variables and paramsbindVariable
(StructuredQName qName) Bind a variable used in this element to the compiled form of the XSLVariable element in which it is declared(package private) boolean
Ask whether this instruction requires a different retained static context from the containing (parent) instruction.(package private) void
checkAttributeValue
(String name, String value, boolean avt, String[] allowed) Check the value of an attribute, as supplied staticallyvoid
Convenience method to check that the stylesheet element is empty(package private) void
checkSortComesFirst
(boolean sortRequired) Check that among the children of this element, any xsl:sort elements precede any other elementsvoid
checkTopLevel
(String errorCode, boolean allowOverride) Convenience method to check that the stylesheet element is at the top level (that is, as a child of xsl:stylesheet or xsl:transform)protected void
Check whether an unknown attribute is permitted.compile
(Compilation compilation, ComponentDeclaration decl) Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.(package private) void
compileContentValueTemplate
(TextImpl node, List<Expression> contents) Compile a content value text node.void
compileDeclaration
(Compilation compilation, ComponentDeclaration decl) Compile a declaration in the stylesheet tree for use at run-time.void
compileError
(String message) Report a static error in the stylesheetvoid
compileError
(String message, String errorCode) Compile time error, specifying an error codevoid
compileError
(String message, String errorCode, Location loc) void
compileError
(String message, StructuredQName errorCode) Compile time error, specifying an error codevoid
compileError
(XmlProcessingError error) Report an error with diagnostic informationvoid
void
compileErrorInAttribute
(String message, String errorCode, String attributeName) Compile time error, specifying an error code and the name of the attribute that is in error.compileSequenceConstructor
(Compilation compilation, ComponentDeclaration decl, boolean includeParams) Compile the children of this instruction on the stylesheet tree, adding the subordinate instructions to the parent instruction on the execution tree.compileSequenceConstructor
(Compilation compilation, ComponentDeclaration decl, SequenceIterator iter, boolean includeParams) Compile the children of this instruction on the stylesheet tree, adding the subordinate instructions to the parent instruction on the execution tree.void
compileWarning
(String message, String errorCode) void
compileWarning
(String message, String errorCode, Location location) void
compileWarning
(String message, StructuredQName errorCode) (package private) Expression
fallbackProcessing
(Compilation exec, ComponentDeclaration decl, StyleElement instruction) Perform fallback processing.(package private) StyleElement
findAncestorElement
(int fingerprint) Get the first ancestor element in the stylesheet tree that has a given name, supplied by fingerprint.(package private) StringCollator
findCollation
(String name, String baseURI) Find a named collation.void
Fix up references from XPath expressions.(package private) boolean
Determine whether forwards-compatible mode is enabled for this elementprotected String
getAttributeValue
(String clarkName) Get an attribute value given the Clark name of the attribute (that is, the name in {uri}local format).Get the base URI of the element, which acts as the static base URI for XPath expressions defined on this element.Ask whether this element contains a binding for a variable with a given name; and if it does, return the source binding informationGet the configurationGet the containing package (the principal stylesheet module of the package in which this XSLT element appears)Get the SlotManager for the containing Procedure definitionGet the visibility of the component.protected String
Get the default collation for this stylesheet element.(package private) StructuredQName
Get the default mode for this stylesheet element.(package private) int
Get the effective value of the default-validation attributeGet the default XPath namespace for elements and types(package private) int
Get the numeric value of the version number appearing as an attribute on this element, or inherited from its ancestors(package private) StyleElement
Find the last child instruction of this instruction.Get the namespace context of the instruction.Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.(package private) Component
Get the component that this declaration overrides, or null if this is not an overriding declarationGet the principal stylesheet module of the package in which this XSLT element appearsGet an iterator over all the properties available.getSchemaType
(String typeAtt) Get the Schema type definition for a type named in the stylesheet (in a "type" attribute).Get the static context for expressions on this elementgetStaticContext
(StructuredQName attributeName) getTypeAnnotation
(SchemaType schemaType) Get the type annotation to use for a given schema type(package private) StructuredQName[]
Get the list of attribute-set names associated with this element.Assuming this is an xsl:use-package element, find the package to which it refers.Get the visibility of the component.getWithParamInstructions
(Expression parent, Compilation compilation, ComponentDeclaration decl, boolean tunnel) Get the list of xsl:with-param elements for a calling element (apply-templates, call-template, apply-imports, next-match).getXslOriginal
(int componentKind) Check that a reference to xsl:original appears within an xsl:override element, and that the name of the containing component matches the name of a component in the used stylesheet package; return the component in that package with matching symbolic nameprotected SourceBinding
Ask whether this particular element implicitly binds a given variable (used for xsl:accumulator-rule)void
index
(ComponentDeclaration decl, PrincipalStylesheetModule top) Method supplied by declaration elements to add themselves to a stylesheet-level index(package private) Visibility
interpretVisibilityValue
(String s, String flags) Process the value of the visibility attribute (XSLT 3.0).protected void
invalidAttribute
(String attributeName, String allowedValues) (package private) boolean
isActionCompleted
(int action) Ask if an action on this StyleElement has been completed(package private) boolean
Ask whether this is an instruction that is known to be constructing nodes which will become children of a parent document or element node, and will not have an independent existence of their own.boolean
Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import).(package private) boolean
Check whether a namespace uri defines an namespace excluded from the result.(package private) boolean
Ask whether content value templates are available within this elementprotected boolean
isExtensionAttributeAllowed
(String attribute) Ask if an extension attribute is allowed; if no Professional Edition license is available, issue a warning saying the attribute is ignored, and return falseboolean
Check whether a namespace uri defines an extension element.boolean
Ask whether this node is an instruction.(package private) static boolean
protected boolean
isPermittedChild
(StyleElement child) Check whether a given child is permitted for this element.boolean
Ask whether the code is compiled in schema-aware modeprotected void
issueWarning
(String message, SourceLocator locator) Report a warning to the error listenerprotected void
issueWarning
(XPathException error) Report a warning to the error listenerboolean
Test whether this is a top-level elementprotected boolean
(package private) static boolean
protected Expression
makeAttributeValueTemplate
(String expression, AttributeInfo att) Make an attribute value template in the context of this stylesheet elementmakeExpression
(String expression, AttributeInfo att) Compile an XPath expression in the context of this stylesheet elementMake an expression visitor(package private) SequenceType
makeExtendedSequenceType
(String sequenceType) (package private) Pattern
makePattern
(String pattern, String attributeName) Make a pattern in the context of this stylesheet elementfinal StructuredQName
Make a structured QName, using this Element as the context for namespace resolution.makeSequenceType
(String sequenceType) Process an attribute whose value is a SequenceType(package private) SortKeyDefinitionList
makeSortKeys
(Compilation compilation, ComponentDeclaration decl) Construct sort keys for a SortedIteratorprotected boolean
Mark tail-recursive calls on templates and functions.protected boolean
Determine whether this type of element is allowed to contain an xsl:fallback instruction.protected boolean
Determine whether this type of element is allowed to contain an xsl:param elementprotected boolean
Determine whether this type of element is allowed to contain a sequence constructorvoid
Hook to allow additional validation of a parent element immediately after its children have been validated.protected abstract void
Set the attribute list for the element.void
Process the attributes of this element and all its children(package private) final void
Process the attribute list for the element.boolean
processBooleanAttribute
(String name, String value) Process an attribute whose value is yes, no, true, false, 1, or 0; returning true or false.(package private) void
Process the [xsl:]default-collation attribute if there is one.(package private) void
Process the [xsl:]default-mode attribute if there is one(package private) void
Process the [xsl:]expand-text attribute if there is one(package private) void
Process the [xsl:]xpath-default-namespace attribute if there is one(package private) void
Process the [xsl:]exclude-result-prefixes attribute if there is one(package private) void
Process the [xsl:]expand-text attribute if there is one (and if XSLT 3.0 is enabled)(package private) void
Process the [xsl:]extension-element-prefixes attribute if there is onevoid
processStandardAttributes
(String namespace) Process the standard attributes such as[xsl:]expand-text
.(package private) boolean
processStreamableAtt
(String streamableAtt) protected void
Process the [xsl:]version attribute if there is onevoid
reportAbsence
(String attribute) Convenience method to report the absence of a mandatory attributeprotected void
requireSyntaxExtensions
(String attributeName) Ask whether XSLT syntax extensions are allowed, for example xsl:when/@select.protected boolean
Ask whether variables declared in an "uncle" element are visible.(package private) void
setActionCompleted
(int action) Say that an action on this StyleElement has been completedvoid
setCompilation
(Compilation compilation) (package private) void
(package private) static void
setInstructionLocation
(StyleElement source, Expression child) Set location information on a compiled instructionvoid
setObjectName
(StructuredQName qName) Set the object name, for example the name of a function, variable, or template declared on this elementvoid
setValidationError
(XmlProcessingIncident reason, StyleElement.OnFailure circumstances) Set a validation error.void
substituteFor
(StyleElement temp) Make this node a substitute for a temporary one previously added to the tree.typeCheck
(String name, Expression exp) Type-check an expression.Type-check a pattern.(package private) void
undeclaredNamespaceError
(String prefix, String errorCode, String attributeName) void
validate
(ComponentDeclaration decl) Check that the stylesheet element is valid.protected void
validateChildren
(ComponentDeclaration decl, boolean excludeStylesheet) Validate the children of this node, recursively.void
validateSubtree
(ComponentDeclaration decl, boolean excludeStylesheet) Recursive walk through the stylesheet to validate all nodesprotected int
Validate the value of the [xsl:]validation attribute(package private) boolean
Determine whether 1.0-compatible mode is enabled for this elementMethods inherited from class net.sf.saxon.tree.linked.ElementImpl
addAttribute, addNamespace, addNamespace, attributes, checkNotNamespaceSensitiveElement, copy, delete, fixupInsertedNamespaces, generateId, getAllNamespaces, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getLineNumber, getNodeKind, getNodeName, getRoot, getSchemaType, getSystemId, getURIForPrefix, initialise, isId, isIdref, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeNamespace, removeTypeAnnotation, rename, replaceStringValue, setAttributeInfo, setAttributes, setLocation, setNamespaceMap, setNilled, setNodeName, setSystemId, setTypeAnnotation
Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl
addChild, children, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber
Methods inherited from class net.sf.saxon.tree.linked.NodeImpl
atomize, compareOrder, effectiveBooleanValue, equals, getDisplayName, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getRawParent, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasFingerprint, head, insertSiblings, isDeleted, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPosition
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.NodeInfo
children, equals, getGenre, getPublicId, hashCode, isSameNodeInfo, isStreamed, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
extensionNamespaces
-
version
protected int version -
staticContext
-
validationError
-
reportingCircumstances
-
defaultXPathNamespace
-
defaultCollationName
-
defaultMode
-
expandText
protected boolean expandText -
actionsCompleted
protected int actionsCompleted -
ACTION_VALIDATE
public static final int ACTION_VALIDATE- See Also:
-
ACTION_COMPILE
public static final int ACTION_COMPILE- See Also:
-
ACTION_TYPECHECK
public static final int ACTION_TYPECHECK- See Also:
-
ACTION_OPTIMIZE
public static final int ACTION_OPTIMIZE- See Also:
-
ACTION_FIXUP
public static final int ACTION_FIXUP- See Also:
-
ACTION_PROCESS_ATTRIBUTES
public static final int ACTION_PROCESS_ATTRIBUTES- See Also:
-
YES_NO
-
-
Constructor Details
-
StyleElement
public StyleElement()Constructor
-
-
Method Details
-
getCompilation
-
setCompilation
-
getPackageData
-
getConfiguration
Description copied from class:NodeImpl
Get the configuration- Specified by:
getConfiguration
in interfaceNodeInfo
- Overrides:
getConfiguration
in classNodeImpl
- Returns:
- the Configuration to which the tree belongs. The default implementation invokes
getTreeInfo().getConfiguration()
.
-
getStaticContext
Get the static context for expressions on this element- Returns:
- the static context
-
getStaticContext
-
getBaseURI
Get the base URI of the element, which acts as the static base URI for XPath expressions defined on this element. This is an expensive operation so the result is cached- Specified by:
getBaseURI
in interfaceNodeInfo
- Overrides:
getBaseURI
in classElementImpl
- Returns:
- the base URI
-
makeExpressionVisitor
Make an expression visitor- Returns:
- the expression visitor
-
isSchemaAware
public boolean isSchemaAware()Ask whether the code is compiled in schema-aware mode- Returns:
- true if the compilation is schema-aware
-
substituteFor
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.- Parameters:
temp
- the element which this one is substituting for
-
setValidationError
Set a validation error. This is an error detected during construction of this element on the stylesheet, but which is not to be reported until later.- Parameters:
reason
- the details of the errorcircumstances
- a code identifying the circumstances under which the error is to be reported
-
setIgnoreInstruction
void setIgnoreInstruction() -
isInstruction
public boolean isInstruction()Ask whether this node is an instruction. The default implementation says it isn't.- Returns:
- true if this element is an instruction
-
isDeclaration
public boolean isDeclaration()Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet (including xsl:include and xsl:import). The default implementation returns false- Returns:
- true if the element is a permitted child of xsl:stylesheet or xsl:transform
-
getVisibility
Get the visibility of the component. Returns the actual value of the visibility attribute, after validation, unless this is absent, in which case it returns the default value of PRIVATE. InvokesinvalidAttribute(String, String)
if the value is invalid.- Returns:
- the declared visibility of the component, or
Visibility.PRIVATE
if the visibility attribute is absent.
-
getDeclaredVisibility
Get the visibility of the component. Returns the actual value of the visibility attribute, after validation, unless this is absent, in which case it returns null.- Returns:
- the declared visibility of the component, or null if the visibility attribute is absent.
-
markTailCalls
protected boolean markTailCalls()Mark tail-recursive calls on templates and functions. For most instructions, this returns false.- Returns:
- true if one or more tail calls were identified
-
mayContainSequenceConstructor
protected boolean mayContainSequenceConstructor()Determine whether this type of element is allowed to contain a sequence constructor- Returns:
- true if this instruction is allowed to contain a sequence constructor
-
mayContainFallback
protected boolean mayContainFallback()Determine whether this type of element is allowed to contain an xsl:fallback instruction. Note that this is only relevant if the element is an instruction.- Returns:
- true if this element is allowed to contain an xsl:fallback
-
mayContainParam
protected boolean mayContainParam()Determine whether this type of element is allowed to contain an xsl:param element- Returns:
- true if this element is allowed to contain an xsl:param
-
getDefaultValidation
int getDefaultValidation()Get the effective value of the default-validation attribute- Returns:
- the value of default-validation, as a constant from the
Validation
class, or Validation.STRIP if there is no containing element with a default-validation attribute.
-
makeQName
Make a structured QName, using this Element as the context for namespace resolution. If the name is unprefixed, the default namespace is not used. If the name is not valid, then a compileError is reported, and the value saxon:error-name is returned.- Parameters:
lexicalQName
- The lexical QName as written, in the form "[prefix:]localname". Leading and trailing whitespace will be trimmed. The EQName syntax "Q{uri}local" is also accepted.errorCode
- The error code to be used if the QName is not valid. If this is set to null, then the code used is XTSE0280 for an undeclared prefix, and XTSE0020 for all other errors. The code XTSE0080 is used if the URI is a reserved namespace, regardless of the supplied error code.attributeName
- EQName of the attribute containing the QName, for use in error reporting. May be null.- Returns:
- the StructuredQName representation of this lexical QName
-
findAncestorElement
Get the first ancestor element in the stylesheet tree that has a given name, supplied by fingerprint.- Parameters:
fingerprint
- the name of the required element- Returns:
- the first (innermost) ancestor with the required name, or null if none is found
-
getUsedPackage
Assuming this is an xsl:use-package element, find the package to which it refers.- Returns:
- the package referenced by this xsl:use-package element; or null if this is not an xsl:use-package element
-
getXslOriginal
Check that a reference to xsl:original appears within an xsl:override element, and that the name of the containing component matches the name of a component in the used stylesheet package; return the component in that package with matching symbolic name- Parameters:
componentKind
- the kind of component required, e.g. StandardNames.XSL_TEMPLATE- Returns:
- the component with matching name in the used stylesheet
- Throws:
XPathException
- if the xsl:original reference appears in an invalid context
-
getOverriddenComponent
Component getOverriddenComponent()Get the component that this declaration overrides, or null if this is not an overriding declaration- Returns:
- the overridden component, or null
-
makeRetainedStaticContext
-
changesRetainedStaticContext
boolean changesRetainedStaticContext()Ask whether this instruction requires a different retained static context from the containing (parent) instruction. That is, this instruction changes the static base URI, the default collation, or the set of in-scope namespaces.- Returns:
- true if the context for evaluating this instruction differs in relevant ways from that of the calling instruction
-
getNamespaceResolver
Get the namespace context of the instruction.- Returns:
- the namespace context. This method does not make a copy of the namespace context, so a reference to the returned NamespaceResolver will lock the stylesheet tree in memory.
-
processAllAttributes
Process the attributes of this element and all its children- Throws:
XPathException
- in the event of a static error being detected
-
processStandardAttributes
Process the standard attributes such as[xsl:]expand-text
. InvokescompileError(String)
or similar if the value of any of these attributes is invalid.The method processes:
extension-element-prefixes
exclude-result-prefixes
version
default-xpath-namespace
default-validation
expand-text
but not:
default-collation
default-mode
- Parameters:
namespace
- either "" to find the attributes in the null namespace, or NamespaceConstant.XSLT to find them in the XSLT namespace
-
getAttributeValue
Get an attribute value given the Clark name of the attribute (that is, the name in {uri}local format).- Parameters:
clarkName
- the name of the attribute in {uri}local format- Returns:
- the value of the attribute if it exists, or null otherwise
-
processAttributes
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 -
checkUnknownAttribute
Check whether an unknown attribute is permitted.- Parameters:
nc
- The name code of the attribute name
-
prepareAttributes
protected 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 -
getLastChildInstruction
StyleElement getLastChildInstruction()Find the last child instruction of this instruction. Returns null if there are no child instructions, or if the last child is a text node.- Returns:
- the last child instruction, or null if there are no child instructions
-
makeExpression
Compile an XPath expression in the context of this stylesheet element- Parameters:
expression
- the source text of the XPath expressionatt
- the attribute containing the XPath expression, or null if the expression is in a text node- Returns:
- the compiled expression tree for the XPath expression. In the case of an error, returns an ErrorExpression that will fail at run-time if executed.
-
makePattern
Make a pattern in the context of this stylesheet element- Parameters:
pattern
- the source text of the pattern- Returns:
- the compiled pattern
-
makeAttributeValueTemplate
Make an attribute value template in the context of this stylesheet element- Parameters:
expression
- the source text of the attribute value templateatt
- the attribute containing the AVT, or null in the case of a text value template- Returns:
- a compiled XPath expression that computes the value of the attribute (including concatenating the results of embedded expressions with any surrounding fixed text)
-
checkAttributeValue
Check the value of an attribute, as supplied statically- Parameters:
name
- the name of the attributevalue
- the value of the attributeavt
- set to true if the value is permitted to be an attribute value templateallowed
- list of permitted values, which must be in alphabetical order
-
processBooleanAttribute
Process an attribute whose value is yes, no, true, false, 1, or 0; returning true or false.- Parameters:
name
- the name of the attribute (used for diagnostics)value
- the value of the attribute
-
isYes
-
isNo
-
processStreamableAtt
-
makeSequenceType
Process an attribute whose value is a SequenceType- Parameters:
sequenceType
- the source text of the attribute- Returns:
- the processed sequence type
- Throws:
XPathException
- if the syntax is invalid or for example if it refers to a type that is not in the static context
-
makeExtendedSequenceType
- Throws:
XPathException
-
processExtensionElementAttribute
Process the [xsl:]extension-element-prefixes attribute if there is one- Parameters:
ns
- the namespace URI of the attribute - either the XSLT namespace or "" for the null namespace
-
processExcludedNamespaces
Process the [xsl:]exclude-result-prefixes attribute if there is one- Parameters:
ns
- the namespace URI of the attribute required, either the XSLT namespace or ""
-
processVersionAttribute
Process the [xsl:]version attribute if there is one- Parameters:
ns
- the namespace URI of the attribute required, either the XSLT namespace or ""
-
getEffectiveVersion
int getEffectiveVersion()Get the numeric value of the version number appearing as an attribute on this element, or inherited from its ancestors- Returns:
- the version number times ten as an integer
-
validateValidationAttribute
Validate the value of the [xsl:]validation attribute- Parameters:
value
- the raw value of the attribute- Returns:
- the encoded value of the attribute
-
isExtensionAttributeAllowed
Ask if an extension attribute is allowed; if no Professional Edition license is available, issue a warning saying the attribute is ignored, and return false- Parameters:
attribute
- the name of the attribute
-
forwardsCompatibleModeIsEnabled
boolean forwardsCompatibleModeIsEnabled()Determine whether forwards-compatible mode is enabled for this element- Returns:
- true if forwards-compatible mode is enabled
-
xPath10ModeIsEnabled
boolean xPath10ModeIsEnabled()Determine whether 1.0-compatible mode is enabled for this element- Returns:
- true if 1.0 compatable mode is enabled, that is, if this or an enclosing element specifies an [xsl:]version attribute whose value is less than 2.0
-
processDefaultCollationAttribute
void processDefaultCollationAttribute()Process the [xsl:]default-collation attribute if there is one. -
getDefaultCollationName
Get the default collation for this stylesheet element. If no default collation is specified in the stylesheet, return the Unicode codepoint collation name.- Returns:
- the name of the default collation
-
findCollation
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 requiredbaseURI
- the base URI to be used for resolving the collation name if it is relative- Returns:
- null if the collation is not found
- Throws:
XPathException
- if either URI is invalid as a URI
-
processDefaultMode
void processDefaultMode()Process the [xsl:]default-mode attribute if there is one -
getDefaultMode
Get the default mode for this stylesheet element.- Returns:
- the name of the default mode, obtained by looking for the default-mode attribute on this element
and all all its ancestors. In the absence of a default-mode attribute, returns the magic value
Mode.UNNAMED_MODE_NAME
- Throws:
XPathException
-
isExtensionNamespace
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:
uri
- the namespace URI being tested- Returns:
- true if the URI is an extension element namespace URI
-
isExcludedNamespace
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:
uri
- the namespace URI being tested- Returns:
- true if this namespace URI is a namespace excluded by virtue of exclude-result-prefixes on this element or on an ancestor element
-
processDefaultXPathNamespaceAttribute
Process the [xsl:]xpath-default-namespace attribute if there is one- Parameters:
ns
- the namespace URI of the attribute required (the default namespace or the XSLT namespace.)
-
getDefaultXPathNamespace
Get the default XPath namespace for elements and types- Returns:
- the default namespace for elements and types.
Return
NamespaceConstant.NULL
for the non-namespace
-
processExpandTextAttribute
Process the [xsl:]expand-text attribute if there is one (and if XSLT 3.0 is enabled)- Parameters:
ns
- the namespace URI of the attribute required (the default namespace or the XSLT namespace.)
-
processDefaultValidationAttribute
Process the [xsl:]expand-text attribute if there is one- Parameters:
ns
- the namespace URI of the attribute required (the default namespace or the XSLT namespace.)
-
isExpandingText
boolean isExpandingText()Ask whether content value templates are available within this element- Returns:
- true if content value templates are enabled
-
getSchemaType
Get the Schema type definition for a type named in the stylesheet (in a "type" attribute).- Parameters:
typeAtt
- the value of the type attribute- Returns:
- the corresponding schema type
-
getTypeAnnotation
Get the type annotation to use for a given schema type- Parameters:
schemaType
- the schema type- Returns:
- the corresponding numeric type annotation
-
validate
Check that the stylesheet 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.- Parameters:
decl
- the declaration to be validated- Throws:
XPathException
- if any error is found during validation
-
postValidate
Hook to allow additional validation of a parent element immediately after its children have been validated.- Throws:
XPathException
- if any error is found during post-traversal validation
-
index
Method supplied by declaration elements to add themselves to a stylesheet-level index- Parameters:
decl
- the Declaration being indexed. (This corresponds to the StyleElement object except in cases where one module is imported several times with different precedence.)top
- represents the outermost XSLStylesheet or XSLPackage element- Throws:
XPathException
- if any error is encountered
-
typeCheck
Type-check an expression. This is called to check each expression while the containing instruction is being validated. It is not just a static type-check, it also adds code to perform any necessary run-time type checking and/or conversion.- Parameters:
name
- the name of the attribute containing the expression to be checked (used for diagnostics)exp
- the expression to be checked- Returns:
- the (possibly rewritten) expression after type checking
- Throws:
XPathException
- if type-checking fails statically, that is, if it can be determined that the supplied value for the expression cannot possibly be of the required type
-
allocateLocalSlots
Allocate slots in the local stack frame to range variables used in an XPath expression- Parameters:
exp
- the XPath expression for which slots are to be allocated
-
typeCheck
Type-check a pattern. This is called to check each pattern while the containing instruction is being validated. It is not just a static type-check, it also adds code to perform any necessary run-time type checking and/or conversion.- Parameters:
name
- the name of the attribute holding the pattern, for example "match": used in diagnosticspattern
- the compiled pattern- Returns:
- the original pattern, or a substitute pattern if it has been rewritten. Returns null if and only if the supplied pattern is null.
- Throws:
XPathException
- if the pattern fails optimistic static type-checking
-
fixupReferences
Fix up references from XPath expressions. Overridden for function declarations and variable declarations- Throws:
XPathException
- if any references cannot be fixed up.
-
getContainingSlotManager
Get the SlotManager for the containing Procedure definition- Returns:
- the SlotManager associated with the containing Function, Template, etc, or null if there is no such containing Function, Template etc.
-
validateSubtree
public void validateSubtree(ComponentDeclaration decl, boolean excludeStylesheet) throws XPathException Recursive walk through the stylesheet to validate all nodes- Parameters:
decl
- the declaration to be validatedexcludeStylesheet
- true if the XSLStylesheet element is to be excluded- Throws:
XPathException
- if validation fails
-
validateChildren
protected void validateChildren(ComponentDeclaration decl, boolean excludeStylesheet) throws XPathException Validate the children of this node, recursively. Overridden for top-level data elements.- Parameters:
decl
- the declaration whose children are to be validatedexcludeStylesheet
- true if the xsl:stylesheet element is to be excluded- Throws:
XPathException
- if validation fails
-
isPermittedChild
Check whether a given child is permitted for this element. This method is used when a non-instruction child element such as xsl:sort is encountered in a context where instructions would normally be expected.- Parameters:
child
- the child that may or may not be permitted- Returns:
- true if the child is permitted.
-
getPrincipalStylesheetModule
Get the principal stylesheet module of the package in which this XSLT element appears- Returns:
- the containing package
-
getContainingPackage
Get the containing package (the principal stylesheet module of the package in which this XSLT element appears)- Returns:
- the containing package. May be null if the method is called during initialization.
-
checkSortComesFirst
void checkSortComesFirst(boolean sortRequired) Check that among the children of this element, any xsl:sort elements precede any other elements- Parameters:
sortRequired
- true if there must be at least one xsl:sort element
-
checkTopLevel
Convenience method to check that the stylesheet element is at the top level (that is, as a child of xsl:stylesheet or xsl:transform)- Parameters:
errorCode
- the error to throw if it is not at the top level; defaults to XTSE0010 if the value is nullallowOverride
- true if the element is allowed to appear as a child of xsl:override
-
checkEmpty
public void checkEmpty()Convenience method to check that the stylesheet element is empty -
reportAbsence
Convenience method to report the absence of a mandatory attribute- Parameters:
attribute
- the name of the attribute whose absence is to be reported
-
compile
Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.- Parameters:
compilation
- the compilation episodedecl
- the containing top-level declaration, for example xsl:function or xsl:template- 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.
- Throws:
XPathException
- if validation fails
-
isWithinDeclaredStreamableConstruct
protected boolean isWithinDeclaredStreamableConstruct() -
generateId
-
compileDeclaration
public void compileDeclaration(Compilation compilation, ComponentDeclaration decl) throws XPathException Compile a declaration in the stylesheet tree for use at run-time.- Parameters:
compilation
- the compilation episodedecl
- the containing top-level declaration, for example xsl:function or xsl:template- Throws:
XPathException
- if compilation fails
-
compileSequenceConstructor
public Expression compileSequenceConstructor(Compilation compilation, ComponentDeclaration decl, boolean includeParams) throws XPathException Compile the children of this instruction on the stylesheet tree, adding the subordinate instructions to the parent instruction on the execution tree.- Parameters:
compilation
- the Executabledecl
- the Declaration of the containing top-level stylesheet elementincludeParams
- true if xsl:param elements are to be treated as child instructions (true for templates but not for functions)- Returns:
- the compiled sequence constructor
- Throws:
XPathException
- if compilation fails
-
compileSequenceConstructor
public Expression compileSequenceConstructor(Compilation compilation, ComponentDeclaration decl, SequenceIterator iter, boolean includeParams) throws XPathException Compile the children of this instruction on the stylesheet tree, adding the subordinate instructions to the parent instruction on the execution tree.- Parameters:
compilation
- the Executabledecl
- the Declaration of the containing top-level stylesheet elementiter
- Iterator over the children. This is used in the case where there are children that are not part of the sequence constructor, for example the xsl:sort children of xsl:for-each; the iterator can be positioned past such elements.includeParams
- true if xsl:param elements are to be treated as child instructions (true for templates but not for functions)- Returns:
- the compiled sequence constructor
- Throws:
XPathException
- if compilation fails
-
compileContentValueTemplate
Compile a content value text node.- Parameters:
node
- the text node potentially containing the templatecontents
- a list to which expressions representing the fixed and variable parts of the content template will be appended
-
setInstructionLocation
Set location information on a compiled instruction- Parameters:
source
- the parent elementchild
- the compiled expression tree for the instruction to be traced
-
fallbackProcessing
Expression fallbackProcessing(Compilation exec, ComponentDeclaration decl, StyleElement instruction) throws XPathException Perform fallback processing. Generate fallback code for an extension instruction that is not recognized by the implementation.- Parameters:
exec
- the Executabledecl
- the Declaration of the top-level element containing the extension instructioninstruction
- The unknown extension instruction- Returns:
- the expression tree representing the fallback code
- Throws:
XPathException
- if any error occurs
-
allocateLocation
Allocate a location- Returns:
- an location which can be used to report the location of the instruction
-
makeSortKeys
SortKeyDefinitionList makeSortKeys(Compilation compilation, ComponentDeclaration decl) throws XPathException Construct sort keys for a SortedIterator- Parameters:
compilation
- the compilation episodedecl
- the declaration containing the sort keys @throws XPathException if any error is detected- Returns:
- an array of SortKeyDefinition objects if there are any sort keys; or null if there are none.
- Throws:
XPathException
- if an error is found
-
getUsedAttributeSets
Get the list of attribute-set names associated with this element. This is used for xsl:element, xsl:copy, xsl:attribute-set, and on literal result elements- Parameters:
use
- the original value of the [xsl:]use-attribute-sets attribute- Returns:
- an array of names of the attribute sets
-
interpretVisibilityValue
Process the value of the visibility attribute (XSLT 3.0). InvokesinvalidAttribute(String, String)
if the value is invalid.- Parameters:
s
- the value of the attribute after whitespace collapsingflags
- contains "h" if the value "hidden" is allowed, "a" if the value "absent" is allowed- Returns:
- the corresponding visibility
-
getWithParamInstructions
public WithParam[] getWithParamInstructions(Expression parent, Compilation compilation, ComponentDeclaration decl, boolean tunnel) throws XPathException Get the list of xsl:with-param elements for a calling element (apply-templates, call-template, apply-imports, next-match). This method can be used to get either the tunnel parameters, or the non-tunnel parameters.- Parameters:
compilation
- the compilation episodedecl
- the containing stylesheet declarationtunnel
- true if the tunnel="yes" parameters are wanted, false to get- Returns:
- an array of WithParam objects for either the ordinary parameters or the tunnel parameters, as an array containing the results of compiling the xsl:with-param children of this instruction (if any)
- Throws:
XPathException
- if any error is detected
-
compileError
Report an error with diagnostic information- Parameters:
error
- contains information about the error
-
compileError
-
compileError
Report a static error in the stylesheet- Parameters:
message
- the error message
-
compileError
Compile time error, specifying an error code- Parameters:
message
- the error messageerrorCode
- the error code. May be null if not known or not defined
-
compileError
Compile time error, specifying an error code- Parameters:
message
- the error messageerrorCode
- the error code. May be null if not known or not defined
-
compileError
-
compileErrorInAttribute
Compile time error, specifying an error code and the name of the attribute that is in error.- Parameters:
message
- the error messageerrorCode
- the error code. May be null if not known or not definedattributeName
- the name of the attribute. For attributes in no namespace this is the local part of the name; for namespaced attributes a name in Clark format may be supplied.
-
invalidAttribute
-
requireSyntaxExtensions
Ask whether XSLT syntax extensions are allowed, for example xsl:when/@select. Returns true if explicitly enabled in the configuration. Note, this is not affected by forwards-compatibility mode (because it's too error-prone to simply ignore the presence of these attributes). -
undeclaredNamespaceError
-
compileWarning
-
compileWarning
-
compileWarning
-
issueWarning
Report a warning to the error listener- Parameters:
error
- an exception containing the warning text
-
issueWarning
Report a warning to the error listener- Parameters:
message
- the warning message textlocator
- the location of the problem in the source stylesheet
-
isTopLevel
public boolean isTopLevel()Test whether this is a top-level element- Returns:
- true if the element is a child of the xsl:stylesheet or xsl:package element
-
isConstructingComplexContent
boolean isConstructingComplexContent()Ask whether this is an instruction that is known to be constructing nodes which will become children of a parent document or element node, and will not have an independent existence of their own.- Returns:
- true if it is known that this is an instruction that creates nodes that will immediately be attached to a parent element or document node
-
getBindingInformation
Ask whether this element contains a binding for a variable with a given name; and if it does, return the source binding information- Parameters:
name
- the variable name- Returns:
- the binding information if this element binds a variable of this name; otherwise null
-
bindVariable
Bind a variable used in this element to the compiled form of the XSLVariable element in which it is declared- Parameters:
qName
- The name of the variable- Returns:
- the XSLVariableDeclaration (that is, an xsl:variable or xsl:param instruction) for the variable, or null if no declaration of the variable can be found
-
bindLocalVariable
Bind a variable reference used in this element to the compiled form of the XSLVariable element in which it is declared, considering only local variables and params- Parameters:
qName
- The name of the variable- Returns:
- the XSLVariableDeclaration (that is, an xsl:variable or xsl:param instruction) for the variable, or null if no local declaration of the variable can be found
-
seesAvuncularVariables
protected boolean seesAvuncularVariables()Ask whether variables declared in an "uncle" element are visible.- Returns:
- true for all elements except xsl:fallback and xsl:catch
-
hasImplicitBinding
Ask whether this particular element implicitly binds a given variable (used for xsl:accumulator-rule) -
getObjectName
Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically. If there is no name, the value will be null.- Returns:
- the name of the object declared in this element, if any
-
setObjectName
Set the object name, for example the name of a function, variable, or template declared on this element- Parameters:
qName
- the object name as a QName
-
getProperties
Get an iterator over all the properties available. The values returned by the iterator will be of type String, and each string can be supplied as input to the getProperty() method to retrieve the value of the property. -
isActionCompleted
boolean isActionCompleted(int action) Ask if an action on this StyleElement has been completed- Parameters:
action
- for example ACTION_VALIDATE- Returns:
- true if the action has already been performed
-
setActionCompleted
void setActionCompleted(int action) Say that an action on this StyleElement has been completed- Parameters:
action
- for example ACTION_VALIDATE
-