Package net.sf.saxon.style

Class XSLVariableDeclaration

    • Field Detail

      • references

        protected java.util.List references

      • children

        protected java.lang.Object children

      • sequence

        protected int sequence

    • Constructor Detail

      • XSLVariableDeclaration

        public XSLVariableDeclaration()

    • Method Detail

      • getSlotManager

        public SlotManager getSlotManager()
        Get the SlotManager associated with this stylesheet construct. The SlotManager contains the information needed to manage the local stack frames used by run-time instances of the code.
        Specified by:
        getSlotManager in interface StylesheetProcedure
        Returns:
        the associated SlotManager object

      • getSlotNumber

        public int getSlotNumber()
        Get the slot number allocated to this variable (its position in the stackframe)
        Returns:
        the allocated slot number

      • setSlotNumber

        public void setSlotNumber​(int slot)
        Allocate a slot number to this variable
        Parameters:
        slot - the position of the variable on the local stack frame

      • getRequiredType

        public abstract SequenceType getRequiredType()
        Get the static type of the variable.
        Returns:
        the static type declared for the variable

      • registerReference

        public void registerReference​(BindingReference ref)
        Method called by VariableReference to register the variable reference for subsequent fixup
        Specified by:
        registerReference in interface VariableDeclaration
        Parameters:
        ref - the variable reference

      • isInstruction

        public boolean isInstruction()
        Determine whether this node is an instruction.
        Overrides:
        isInstruction in class StyleElement
        Returns:
        true - it is an instruction (well, it can be, anyway)

      • fixupBinding

        protected void fixupBinding​(Binding binding)
        Notify all variable references of the Binding instruction
        Parameters:
        binding - the Binding that represents this variable declaration in the executable code tree

      • setReferenceCount

        protected void setReferenceCount​(GeneralVariable var)
        Set the number of references to this variable. This code is invoked only for a global variable, and only if there is at least one reference.
        Overrides:
        setReferenceCount in class XSLGeneralVariable
        Parameters:
        var - 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()

      • 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