XSLParam

java.lang.Object
- net.sf.saxon.tree.NodeImpl
- - net.sf.saxon.tree.ElementImpl
  - - net.sf.saxon.style.StyleElement
    - - net.sf.saxon.style.XSLGeneralVariable
      - net.sf.saxon.style.XSLVariableDeclaration
        
        net.sf.saxon.style.XSLParam

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.Source, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, VariableDeclaration, FingerprintedNode, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, SiblingCountingNode, ValueRepresentation, StylesheetProcedure, InstructionInfo, org.xml.sax.Locator
```
public class XSLParam
extends XSLVariableDeclaration
```
An xsl:param element in the stylesheet.
The xsl:param element has mandatory attribute name and optional attributes select, required, as, ...

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.Object children

protected int sequence
- Fields inherited from class net.sf.saxon.tree.ElementImpl
  attributeList, nameCode, namespaceList, typeCode
- Fields inherited from class net.sf.saxon.tree.NodeImpl
  index, NODE_LETTER, parent
- Fields inherited from interface net.sf.saxon.om.NodeInfo
  ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
- Fields inherited from class net.sf.saxon.style.StyleElement
  defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version
- Fields inherited from class net.sf.saxon.style.XSLGeneralVariable
  assignable, constantText, global, implicitlyRequiredParam, redundant, requiredParam, requiredType, select, slotManager, tunnel
- Fields inherited from class net.sf.saxon.style.XSLVariableDeclaration
  references

Fields
Modifier and Type	Field	Description
`protected java.lang.Object`	`children`
`protected int`	`sequence`

Constructor Summary

Constructors
Constructor Description

XSLParam()

Constructors
Constructor	Description
`XSLParam()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addChild(NodeImpl node, int index)`	Add a child node to this node.
`protected boolean`	`allowsRequired()`
`protected boolean`	`allowsTunnelAttribute()`
`protected boolean`	`allowsValue()`
`void`	`compact(int size)`	Compact the space used by this node
`Expression`	`compile(Executable exec)`	Compile: this ensures space is available for local variables declared within this global variable
`protected AxisIterator`	`enumerateChildren(NodeTest test)`	Get an enumeration of the children of this node
`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`	`getNumberOfChildren()`	Determine how many children the node has
`SequenceType`	`getRequiredType()`	Get the static type of the parameter.
`protected long`	`getSequenceNumber()`	Get the node sequence number (in document order).
`java.lang.String`	`getStringValue()`	Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
`java.lang.CharSequence`	`getStringValueCS()`	Get the value of the item as a CharSequence.
`boolean`	`hasChildNodes()`	Determine if the node has any children.
`void`	`insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)`	Insert copies of 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
`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`	`useChildrenArray(NodeImpl[] array)`	Supply an array to be used for the array of children.
`void`	`validate()`	Check that the variable is not already declared, and allocate a slot number

Methods inherited from interface net.sf.saxon.trace.InstructionInfo
getLineNumber, getSystemId

Methods inherited from interface org.xml.sax.Locator
getColumnNumber, getPublicId

Methods inherited from class net.sf.saxon.tree.NodeImpl
atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getTypedValue, getURI, insertSiblings, isId, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from interface net.sf.saxon.om.NodeInfo
hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.transform.Source
isEmpty

Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getPublicId

Methods inherited from class net.sf.saxon.style.StyleElement
allocateLocationId, allocatePatternSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeSets, getAttributeValue, getColumnNumber, getCommonChildItemType, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, getWithParamInstructions, isExcludedNamespace, isExplaining, isExtensionNamespace, isPermittedChild, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, mayContainParam, postValidate, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, replaceSubExpression, reportAbsence, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree

Methods inherited from interface net.sf.saxon.expr.VariableDeclaration
getVariableQName

Methods inherited from class net.sf.saxon.style.XSLGeneralVariable
allowsAsAttribute, checkAgainstRequiredType, getConstructType, getReturnedItemType, getVariableDisplayName, getVariableQName, initializeInstruction, isAssignable, isGlobal, isRequiredParam, isTunnelParam, mayContainSequenceConstructor, prepareAttributes, setRedundant

Methods inherited from class net.sf.saxon.style.XSLVariableDeclaration
fixupBinding, fixupReferences, getSlotManager, getSlotNumber, isInstruction, registerReference, setReferenceCount, setSlotNumber

- Field Detail
  - children
```
protected java.lang.Object children
```
  - sequence
```
protected int sequence
```
- Constructor Detail
  - XSLParam
```
public XSLParam()
```
- Method Detail
  - allowsValue
```
protected boolean allowsValue()
```
    Overrides:
    
    allowsValue in class XSLGeneralVariable
  - allowsRequired
```
protected boolean allowsRequired()
```
    Overrides:
    
    allowsRequired in class XSLGeneralVariable
  - allowsTunnelAttribute
```
protected boolean allowsTunnelAttribute()
```
    Overrides:
    
    allowsTunnelAttribute in class XSLGeneralVariable
  - validate
```
public void validate()
              throws XPathException
```
    Description copied from class: XSLVariableDeclaration
    
    Check that the variable is not already declared, and allocate a slot number
    
    Overrides:
    
    validate in class XSLVariableDeclaration
    
    Throws:
    
    XPathException
  - compile
```
public Expression compile(Executable exec)
                   throws XPathException
```
    Compile: this ensures space is available for local variables declared within this global variable
    
    Specified by:
    
    compile in class StyleElement
    
    Parameters:
    
    exec - the Executable
    
    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
  - getRequiredType
```
public SequenceType getRequiredType()
```
    Get the static type of the parameter. This is the declared type, because we cannot know the actual value in advance.
    
    Specified by:
    
    getRequiredType in class XSLVariableDeclaration
    
    Returns:
    
    the static type declared for the variable
  - getSequenceNumber
```
protected final long getSequenceNumber()
```
    Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and document nodes) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. For nodes added by XQUery Update, the sequence number is -1L
    
    Overrides:
    
    getSequenceNumber in class NodeImpl
    
    Returns:
    
    the sequence number if there is one, or -1L otherwise.
  - hasChildNodes
```
public final boolean hasChildNodes()
```
    Determine if the node has any children.
    
    Specified by:
    
    hasChildNodes in interface NodeInfo
    
    Overrides:
    
    hasChildNodes in class NodeImpl
    
    Returns:
    
    true if the node has any children, false if the node has no children.
  - getNumberOfChildren
```
public int getNumberOfChildren()
```
    Determine how many children the node has
    
    Returns:
    
    the number of children of this parent node
  - enumerateChildren
```
protected final AxisIterator enumerateChildren(NodeTest test)
```
    Get an enumeration of the children of this node
    
    Parameters:
    
    test - A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned
    
    Returns:
    
    an iterator over the children of this node
  - getFirstChild
```
public final NodeInfo getFirstChild()
```
    Get the first child node of the element
    
    Overrides:
    
    getFirstChild in class NodeImpl
    
    Returns:
    
    the first child node of the required type, or null if there are no children
  - getLastChild
```
public final NodeInfo getLastChild()
```
    Get the last child node of the element
    
    Overrides:
    
    getLastChild in class NodeImpl
    
    Returns:
    
    the last child of the element, or null if there are no children
  - getNthChild
```
protected final NodeImpl getNthChild(int n)
```
    Get the nth child node of the element (numbering from 0)
    
    Parameters:
    
    n - identifies the required child
    
    Returns:
    
    the last child of the element, or null if there is no n'th child
  - removeChild
```
protected void removeChild(NodeImpl child)
```
    Remove a given child
    
    Parameters:
    
    child - the child to be removed
  - getStringValue
```
public java.lang.String getStringValue()
```
    Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
    
    Returns:
    
    the accumulated character content of the element, including descendant elements.
    
    See Also:
    
    Item.getStringValueCS()
  - getStringValueCS
```
public java.lang.CharSequence getStringValueCS()
```
    Description copied from class: NodeImpl
    
    Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.
    
    Specified by:
    
    getStringValueCS in interface Item
    
    Specified by:
    
    getStringValueCS in interface ValueRepresentation
    
    Overrides:
    
    getStringValueCS in class NodeImpl
    
    Returns:
    
    the string value of the item
    
    See Also:
    
    Item.getStringValue()
  - useChildrenArray
```
protected void useChildrenArray(NodeImpl[] array)
```
    Supply an array to be used for the array of children. For system use only.
    
    Parameters:
    
    array - the array to be used
  - addChild
```
public void addChild(NodeImpl node,
                     int index)
```
    Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.
    
    Parameters:
    
    node - the node to be added as a child of this node
    
    index - the position where the child is to be added
  - insertChildren
```
public void insertChildren(NodeInfo[] source,
                           boolean atStart,
                           boolean inherit)
```
    Insert copies of a sequence of nodes as children of this node.
    
    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 be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.
    
    Specified by:
    
    insertChildren in interface MutableNodeInfo
    
    Overrides:
    
    insertChildren in class NodeImpl
    
    Parameters:
    
    source - the nodes to be inserted
    
    atStart - true if the new nodes are to be inserted before existing children; false if they are
    
    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 children
  - insertChildrenAt
```
protected void insertChildrenAt(NodeInfo[] source,
                                int index,
                                boolean inherit)
```
    Insert children before or after a given existing child
    
    Parameters:
    
    source - the children to be inserted
    
    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 children
  - replaceChildrenAt
```
protected void replaceChildrenAt(NodeInfo[] source,
                                 int index,
                                 boolean inherit)
```
    Replace child at a given index by new children
    
    Parameters:
    
    source - the children to be inserted
    
    index - 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 range
    
    inherit - set to true if the new child elements are to inherit the in-scope namespaces of their new parent
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the replacement nodes is not an element, text, comment, or processing instruction node
  - compact
```
public void compact(int size)
```
    Compact the space used by this node
    
    Parameters:
    
    size - the number of actual children

Class XSLParam

Field Summary

Fields inherited from class net.sf.saxon.tree.ElementImpl

Fields inherited from class net.sf.saxon.tree.NodeImpl

Fields inherited from interface net.sf.saxon.om.NodeInfo

Fields inherited from class net.sf.saxon.style.StyleElement

Fields inherited from class net.sf.saxon.style.XSLGeneralVariable

Fields inherited from class net.sf.saxon.style.XSLVariableDeclaration

Constructor Summary

Method Summary

Methods inherited from class net.sf.saxon.tree.ElementImpl

Methods inherited from interface net.sf.saxon.trace.InstructionInfo

Methods inherited from interface org.xml.sax.Locator

Methods inherited from class net.sf.saxon.tree.NodeImpl

Methods inherited from interface net.sf.saxon.om.NodeInfo

Methods inherited from class java.lang.Object

Methods inherited from interface javax.xml.transform.Source

Methods inherited from interface javax.xml.transform.SourceLocator

Methods inherited from class net.sf.saxon.style.StyleElement

Methods inherited from interface net.sf.saxon.expr.VariableDeclaration

Methods inherited from class net.sf.saxon.style.XSLGeneralVariable

Methods inherited from class net.sf.saxon.style.XSLVariableDeclaration

Field Detail

children

sequence

Constructor Detail

XSLParam

Method Detail

allowsValue

allowsRequired

allowsTunnelAttribute

validate

compile

getRequiredType

getSequenceNumber

hasChildNodes

getNumberOfChildren

enumerateChildren

getFirstChild

getLastChild

getNthChild

removeChild

getStringValue

getStringValueCS

useChildrenArray

addChild

insertChildren

insertChildrenAt

replaceChildrenAt

compact