|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.expr.Expression net.sf.saxon.expr.instruct.Instruction net.sf.saxon.expr.instruct.CopyOf
public class CopyOf
An xsl:copy-of element in the stylesheet.
Field Summary |
---|
Fields inherited from class net.sf.saxon.expr.Expression |
---|
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD |
Constructor Summary | |
---|---|
CopyOf(Expression select,
boolean copyNamespaces,
int validation,
SchemaType schemaType,
boolean rejectDuplicateAttributes)
Create an xsl:copy-of instruction (also used in XQuery for implicit copying) |
Method Summary | |
---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap. |
Expression |
copy()
Copy an expression. |
boolean |
createsNewNodes()
Determine whether this instruction creates new nodes. |
void |
explain(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(TypeHierarchy th)
Get the item type of the items returned by evaluating this instruction |
SchemaType |
getSchemaType()
Get the schema type to be used for validation |
Expression |
getSelectExpression()
Get the expression that selects the nodes to be copied |
int |
getValidationAction()
Get the validation mode |
boolean |
isCopyForUpdate()
Ask whether this instruction is creating a copy for the purpose of updating (XQuery transform expression) |
boolean |
isCopyNamespaces()
Determine 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<? extends Item> |
iterate(XPathContext context)
Return an Iterator to iterate over the values of a sequence. |
Iterator<Expression> |
iterateSubExpressions()
Get the immediate sub-expressions of this expression. |
Expression |
optimize(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform optimisation of an expression and its subexpressions. |
TailCall |
processLeavingTail(XPathContext context)
Process this xsl:copy-of 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 |
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 |
setReadOnce(boolean b)
Set the "saxon:read-once" optimization mode |
void |
setRequireDocumentOrElement(boolean requireDocumentOrElement)
For XQuery, the operand (select) must be a single element or document node. |
void |
setStaticBaseUri(String base)
Set the static base URI of the xsl:copy-of instruction |
Expression |
simplify(ExpressionVisitor visitor)
Simplify an expression. |
Expression |
typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform type checking of an expression and its subexpressions. |
Methods inherited from class net.sf.saxon.expr.instruct.Instruction |
---|
assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getInstructionName, getIteratorFromProcessMethod, getSourceLocator, isXSLT, 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 |
---|
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).Method Detail |
---|
public Expression getSelectExpression()
public int getValidationAction()
getValidationAction
in interface ValidatingInstruction
public boolean isValidating()
public SchemaType getSchemaType()
getSchemaType
in interface ValidatingInstruction
public void setStaticBaseUri(String base)
base
- the static base URIpublic void setReadOnce(boolean b)
b
- true to enable the optimizationpublic void setCopyLineNumbers(boolean copy)
copy
- true if line numbers are to be copiedpublic final boolean createsNewNodes()
createsNewNodes
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 Expression copy()
copy
in class Expression
public Expression simplify(ExpressionVisitor visitor) throws XPathException
Instruction
simplify
in class Instruction
visitor
- an expression visitor
XPathException
- if an error is discovered during expression
rewritingpublic ItemType getItemType(TypeHierarchy th)
Instruction
getItemType
in class Instruction
th
- the type hierarchy cache
public int getCardinality()
Expression
getCardinality
in class Expression
public int getDependencies()
Expression
getDependencies
in class Expression
protected void promoteInst(PromotionOffer offer) throws XPathException
Instruction
promoteInst
in class Instruction
offer
- The type of rewrite being offered
XPathException
- if an error occurspublic Expression typeCheck(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) 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.
If the implementation returns a value other than "this", then it is required to ensure that the 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.
typeCheck
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 Expression optimize(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType 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 explain(ExpressionPresenter out)
explain
in class Expression
out
- the expression presenter used to display the structurepublic Iterator<Expression> iterateSubExpressions()
Expression
iterateSubExpressions
in class Expression
public boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression
in class Expression
original
- the original subexpressionreplacement
- the replacement subexpression
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 added
public TailCall processLeavingTail(XPathContext context) throws XPathException
processLeavingTail
in interface TailCallReturner
processLeavingTail
in class Instruction
context
- the dynamic context for the transformation
XPathException
- if a dynamic error occurs during the evaluation
of the instructionpublic SequenceIterator<? extends Item> iterate(XPathContext context) throws XPathException
Instruction
iterate
in class Instruction
context
- supplies the context for evaluation
XPathException
- if any dynamic error occurs evaluating the
expression
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |