public class CopyOf extends Instruction implements ValidatingInstruction
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD
Constructor and Description |
---|
CopyOf(Expression select,
boolean copyNamespaces,
int validation,
SchemaType schemaType,
boolean rejectDuplicateAttributes)
Create an xsl:copy-of instruction (also used in XQuery for implicit copying)
|
Modifier and Type | Method and Description |
---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap.
|
static java.lang.String |
computeNewBaseUri(NodeInfo source,
java.lang.String staticBaseURI) |
Expression |
copy(RebindingMap rebindings)
Copy an expression.
|
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 |
getImplementationMethod()
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
|
int |
getInstructionNameCode()
Get the name of this instruction, for diagnostics and tracing
|
ItemType |
getItemType()
Get the item type of the items returned by evaluating this instruction
|
SchemaType |
getSchemaType()
Get the schema type to be used for validation
|
Expression |
getSelect() |
java.lang.String |
getStreamerName()
Get the (partial) name of a class that supports streaming of this kind of expression
|
int |
getValidationAction()
Get the validation mode
|
boolean |
isCopyAccumulators()
Ask whether accumulator values should be copied from the source document
|
boolean |
isCopyForUpdate()
Ask whether this instruction is creating a copy for the purpose of updating (XQuery transform expression)
|
boolean |
isCopyNamespaces()
Ask whether namespaces are to be copied or not
|
boolean |
isDocumentOrElementRequired()
Test whether this expression requires a document or element node
|
boolean |
isValidating()
Test if the instruction is doing validation
|
SequenceIterator |
iterate(XPathContext context)
Return an Iterator to iterate over the values of a sequence.
|
boolean |
mayCreateNewNodes()
Determine whether this instruction creates new nodes.
|
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.
|
Expression |
optimize(ExpressionVisitor visitor,
ContextItemStaticInfo contextItemType)
Perform optimisation of an expression and its subexpressions.
|
TailCall |
processLeavingTail(XPathContext context)
Process this xsl:copy-of instruction
|
void |
setCopyAccumulators(boolean copy)
Say whether accumulator values should be copied from the source document
|
void |
setCopyForUpdate(boolean forUpdate)
Set whether this instruction is creating a copy for the purpose of updating (XQuery transform expression)
|
void |
setCopyLineNumbers(boolean copy)
Set whether line numbers are to be copied from the source to the result.
|
void |
setRequireDocumentOrElement(boolean requireDocumentOrElement)
For XQuery, the operand (select) must be a single element or document node.
|
void |
setSchemaAware(boolean schemaAware)
Set the "is schema aware" property
|
void |
setSelect(Expression select)
Set the select expression
|
Expression |
typeCheck(ExpressionVisitor visitor,
ContextItemStaticInfo contextInfo)
Perform type checking of an expression and its subexpressions.
|
static SimpleType |
validateAttribute(NodeInfo source,
SimpleType schemaType,
int validation,
XPathContext context)
Validate an attribute node and return the type annotation to be used
|
alwaysCreatesNewNodes, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getInstructionName, getNetCost, getSourceLocator, isInstruction, isXSLT, process, someOperandCreatesNewNodes
adoptChildExpression, allowExtractingCommonSubexpressions, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeHashCode, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getConfiguration, getCost, getEvaluationMethod, getExtraProperty, getIntegerBounds, getInterpretedExpression, getIntrinsicDependencies, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, hasCompatibleStaticContext, hashCode, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isLiftable, isMultiThreaded, isSameExpression, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toShortString, toString, typeCheckChildren, typeError, unordered, verifyParentPointers, verifyParentPointers
public CopyOf(Expression select, boolean copyNamespaces, int validation, SchemaType schemaType, boolean rejectDuplicateAttributes)
select
- expression that selects the nodes to be copiedcopyNamespaces
- true if namespaces are to be copiedvalidation
- validation mode for the result treeschemaType
- schema type for validating the result treerejectDuplicateAttributes
- true if duplicate attributes are to be rejected (XQuery). False
if duplicates are handled by discarding all but the first (XSLT).public Expression getSelect()
public void setSelect(Expression select)
select
- the new select expressionpublic java.lang.Iterable<Operand> operands()
Expression
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.
operands
in class Instruction
public int getValidationAction()
getValidationAction
in interface ValidatingInstruction
public boolean isValidating()
public SchemaType getSchemaType()
getSchemaType
in interface ValidatingInstruction
public void setSchemaAware(boolean schemaAware)
schemaAware
- true if schema awareness is enabledpublic void setCopyLineNumbers(boolean copy)
copy
- true if line numbers are to be copiedpublic final boolean mayCreateNewNodes()
mayCreateNewNodes
in class Instruction
public int getInstructionNameCode()
getInstructionNameCode
in class Instruction
public void setRequireDocumentOrElement(boolean requireDocumentOrElement)
requireDocumentOrElement
- true if the argument must be a single element or document nodepublic boolean isDocumentOrElementRequired()
public void setCopyForUpdate(boolean forUpdate)
forUpdate
- true if this copy is being created to support an updatepublic boolean isCopyForUpdate()
public int getImplementationMethod()
getImplementationMethod
in class Instruction
Expression.ITERATE_METHOD
or Expression.EVALUATE_METHOD
or
Expression.PROCESS_METHOD
public boolean isCopyNamespaces()
public void setCopyAccumulators(boolean copy)
copy
- true if values should be copiedpublic boolean isCopyAccumulators()
public Expression copy(RebindingMap rebindings)
copy
in class Expression
rebindings
- information about variables whose bindings need to be replacedpublic ItemType getItemType()
Instruction
getItemType
in class Instruction
public int getCardinality()
Expression
getCardinality
in class Expression
public int getDependencies()
Expression
getDependencies
in class Expression
public Expression typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) throws XPathException
Expression
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.
typeCheck
in class Expression
visitor
- an expression visitorcontextInfo
- Information available statically about the context item: whether it is (possibly)
absent; its static type; its streaming posture.XPathException
- if an error is discovered during this phase
(typically a type error)public Expression optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) throws XPathException
Expression
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.
optimize
in class Expression
visitor
- an expression visitorcontextItemType
- 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
XPathException
- if an error is discovered during this phase
(typically a type error)public void export(ExpressionPresenter out) throws XPathException
export
in interface ExportAgent
export
in class Expression
out
- the expression presenter used to display the structureXPathException
- if the export fails, for example if an expression is found that won't work
in the target environment.public java.lang.String getStreamerName()
getStreamerName
in class Expression
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
The default implementation of this method assumes that an expression does no navigation other than the navigation done by evaluating its subexpressions, and that the subexpressions are evaluated in the same context as the containing expression. The method must be overridden for any expression where these assumptions do not hold. For example, implementations exist for AxisExpression, ParentExpression, and RootExpression (because they perform navigation), and for the doc(), document(), and collection() functions because they create a new navigation root. Implementations also exist for PathExpression and FilterExpression because they have subexpressions that are evaluated in a different context from the calling expression.
addToPathMap
in class Expression
pathMap
- the PathMap to which the expression should be addedpathMapNodeSet
- the PathMapNodeSet to which the paths embodied in this expression should be addedpublic TailCall processLeavingTail(XPathContext context) throws XPathException
processLeavingTail
in interface TailCallReturner
processLeavingTail
in class Instruction
context
- the dynamic context for the transformationXPathException
- if a dynamic error occurs during the evaluation
of the instructionpublic static java.lang.String computeNewBaseUri(NodeInfo source, java.lang.String staticBaseURI)
public static SimpleType validateAttribute(NodeInfo source, SimpleType schemaType, int validation, XPathContext context) throws XPathException
source
- the node to be copiedschemaType
- the simple type against which the value is to be validated, if anyvalidation
- one of preserve, strip, strict, laxcontext
- the dynamic contextXPathException
- if the attribute is not validpublic SequenceIterator iterate(XPathContext context) throws XPathException
Instruction
iterate
in class Instruction
context
- supplies the context for evaluationXPathException
- if any dynamic error occurs evaluating the
expressionCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.