Class DocumentInstr
- All Implemented Interfaces:
Serializable
,SourceLocator
,Container
,Expression
,TailCallReturner
,InstructionInfoProvider
Conceptually it represents an XSLT instruction xsl:document-node, with no attributes, whose content is a complex content constructor for the children of the document node.
- See Also:
-
Field Summary
Fields inherited from class net.sf.saxon.instruct.ParentNodeConstructor
content, validation
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Check statically whether the content of the element creates attributes or namespaces after creating any child nodesvoid
display
(int level, PrintStream out, Configuration config) Display this instruction as an expression, for diagnosticsevaluateItem
(XPathContext context) Evaluate as an expression.int
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().int
Get the name of this instruction for diagnostic and tracing purposes (the string "document-constructor")Get the item typeIn the case of a text-only instruction (xsl:variable containing a text node or one or more xsl:value-of instructions, return an expression that evaluates to the textual contentboolean
Determine whether this is a "text only" document: essentially, an XSLT xsl:variable that contains a single text node or xsl:value-of instruction.processLeavingTail
(XPathContext context) ProcessLeavingTail: called to do the real work of this instruction.void
setValidationAction
(int action) Set the validation actionsimplify
(StaticContext env) Simplify an expression.typeCheck
(StaticContext env, ItemType contextItemType) Perform type checking of an expression and its subexpressions.Methods inherited from class net.sf.saxon.instruct.ParentNodeConstructor
createsNewNodes, getBaseURI, getCardinality, getContentExpression, getSchemaType, getValidationAction, isLazyConstruction, isNamespaceSensitive, iterateSubExpressions, optimize, promoteInst, replaceSubExpression, setBaseURI, setContentExpression, setLazyConstruction, setSchemaType, verifyLazyConstruction
Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, getInstructionInfo, getSourceLocator, isXSLT, iterate, process, promote
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
-
Constructor Details
-
DocumentInstr
-
-
Method Details
-
getImplementationMethod
public int getImplementationMethod()An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is prefered. For instructions this is the process() method.- Specified by:
getImplementationMethod
in interfaceExpression
- Overrides:
getImplementationMethod
in classInstruction
-
setValidationAction
public void setValidationAction(int action) Set the validation action -
isTextOnly
public boolean isTextOnly()Determine whether this is a "text only" document: essentially, an XSLT xsl:variable that contains a single text node or xsl:value-of instruction. -
simplify
Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression). The default implementation does nothing.- Specified by:
simplify
in interfaceExpression
- Overrides:
simplify
in classParentNodeConstructor
- Parameters:
env
- the static context- Returns:
- the simplified expression
- Throws:
XPathException
- if an error is discovered during expression rewriting
-
typeCheck
Description copied from interface: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.
- Specified by:
typeCheck
in interfaceExpression
- Overrides:
typeCheck
in classParentNodeConstructor
- Parameters:
env
- the static context of the expressioncontextItemType
- 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 toType.ITEM_TYPE
- Returns:
- the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
- Throws:
XPathException
-
checkContentForAttributes
Check statically whether the content of the element creates attributes or namespaces after creating any child nodes- Specified by:
checkContentForAttributes
in classParentNodeConstructor
- Parameters:
env
- the static context- Throws:
XPathException
-
getStringValueExpression
In the case of a text-only instruction (xsl:variable containing a text node or one or more xsl:value-of instructions, return an expression that evaluates to the textual content- Returns:
- an expression that evaluates to the textual content
-
getItemType
Get the item type- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classInstruction
- Parameters:
th
- The TypeHierarchy- Returns:
- the in
-
processLeavingTail
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 interfaceTailCallReturner
- Specified by:
processLeavingTail
in classInstruction
- 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
-
evaluateItem
Evaluate as an expression.- Specified by:
evaluateItem
in interfaceExpression
- Overrides:
evaluateItem
in classInstruction
- Parameters:
context
- The context in which the expression is to be evaluated- Returns:
- the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
- Throws:
XPathException
- if any dynamic error occurs evaluating the expression
-
getInstructionNameCode
public int getInstructionNameCode()Get the name of this instruction for diagnostic and tracing purposes (the string "document-constructor")- Overrides:
getInstructionNameCode
in classInstruction
-
display
Display this instruction as an expression, for diagnostics- Parameters:
level
- indentation level for this expressionout
- Output destinationconfig
-
-