|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.tree.linked.NodeImpl net.sf.saxon.tree.linked.ElementImpl net.sf.saxon.style.StyleElement net.sf.saxon.style.XSLFunction
public class XSLFunction
Handler for xsl:function elements in stylesheet (XSLT 2.0).
Attributes:
name gives the name of the function
saxon:memo-function=yes|no indicates whether it acts as a memo function.
Field Summary |
---|
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl |
---|
NODE_LETTER |
Fields inherited from interface net.sf.saxon.om.NodeInfo |
---|
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES |
Constructor Summary | |
---|---|
XSLFunction()
|
Method Summary | |
---|---|
protected void |
addChild(NodeImpl node,
int index)
Add a child node to this node. |
void |
compact(int size)
Compact the space used by this node |
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) |
protected AxisIterator |
enumerateChildren(NodeTest test)
Get an enumeration of the children of this node |
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. |
NodeInfo |
getFirstChild()
Get the first child node of the element |
NodeInfo |
getLastChild()
Get the last child node of the element |
protected NodeImpl |
getNthChild(int n)
Get the nth child node of the element (numbering from 0) |
int |
getNumberOfArguments()
Get the number of arguments declared by this function (that is, its arity). |
int |
getNumberOfChildren()
Determine how many children the node has |
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. |
protected int |
getRawSequenceNumber()
|
SequenceType |
getResultType()
Get the type of value returned by this function |
protected long |
getSequenceNumber()
Get the node sequence number (in document order). |
SlotManager |
getSlotManager()
Get associated Procedure (for details of stack frame). |
String |
getStringValue()
Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes. |
CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence. |
boolean |
hasChildNodes()
Determine if the node has any children. |
protected void |
index(Declaration decl,
PrincipalStylesheetModule top)
Method supplied by declaration elements to add themselves to a stylesheet-level index |
void |
insertChildren(NodeInfo[] source,
boolean atStart,
boolean inherit)
Insert a sequence of nodes as children of this node. |
protected void |
insertChildrenAt(NodeInfo[] source,
int index,
boolean inherit)
Insert children before or after a given existing child |
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(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. |
protected void |
removeChild(NodeImpl child)
Remove a given child |
protected void |
replaceChildrenAt(NodeInfo[] source,
int index,
boolean inherit)
Replace child at a given index by new children |
protected void |
setChildren(Object children)
Set the children of this node |
void |
setParameterDefinitions(UserFunction fn)
Set the definitions of the parameters in the compiled function, as an array. |
protected void |
setRawSequenceNumber(int seq)
|
void |
typeCheckBody()
|
void |
validate(Declaration decl)
Check that the stylesheet element is valid. |
Methods inherited from class net.sf.saxon.tree.linked.NodeImpl |
---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.saxon.trace.InstructionInfo |
---|
getLineNumber, getSystemId |
Methods inherited from interface org.xml.sax.Locator |
---|
getColumnNumber, getPublicId |
Methods inherited from interface javax.xml.transform.SourceLocator |
---|
getColumnNumber, getPublicId |
Methods inherited from interface net.sf.saxon.om.NodeInfo |
---|
hashCode |
Constructor Detail |
---|
public XSLFunction()
Method Detail |
---|
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(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 allowed
protected boolean isPermittedChild(StyleElement child)
isPermittedChild
in class StyleElement
child
- the child that may or may not be permitted
public 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 element
XPathException
- 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 validated
XPathException
- 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:template
XPathException
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
interface
getConstructType
in interface InstructionInfo
getConstructType
in class StyleElement
protected final long getSequenceNumber()
getSequenceNumber
in class NodeImpl
protected final int getRawSequenceNumber()
protected final void setRawSequenceNumber(int seq)
protected final void setChildren(Object children)
children
- null if there are no children, a single NodeInfo if there is one child, an array of NodeInfo
if there are multiple childrenpublic final boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
hasChildNodes
in class NodeImpl
true
if the node has any children,
false
if the node has no children.public final int getNumberOfChildren()
protected final AxisIterator enumerateChildren(NodeTest test)
test
- A NodeTest to be satisfied by the child nodes, or null
if all child node are to be returned
public final NodeInfo getFirstChild()
getFirstChild
in class NodeImpl
public final NodeInfo getLastChild()
getLastChild
in class NodeImpl
protected final NodeImpl getNthChild(int n)
n
- identifies the required child
protected void removeChild(NodeImpl child)
child
- the child to be removedpublic String getStringValue()
Item.getStringValueCS()
public CharSequence getStringValueCS()
NodeImpl
getStringValueCS
in interface Item<NodeInfo>
getStringValueCS
in interface ValueRepresentation<NodeInfo>
getStringValueCS
in class NodeImpl
Item.getStringValue()
protected void addChild(NodeImpl node, int index)
node
- the node to be added as a child of this node. This must be an instance of
NodeImpl
. It will be modified as a result of this call (by setting its
parent property and sibling position)index
- the position where the child is to be addedpublic void insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes will form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed. The supplied nodes may be modified in situ, for example to change their parent property and to add namespace bindings, or they may be copied, at the discretion of the implementation.
insertChildren
in interface MutableNodeInfo
insertChildren
in class NodeImpl
source
- the nodes to be inserted. The implementation determines what implementation classes
of node it will accept; this implementation will accept text, comment, and processing instruction
nodes belonging to any implementation, but elements must be instances of ElementImpl
.
The supplied nodes will be modified in situ, for example
to change their parent property and to add namespace bindings, if they are instances of
ElementImpl
; otherwise they will be copied. If the nodes are copied, then on return
the supplied source array will contain the copy rather than the original.atStart
- true if the new nodes are to be inserted before existing children; false if they are
to be inserted after existing childreninherit
- true if the inserted nodes are to inherit the namespaces of their new parent; false
if such namespaces are to be undeclared
IllegalArgumentException
- if the supplied nodes use a node implementation that this
implementation does not accept.protected void insertChildrenAt(NodeInfo[] source, int index, boolean inherit)
source
- the children to be inserted. We allow any kind of text, comment, or processing instruction
node, but element nodes must be instances of this NodeInfo implementation.index
- the position before which they are to be inserted: 0 indicates insertion before the
first child, 1 insertion before the second child, and so on.inherit
- true if the inserted nodes are to inherit the namespaces that are in-scope for their
new parent; false if such namespaces should be undeclared on the childrenprotected void replaceChildrenAt(NodeInfo[] source, int index, boolean inherit)
source
- the children to be insertedindex
- the position at which they are to be inserted: 0 indicates replacement of the
first child, replacement of the second child, and so on. The effect is undefined if index
is out of rangeinherit
- set to true if the new child elements are to inherit the in-scope namespaces
of their new parent
IllegalArgumentException
- if any of the replacement nodes is not an element, text,
comment, or processing instruction nodepublic void compact(int size)
size
- the number of actual children
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |