ApplyImports

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

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, SequenceIterable, TailCallReturner, InstructionInfo, org.xml.sax.Locator

Direct Known Subclasses:

NextMatch
```
public class ApplyImports
extends Instruction
```
An xsl:apply-imports element in the stylesheet

See Also:

Serialized Form

Field Summary
- Fields inherited from class net.sf.saxon.expr.Expression
  EVALUATE_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, staticProperties

Constructor Summary

Constructors
Constructor Description

ApplyImports(boolean backwardsCompatible)

Constructors
Constructor	Description
`ApplyImports(boolean backwardsCompatible)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Expression`	`copy()`	Copy an expression.
`boolean`	`createsNewNodes()`	Determine whether this instruction creates new nodes.
`void`	`explain(ExpressionPresenter out)`	Diagnostic print of expression structure.
`int`	`getInstructionNameCode()`	Get the name of this instruction for diagnostic and tracing purposes
`java.util.Iterator`	`iterateSubExpressions()`	Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)
`Expression`	`optimize(ExpressionVisitor visitor, ItemType contextItemType)`	Perform optimisation of an expression and its subexpressions.
`TailCall`	`processLeavingTail(XPathContext context)`	ProcessLeavingTail: called to do the real work of this instruction.
`protected void`	`promoteInst(PromotionOffer offer)`	Handle promotion offers, that is, non-local tree rewrites.
`boolean`	`replaceSubExpression(Expression original, Expression replacement)`	Replace one subexpression by a replacement subexpression
`void`	`setActualParameters(WithParam[] actualParams, WithParam[] tunnelParams)`	Set the actual parameters on the call
`Expression`	`simplify(ExpressionVisitor visitor)`	Simplify an expression.
`Expression`	`typeCheck(ExpressionVisitor visitor, ItemType contextItemType)`	Perform type checking of an expression and its subexpressions.

Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, display, doPromotion, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, findParentOf, getCardinality, getColumnNumber, getColumnNumber, getContainer, getDependencies, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, isUpdatingExpression, iterateEvents, markTailFunctionCalls, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, toString, typeError

Methods inherited from class net.sf.saxon.instruct.Instruction
assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getImplementationMethod, getItemType, getSourceLocator, isXSLT, iterate, process, promote

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

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

- Constructor Detail
  - ApplyImports
```
public ApplyImports(boolean backwardsCompatible)
```
- Method Detail
  - setActualParameters
```
public void setActualParameters(WithParam[] actualParams,
                                WithParam[] tunnelParams)
```
    Set the actual parameters on the call
  - getInstructionNameCode
```
public int getInstructionNameCode()
```
    Get the name of this instruction for diagnostic and tracing purposes
    
    Overrides:
    
    getInstructionNameCode in class Instruction
    
    Returns:
    
    a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace
  - simplify
```
public Expression simplify(ExpressionVisitor visitor)
                    throws XPathException
```
    Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression).
    
    Specified by:
    
    simplify in class Instruction
    
    Parameters:
    
    visitor - an expression visitor
    
    Returns:
    
    the simplified expression
    
    Throws:
    
    XPathException - if an error is discovered during expression rewriting
  - typeCheck
```
public Expression typeCheck(ExpressionVisitor visitor,
                            ItemType contextItemType)
                     throws XPathException
```
    Description copied from class: Expression
    
    Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.
    This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.
    
    This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.
    
    If the implementation returns a value other than "this", then it is required to ensure that the parent pointer and location information in the returned expression have been set up correctly. It should not rely on the caller to do this, although for historical reasons many callers do so.
    
    Overrides:
    
    typeCheck in class Expression
    
    Parameters:
    
    visitor - an expression visitor
    
    contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
    
    Returns:
    
    the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
    
    Throws:
    
    XPathException - if an error is discovered during this phase (typically a type error)
  - optimize
```
public Expression optimize(ExpressionVisitor visitor,
                           ItemType contextItemType)
                    throws XPathException
```
    Description copied from class: Expression
    
    Perform optimisation of an expression and its subexpressions. This is the third and final phase of static optimization.
    This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.
    
    Overrides:
    
    optimize in class Expression
    
    Parameters:
    
    visitor - an expression visitor
    
    contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
    
    Returns:
    
    the original expression, rewritten if appropriate to optimize execution
    
    Throws:
    
    XPathException - if an error is discovered during this phase (typically a type error)
  - copy
```
public Expression copy()
```
    Copy an expression. This makes a deep copy.
    
    Specified by:
    
    copy in class Expression
    
    Returns:
    
    the copy of the original expression
  - createsNewNodes
```
public final boolean createsNewNodes()
```
    Determine whether this instruction creates new nodes. This implementation returns true (which is almost invariably the case, so it's not worth doing any further analysis to find out more precisely).
    
    Overrides:
    
    createsNewNodes in class Instruction
    
    Returns:
    
    true if the instruction creates new nodes (or if it can't be proved that it doesn't)
  - promoteInst
```
protected void promoteInst(PromotionOffer offer)
                    throws XPathException
```
    Handle promotion offers, that is, non-local tree rewrites.
    
    Overrides:
    
    promoteInst in class Instruction
    
    Parameters:
    
    offer - The type of rewrite being offered
    
    Throws:
    
    XPathException
  - iterateSubExpressions
```
public java.util.Iterator iterateSubExpressions()
```
    Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)
    
    Overrides:
    
    iterateSubExpressions in class Expression
    
    Returns:
    
    an iterator containing the sub-expressions of this expression
  - replaceSubExpression
```
public boolean replaceSubExpression(Expression original,
                                    Expression replacement)
```
    Replace one subexpression by a replacement subexpression
    
    Overrides:
    
    replaceSubExpression in class Expression
    
    Parameters:
    
    original - the original subexpression
    
    replacement - the replacement subexpression
    
    Returns:
    
    true if the original subexpression is found
  - processLeavingTail
```
public TailCall processLeavingTail(XPathContext context)
                            throws XPathException
```
    Description copied from class: Instruction
    
    ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.
    
    Specified by:
    
    processLeavingTail in interface TailCallReturner
    
    Specified by:
    
    processLeavingTail in class Instruction
    
    Parameters:
    
    context - The dynamic context of the transformation, giving access to the current node, the current variables, etc.
    
    Returns:
    
    null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.
    
    Throws:
    
    XPathException
  - explain
```
public void explain(ExpressionPresenter out)
```
    Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
    
    Specified by:
    
    explain in class Expression
    
    Parameters:
    
    out - the expression presenter used to display the structure

Class ApplyImports

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class net.sf.saxon.instruct.Instruction

Methods inherited from class java.lang.Object

Methods inherited from interface javax.xml.transform.SourceLocator

Constructor Detail

ApplyImports

Method Detail

setActualParameters

getInstructionNameCode

simplify

typeCheck

optimize

copy

createsNewNodes

promoteInst

iterateSubExpressions

replaceSubExpression

processLeavingTail

explain