Package net.sf.saxon.style

Class XSLProcessingInstruction

java.lang.Object
net.sf.saxon.tree.NodeImpl
net.sf.saxon.tree.ElementImpl
net.sf.saxon.style.StyleElement
net.sf.saxon.style.XSLStringConstructor
net.sf.saxon.style.XSLProcessingInstruction
All Implemented Interfaces:
Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, SiblingCountingNode, ValueRepresentation, InstructionInfo, Locator
public class XSLProcessingInstruction extends XSLStringConstructor
An xsl:processing-instruction element in the stylesheet.
See Also:

  • Field Details

    • children

      protected Object children

    • sequence

      protected int sequence

  • Constructor Details

    • XSLProcessingInstruction

      public XSLProcessingInstruction()

  • Method Details

    • 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 XSLStringConstructor
      Throws:
      XPathException

    • getErrorCodeForSelectPlusContent

      protected String getErrorCodeForSelectPlusContent()
      Get the error code to be returned when the element has a select attribute but is not empty.
      Specified by:
      getErrorCodeForSelectPlusContent in class XSLStringConstructor
      Returns:
      the error code defined for this condition, for this particular instruction

    • compile

      public Expression compile(Executable exec) throws XPathException
      Description copied from class: StyleElement
      Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.
      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

    • 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 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:

    • getStringValueCS

      public 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:

    • 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:
      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