java.io.Serializable
, javax.xml.transform.Source
, javax.xml.transform.SourceLocator
, LocationProvider
, SaxonLocator
, PullEvent
, Container
, FingerprintedNode
, Item<NodeInfo>
, MutableNodeInfo
, NamespaceResolver
, NodeInfo
, ValueRepresentation<NodeInfo>
, StylesheetProcedure
, InstructionInfo
, SiblingCountingNode
, org.xml.sax.Locator
public class XSLFunction extends StyleElement implements StylesheetProcedure
Modifier and Type | Field | Description |
---|---|---|
(package private) java.util.List<UserFunctionCall> |
references |
NODE_LETTER
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
ACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version, YES_NO
Constructor | Description |
---|---|
XSLFunction() |
Modifier and Type | Method | Description |
---|---|---|
void |
compileDeclaration(Executable exec,
Declaration decl) |
Compile the function definition to create an executable representation
The compileDeclaration() method has the side-effect of binding
all references to the function to the executable representation
(a UserFunction object)
|
void |
fixupReferences() |
Notify all references to this function of the data type.
|
UserFunction |
getCompiledFunction() |
Get the compiled function
|
int |
getConstructType() |
Get the type of construct.
|
int |
getNumberOfArguments() |
Get the number of arguments declared by this function (that is, its arity).
|
StructuredQName |
getObjectName() |
Get a name identifying the object of the expression, for example a function name, template name,
variable name, key name, element name, etc.
|
SequenceType |
getResultType() |
Get the type of value returned by this function
|
SlotManager |
getSlotManager() |
Get associated Procedure (for details of stack frame).
|
protected void |
index(Declaration decl,
PrincipalStylesheetModule top) |
Method supplied by declaration elements to add themselves to a stylesheet-level index
|
boolean |
isDeclaration() |
Ask whether this node is a declaration, that is, a permitted child of xsl:stylesheet
(including xsl:include and xsl:import).
|
boolean |
isOverriding() |
Is override="yes"?.
|
protected boolean |
isPermittedChild(StyleElement child) |
Specify that xsl:param is a permitted child
|
protected boolean |
mayContainParam(java.lang.String attName) |
Determine whether this type of element is allowed to contain an xsl:param element
|
boolean |
mayContainSequenceConstructor() |
Determine whether this type of element is allowed to contain a template-body.
|
void |
optimize(Declaration declaration) |
Optimize the stylesheet construct
|
void |
prepareAttributes() |
Set the attribute list for the element.
|
void |
registerReference(UserFunctionCall ref) |
Method called by UserFunctionCall to register the function call for
subsequent fixup.
|
void |
setParameterDefinitions(UserFunction fn) |
Set the definitions of the parameters in the compiled function, as an array.
|
void |
typeCheckBody() |
|
void |
validate(Declaration decl) |
Check that the stylesheet element is valid.
|
addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getPrefixForURI, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, initialise, isId, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, setLocation, setNameCode, setNamespaceDeclarations, setNamespaceList, setSystemId, setTypeAnnotation
getLineNumber, getSystemId
atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getRawParent, getSiblingPosition, getTypedValue, getURI, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace, setRawParent, setSiblingPosition
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addChild, compact, enumerateChildren, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, insertChildrenAt, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber
allocateLocationId, allocatePatternSlots, allocateSlots, bindLocalVariable, bindVariable, checkAttributeValue, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compile, compileError, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getColumnNumber, getCommonChildItemType, getContainerGranularity, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getEffectiveVersion, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLocationProvider, getNamespaceResolver, getPreparedStylesheet, getPrincipalStylesheetModule, getProcessorVersion, getProperties, getProperty, getReturnedItemType, getSchemaType, getStaticContext, getSystemId, getTypeAnnotation, getWithParamInstructions, isActionCompleted, isExcludedNamespace, isExplaining, isExtensionNamespace, isInstruction, issueWarning, issueWarning, isTopLevel, isXslt30Processor, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, postValidate, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processStandardAttributes, processVersionAttribute, reportAbsence, seesAvuncularVariables, setActionCompleted, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree, xPath10ModeIsEnabled
java.util.List<UserFunctionCall> references
public void registerReference(UserFunctionCall ref)
ref
- the UserFunctionCall to be registeredpublic boolean isDeclaration()
isDeclaration
in class StyleElement
public void prepareAttributes() throws XPathException
StyleElement
prepareAttributes
in class StyleElement
XPathException
- if a static error is detectedpublic StructuredQName getObjectName()
getObjectName
in interface InstructionInfo
getObjectName
in class StyleElement
public boolean mayContainSequenceConstructor()
mayContainSequenceConstructor
in class StyleElement
protected boolean mayContainParam(java.lang.String attName)
StyleElement
mayContainParam
in class StyleElement
attName
- if null, the method tests whether an xsl:param child is allowed.
If non-null, it tests whether an xsl:param child with the given attribute name is allowedprotected boolean isPermittedChild(StyleElement child)
isPermittedChild
in class StyleElement
child
- the child that may or may not be permittedpublic boolean isOverriding()
protected void index(Declaration decl, PrincipalStylesheetModule top) throws XPathException
StyleElement
index
in class StyleElement
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
- the outermost XSLStylesheet elementXPathException
- if any error is encounteredpublic void fixupReferences() throws XPathException
fixupReferences
in class StyleElement
XPathException
public void validate(Declaration decl) throws XPathException
StyleElement
validate
in class StyleElement
decl
- the declaration to be validatedXPathException
- if any error is found during validationpublic void compileDeclaration(Executable exec, Declaration decl) throws XPathException
compileDeclaration
in class StyleElement
exec
- the Executabledecl
- the containing top-level declaration, for example xsl:function or xsl:templateXPathException
public void typeCheckBody() throws XPathException
XPathException
public void optimize(Declaration declaration) throws XPathException
StylesheetProcedure
optimize
in interface StylesheetProcedure
XPathException
public SlotManager getSlotManager()
getSlotManager
in interface StylesheetProcedure
public SequenceType getResultType()
public int getNumberOfArguments()
public void setParameterDefinitions(UserFunction fn)
fn
- the compiled object representing the user-written functionpublic UserFunction getCompiledFunction()
public int getConstructType()
Location
. This method is part of the
InstructionInfo
interfacegetConstructType
in interface InstructionInfo
getConstructType
in class StyleElement