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

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.Source, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, SiblingCountingNode, ValueRepresentation, InstructionInfo, org.xml.sax.Locator

Direct Known Subclasses:

SaxonAssign, XSLVariableDeclaration, XSLWithParam
```
public abstract class XSLGeneralVariable
extends StyleElement
```
This class defines common behaviour across xsl:variable, xsl:param, and xsl:with-param

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`assignable`
`protected java.lang.Object`	`children`
`protected java.lang.String`	`constantText`
`protected boolean`	`global`
`protected boolean`	`implicitlyRequiredParam`
`protected boolean`	`redundant`
`protected boolean`	`requiredParam`
`protected SequenceType`	`requiredType`
`protected Expression`	`select`
`protected int`	`sequence`
`protected SlotManager`	`slotManager`
`protected boolean`	`tunnel`

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.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 interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY

Constructor Summary

Constructors
Constructor Description

XSLGeneralVariable()

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`	`allowsAsAttribute()`
`protected boolean`	`allowsRequired()`
`protected boolean`	`allowsTunnelAttribute()`
`protected boolean`	`allowsValue()`
`protected void`	`checkAgainstRequiredType(SequenceType required)`	Check the supplied select expression against the required type.
`void`	`compact(int size)`	Compact the space used by this node
`protected AxisIterator`	`enumerateChildren(NodeTest test)`	Get an enumeration of the children of this node
`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`	`getNumberOfChildren()`	Determine how many children the node has
`protected ItemType`	`getReturnedItemType()`	Determine the type of item returned by this instruction (only relevant if it is an instruction).
`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.
`java.lang.String`	`getVariableDisplayName()`	Get the display name of the variable.
`StructuredQName`	`getVariableQName()`	Get the QName of the variable
`boolean`	`hasChildNodes()`	Determine if the node has any children.
`protected void`	`initializeInstruction(Executable exec, GeneralVariable var)`	Initialize - common code called from the compile() method of all subclasses
`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
`boolean`	`isAssignable()`	Test whether it is permitted to assign to the variable using the saxon:assign extension element.
`boolean`	`isGlobal()`	Test whether this is a global variable or parameter
`boolean`	`isRequiredParam()`	Test whether this is a required parameter (required="yes")
`boolean`	`isTunnelParam()`	Test whether this is a tunnel parameter (tunnel="yes")
`boolean`	`mayContainSequenceConstructor()`	Determine whether this type of element is allowed to contain a template-body
`void`	`prepareAttributes()`	Set the attribute list for the element.
`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
`void`	`setRedundant()`	Mark this global variable as redundant.
`protected void`	`setReferenceCount(GeneralVariable var)`
`protected void`	`useChildrenArray(NodeImpl[] array)`	Supply an array to be used for the array of children.
`void`	`validate()`	Check that the stylesheet element is valid.

Methods inherited from class net.sf.saxon.style.StyleElement
allocateLocationId, allocatePatternSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compile, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, 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, isInstruction, 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 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 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 net.sf.saxon.om.NodeInfo
hashCode

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

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

- Field Detail
  - select
```
protected Expression select
```
  - requiredType
```
protected SequenceType requiredType
```
  - constantText
```
protected java.lang.String constantText
```
  - global
```
protected boolean global
```
  - slotManager
```
protected SlotManager slotManager
```
  - assignable
```
protected boolean assignable
```
  - redundant
```
protected boolean redundant
```
  - requiredParam
```
protected boolean requiredParam
```
  - implicitlyRequiredParam
```
protected boolean implicitlyRequiredParam
```
  - tunnel
```
protected boolean tunnel
```
  - children
```
protected java.lang.Object children
```
  - sequence
```
protected int sequence
```
- Constructor Detail
  - XSLGeneralVariable
```
public XSLGeneralVariable()
```
- Method Detail
  - getReturnedItemType
```
protected ItemType getReturnedItemType()
```
    Determine the type of item returned by this instruction (only relevant if it is an instruction).
    
    Overrides:
    
    getReturnedItemType in class StyleElement
    
    Returns:
    
    the item type returned. This is null for a variable: we are not interested in the type of the variable, but in what the xsl:variable constributes to the result of the sequence constructor it is part of.
  - mayContainSequenceConstructor
```
public boolean mayContainSequenceConstructor()
```
    Determine whether this type of element is allowed to contain a template-body
    
    Overrides:
    
    mayContainSequenceConstructor in class StyleElement
    
    Returns:
    
    true: yes, it may contain a template-body
  - allowsAsAttribute
```
protected boolean allowsAsAttribute()
```
  - allowsTunnelAttribute
```
protected boolean allowsTunnelAttribute()
```
  - allowsValue
```
protected boolean allowsValue()
```
  - allowsRequired
```
protected boolean allowsRequired()
```
  - isAssignable
```
public boolean isAssignable()
```
    Test whether it is permitted to assign to the variable using the saxon:assign extension element.
    
    Returns:
    
    true if the extra attribute saxon:assignable="yes" is present.
  - isTunnelParam
```
public boolean isTunnelParam()
```
    Test whether this is a tunnel parameter (tunnel="yes")
    
    Returns:
    
    true if this is a tunnel parameter
  - isRequiredParam
```
public boolean isRequiredParam()
```
    Test whether this is a required parameter (required="yes")
    
    Returns:
    
    true if this is a required parameter
  - isGlobal
```
public boolean isGlobal()
```
    Test whether this is a global variable or parameter
    
    Returns:
    
    true if this is global
  - getVariableDisplayName
```
public java.lang.String getVariableDisplayName()
```
    Get the display name of the variable.
    
    Returns:
    
    the lexical QName
  - setRedundant
```
public void setRedundant()
```
    Mark this global variable as redundant. This is done before prepareAttributes is called.
  - getVariableQName
```
public StructuredQName getVariableQName()
```
    Get the QName of the variable
    
    Returns:
    
    the name as a structured QName, or a dummy name if the variable has no name attribute or has an invalid name attribute
  - prepareAttributes
```
public void prepareAttributes()
                       throws XPathException
```
    Description copied from class: StyleElement
    
    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
    
    Specified by:
    
    prepareAttributes in class StyleElement
    
    Throws:
    
    XPathException
  - validate
```
public void validate()
              throws XPathException
```
    Description copied from class: StyleElement
    
    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.
    
    Overrides:
    
    validate in class StyleElement
    
    Throws:
    
    XPathException
  - checkAgainstRequiredType
```
protected void checkAgainstRequiredType(SequenceType required)
                                 throws XPathException
```
    Check the supplied select expression against the required type.
    
    Parameters:
    
    required - The type required by the variable declaration, or in the case of xsl:with-param, the signature of the called template
    
    Throws:
    
    XPathException
  - initializeInstruction
```
protected void initializeInstruction(Executable exec,
                                     GeneralVariable var)
                              throws XPathException
```
    Initialize - common code called from the compile() method of all subclasses
    
    Parameters:
    
    exec - the executable
    
    var - the representation of the variable declaration in the compiled executable
    
    Throws:
    
    XPathException
  - setReferenceCount
```
protected void setReferenceCount(GeneralVariable var)
```
  - getConstructType
```
public int getConstructType()
```
    Get the type of construct. This will be a constant in class Location. This method is part of the InstructionInfo interface
    
    Specified by:
    
    getConstructType in interface InstructionInfo
    
    Overrides:
    
    getConstructType in class StyleElement
    
    Returns:
    
    an integer identifying the kind of construct
  - 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 XSLGeneralVariable

Field Summary

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

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 interface net.sf.saxon.om.ValueRepresentation

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.Locator

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

Methods inherited from interface javax.xml.transform.Source

Methods inherited from interface javax.xml.transform.SourceLocator

Field Detail

select

requiredType

constantText

global

slotManager

assignable

redundant

requiredParam

implicitlyRequiredParam

tunnel

children

sequence

Constructor Detail

XSLGeneralVariable

Method Detail

getReturnedItemType

mayContainSequenceConstructor

allowsAsAttribute

allowsTunnelAttribute

allowsValue

allowsRequired

isAssignable

isTunnelParam

isRequiredParam

isGlobal

getVariableDisplayName

setRedundant

getVariableQName

prepareAttributes

validate

checkAgainstRequiredType

initializeInstruction

setReferenceCount

getConstructType

getSequenceNumber

hasChildNodes

getNumberOfChildren

enumerateChildren

getFirstChild

getLastChild

getNthChild

removeChild

getStringValue

getStringValueCS

useChildrenArray

addChild

insertChildren

insertChildrenAt

replaceChildrenAt

compact