Package net.sf.saxon.expr.instruct

## Class ProcessingInstruction

- java.lang.Object
- - net.sf.saxon.expr.Expression
  - - net.sf.saxon.expr.instruct.Instruction
    - - net.sf.saxon.expr.instruct.SimpleNodeConstructor
      - - net.sf.saxon.expr.instruct.ProcessingInstruction

- All Implemented Interfaces:
    `ExportAgent`, `TailCallReturner`, `Locatable`, `IdentityComparable`, `Traceable`

      public class ProcessingInstruction
      extends SimpleNodeConstructor

  An xsl:processing-instruction element in the stylesheet, or a processing-instruction constructor in a query

- - ### Field Summary

    - ### Fields inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor

      `selectOp`

    - ### Fields inherited from class net.sf.saxon.expr.Expression

      `EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_COST, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `ProcessingInstruction​(Expression name)` | Create an xsl:processing-instruction instruction

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected java.lang.String` | `checkContent​(java.lang.String data, XPathContext context)` | Check the content of the node, and adjust it if necessary
    `static java.lang.String` | `checkContentXQuery​(java.lang.String data)` | Check the content of the node, and adjust it if necessary, using the XQuery rules
    `static java.lang.String` | `checkContentXSLT​(java.lang.String data)` | Check the content of the node, and adjust it if necessary, using the XSLT rules
    `Expression` | `copy​(RebindingMap rebindings)` | Copy an expression.
    `NodeName` | `evaluateNodeName​(XPathContext context)` | Run-time method to compute the name of the node being constructed.
    `void` | `export​(ExpressionPresenter out)` | Diagnostic print of expression structure.
    `int` | `getCardinality()` | Determine the static cardinality of the expression.
    `int` | `getDependencies()` | Determine which aspects of the context the expression depends on.
    `int` | `getInstructionNameCode()` | Get the name of this instruction for diagnostic and tracing purposes
    `ItemType` | `getItemType()` | Get the item type of the items returned by evaluating this instruction
    `Expression` | `getNameExp()` |
    `void` | `localTypeCheck​(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType)` | Method to perform type-checking specific to the kind of instruction
    `java.lang.Iterable<Operand>` | `operands()` | Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression.
    `void` | `processValue​(java.lang.CharSequence value, Outputter output, XPathContext context)` | Process the value of the node, to create the new node.
    `void` | `setNameExp​(Expression nameExp)` |

    - ### Methods inherited from class net.sf.saxon.expr.instruct.SimpleNodeConstructor

      `allowExtractingCommonSubexpressions, alwaysCreatesNewNodes, computeCardinality, computeSpecialProperties, evaluateItem, getSelect, getStreamerName, isLocal, iterate, mayCreateNewNodes, optimize, processLeavingTail, setSelect, typeCheck`

    - ### Methods inherited from class net.sf.saxon.expr.instruct.Instruction

      `assembleParams, assembleTunnelParams, dynamicError, evaluateAsString, getExpressionName, getImplementationMethod, getNetCost, getSourceLocator, isInstruction, isXSLT, process, someOperandCreatesNewNodes`

    - ### Methods inherited from class net.sf.saxon.expr.Expression

      `addToPathMap, adoptChildExpression, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeHashCode, computeStaticProperties, dynamicError, effectiveBooleanValue, equals, evaluatePendingUpdates, explain, getConfiguration, getCost, getEvaluationMethod, getExtraProperty, getIntegerBounds, getInterpretedExpression, getIntrinsicDependencies, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, getTracingTag, hasCompatibleStaticContext, hashCode, hasSpecialProperty, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isEqual, isIdentical, isLiftable, isMultiThreaded, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, prepareForStreaming, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toShortString, toString, typeCheckChildren, typeError, unordered, verifyParentPointers`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface net.sf.saxon.trace.Traceable

      `gatherProperties`

- - ### Constructor Detail

    - #### ProcessingInstruction

          public ProcessingInstruction​(Expression name)

      Create an xsl:processing-instruction instruction
      Parameters:
        `name` - the expression used to compute the name of the generated processing-instruction

  - ### Method Detail

    - #### getNameExp

          public Expression getNameExp()

    - #### setNameExp

          public void setNameExp​(Expression nameExp)

    - #### operands

          public java.lang.Iterable<Operand> operands()

      Description copied from class: `Expression`
      Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression. Default implementation works off the results of iterateSubExpressions()

      If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.

      Overrides:
        `operands` in class `SimpleNodeConstructor`
      Returns:
        an iterator containing the sub-expressions of this expression

    - #### getInstructionNameCode

          public int getInstructionNameCode()

      Get the name of this instruction for diagnostic and tracing purposes
      Overrides:
        `getInstructionNameCode` in class `Instruction`
      Returns:
        the string "xsl:processing-instruction"

    - #### getItemType

          public ItemType getItemType()

      Description copied from class: `Instruction`
      Get the item type of the items returned by evaluating this instruction
      Overrides:
        `getItemType` in class `Instruction`
      Returns:
        the static item type of the instruction

    - #### getCardinality

          public int getCardinality()

      Description copied from class: `Expression`
      Determine the static cardinality of the expression. This establishes how many items there will be in the result of the expression, at compile time (i.e., without actually evaluating the result.
      Overrides:
        `getCardinality` in class `Expression`
      Returns:
        one of the values Cardinality.ONE_OR_MORE, Cardinality.ZERO_OR_MORE, Cardinality.EXACTLY_ONE, Cardinality.ZERO_OR_ONE, Cardinality.EMPTY. This default implementation returns ZERO_OR_MORE (which effectively gives no information).

    - #### copy

          public Expression copy​(RebindingMap rebindings)

      Copy an expression. This makes a deep copy.
      Specified by:
        `copy` in class `Expression`
      Parameters:
        `rebindings` -
      Returns:
        the copy of the original expression

    - #### localTypeCheck

          public void localTypeCheck​(ExpressionVisitor visitor,
                                     ContextItemStaticInfo contextItemType)
                              throws XPathException

      Description copied from class: `SimpleNodeConstructor`
      Method to perform type-checking specific to the kind of instruction
      Specified by:
        `localTypeCheck` in class `SimpleNodeConstructor`
      Parameters:
        `visitor` - an expression visitor
        `contextItemType` - the static type of the context item
      Throws:
        `XPathException` - if a type error is detected

    - #### getDependencies

          public int getDependencies()

      Description copied from class: `Expression`
      Determine which aspects of the context the expression depends on. The result is a bitwise-or'ed value composed from constants such as XPathContext.VARIABLES and XPathContext.CURRENT_NODE. The default implementation combines the intrinsic dependencies of this expression with the dependencies of the subexpressions, computed recursively. This is overridden for expressions such as FilterExpression where a subexpression's dependencies are not necessarily inherited by the parent expression.
      Overrides:
        `getDependencies` in class `Expression`
      Returns:
        a set of bit-significant flags identifying the dependencies of the expression

    - #### processValue

          public void processValue​(java.lang.CharSequence value,
                                   Outputter output,
                                   XPathContext context)
                            throws XPathException

      Process the value of the node, to create the new node.
      Specified by:
        `processValue` in class `SimpleNodeConstructor`
      Parameters:
        `value` - the string value of the new node
        `output` - the destination for the result
        `context` - the dynamic evaluation context
      Throws:
        `XPathException`

    - #### checkContent

          protected java.lang.String checkContent​(java.lang.String data,
                                                  XPathContext context)
                                           throws XPathException

      Check the content of the node, and adjust it if necessary
      Overrides:
        `checkContent` in class `SimpleNodeConstructor`
      Parameters:
        `data` - the supplied content
        `context` - the dynamic context
      Returns:
        the original content, unless adjustments are needed
      Throws:
        `XPathException` - if the content is invalid

    - #### checkContentXSLT

          public static java.lang.String checkContentXSLT​(java.lang.String data)

      Check the content of the node, and adjust it if necessary, using the XSLT rules
      Parameters:
        `data` - the supplied content
      Returns:
        the original content, unless adjustments are needed

    - #### checkContentXQuery

          public static java.lang.String checkContentXQuery​(java.lang.String data)
                                                     throws XPathException

      Check the content of the node, and adjust it if necessary, using the XQuery rules
      Parameters:
        `data` - the supplied content
      Returns:
        the original content, unless adjustments are needed
      Throws:
        `XPathException` - if the content is invalid

    - #### evaluateNodeName

          public NodeName evaluateNodeName​(XPathContext context)
                                    throws XPathException

      Description copied from class: `SimpleNodeConstructor`
      Run-time method to compute the name of the node being constructed. This is overridden for nodes that have a name. The default implementation returns null, which is suitable for unnamed nodes such as comments
      Overrides:
        `evaluateNodeName` in class `SimpleNodeConstructor`
      Parameters:
        `context` - the XPath dynamic evaluation context
      Returns:
        the name pool nameCode identifying the name of the constructed node
      Throws:
        `XPathException` - if any failure occurs

    - #### export

          public void export​(ExpressionPresenter out)
                      throws XPathException

      Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
      Specified by:
        `export` in interface `ExportAgent`
      Specified by:
        `export` in class `Expression`
      Parameters:
        `out` - the expression presenter used to display the structure
      Throws:
        `XPathException` - if the export fails, for example if an expression is found that won't work in the target environment.