net.sf.saxon.instruct

Class CopyOf

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.instruct.Instruction

net.sf.saxon.instruct.CopyOf

All Implemented Interfaces:

Serializable, SourceLocator, Container, Expression, MappingFunction, TailCallReturner, InstructionInfoProvider

public class CopyOf
extends Instruction
implements MappingFunction

An xsl:copy-of element in the stylesheet.

See Also:

Serialized Form

Field Summary

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

Constructor and Description
CopyOf(Expression select, boolean copyNamespaces, int validation, SchemaType schemaType, boolean rejectDuplicatAttributes)

Method Summary

Modifier and Type	Method and Description
protected static void	copyAttribute(NodeInfo source, SchemaType schemaType, int validation, Instruction instruction, XPathContext context, boolean rejectDuplicates)
boolean	createsNewNodes() Determine whether this instruction creates new nodes.
void	display(int level, NamePool pool, PrintStream out) Diagnostic print of expression structure.
Item	evaluateItem(XPathContext context) Return the first item if there is one, or null if not
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
SequenceIterator	iterate(XPathContext context) Return an Iterator to iterate over the values of a sequence.
Iterator	iterateSubExpressions() Get the immediate sub-expressions of this expression.
Object	map(Item item, XPathContext context) Map one item to a sequence.
Expression	optimize(Optimizer opt, StaticContext env, ItemType 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.
void	setReadOnce(boolean b)
void	setRequireDocumentOrElement(boolean requireDocumentOrElement) For XQuery, the operand (select) must be a single element or document node.
Expression	simplify(StaticContext env) Simplify an expression.
Expression	typeCheck(StaticContext env, ItemType contextItemType) Perform type checking of an expression and its subexpressions.

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

appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, getInstructionInfo, getSourceLocator, isXSLT, process, promote

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

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, dynamicError, effectiveBooleanValue, getColumnNumber, getConstructType, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, suppressValidation, typeError, 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 Detail

CopyOf

public CopyOf(Expression select,
              boolean copyNamespaces,
              int validation,
              SchemaType schemaType,
              boolean rejectDuplicatAttributes)

Method Detail

setReadOnce

public void setReadOnce(boolean b)

createsNewNodes

public final boolean createsNewNodes()

Determine whether this instruction creates new nodes. The result depends on the type of the select expression.

Overrides:

createsNewNodes in class Instruction

getInstructionNameCode

public int getInstructionNameCode()

Get the name of this instruction, for diagnostics and tracing

Overrides:

getInstructionNameCode in class Instruction

setRequireDocumentOrElement

public void setRequireDocumentOrElement(boolean requireDocumentOrElement)

For XQuery, the operand (select) must be a single element or document node.

Parameters:

requireDocumentOrElement -

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 provided. This implementation provides both iterate() and process() methods natively.

Specified by:

getImplementationMethod in interface Expression

Overrides:

getImplementationMethod in class Instruction

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws XPathException

Process this xsl:copy-of instruction

Specified by:

processLeavingTail in interface TailCallReturner

Specified by:

processLeavingTail in class Instruction

Parameters:

context - the dynamic context for the transformation

Returns:

null - this implementation of the method never returns a TailCall

Throws:

XPathException

copyAttribute

protected static void copyAttribute(NodeInfo source,
                                    SchemaType schemaType,
                                    int validation,
                                    Instruction instruction,
                                    XPathContext context,
                                    boolean rejectDuplicates)
                             throws XPathException

Throws:

XPathException

simplify

public Expression simplify(StaticContext env)
                    throws XPathException

Description copied from class: Instruction

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 interface Expression

Specified by:

simplify in class Instruction

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

getItemType

public ItemType getItemType(TypeHierarchy th)

Description copied from class: Instruction

Get the item type of the items returned by evaluating this instruction

Specified by:

getItemType in interface Expression

Overrides:

getItemType in class Instruction

Returns:

the static item type of the instruction

getCardinality

public int getCardinality()

Description copied from class: ComputedExpression

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.

Specified by:

getCardinality in interface Expression

Overrides:

getCardinality in class ComputedExpression

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).

getDependencies

public int getDependencies()

Description copied from class: ComputedExpression

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.

Specified by:

getDependencies in interface Expression

Overrides:

getDependencies in class ComputedExpression

Returns:

a set of bit-significant flags identifying the dependencies of the expression

promoteInst

protected void promoteInst(PromotionOffer offer)
                    throws XPathException

Description copied from class: Instruction

Handle promotion offers, that is, non-local tree rewrites.

Overrides:

promoteInst in class Instruction

Parameters:

offer - The type of rewrite being offered

Throws:

XPathException

typeCheck

public Expression typeCheck(StaticContext env,
                            ItemType contextItemType)
                     throws XPathException

Description copied from interface: Expression

Perform type checking of an expression and its subexpressions.

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.

Specified by:

typeCheck in interface Expression

Parameters:

env - the static context of the expression

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:

StaticError - if an error is discovered during this phase (typically a type error)

XPathException

optimize

public Expression optimize(Optimizer opt,
                           StaticContext env,
                           ItemType contextItemType)
                    throws XPathException

Description copied from interface: Expression

Perform optimisation of an expression and its subexpressions.

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.

Specified by:

optimize in interface Expression

Parameters:

opt - the optimizer in use. This provides access to supporting functions; it also allows different optimization strategies to be used in different circumstances.

env - the static context of the expression

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:

StaticError - if an error is discovered during this phase (typically a type error)

XPathException

display

public void display(int level,
                    NamePool pool,
                    PrintStream out)

Diagnostic print of expression structure. The expression is written to the System.err output stream

Specified by:

display in interface Expression

Parameters:

level - indentation level for this expression

out -

pool - NamePool used to expand any names appearing in the expression

iterateSubExpressions

public Iterator iterateSubExpressions()

Description copied from class: ComputedExpression

Get the immediate sub-expressions of this expression. Default implementation returns a zero-length array, appropriate for an expression that has no sub-expressions.

Specified by:

iterateSubExpressions in interface Expression

Overrides:

iterateSubExpressions in class ComputedExpression

Returns:

an iterator containing the sub-expressions of this expression

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Return the first item if there is one, or null if not

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class Instruction

Parameters:

context -

Returns:

the result of evaluating the instruction

Throws:

XPathException

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Description copied from class: Instruction

Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.

Specified by:

iterate in interface Expression

Overrides:

iterate in class Instruction

Parameters:

context - supplies the context for evaluation

Returns:

a SequenceIterator that can be used to iterate over the result of the expression

Throws:

XPathException - if any dynamic error occurs evaluating the expression

map

public Object map(Item item,
                  XPathContext context)
           throws XPathException

Map one item to a sequence.

Specified by:

map in interface MappingFunction

Parameters:

item - The item to be mapped. If context is supplied, this must be the same as context.currentItem().

context - The processing context. This is supplied only for mapping constructs that set the context node, position, and size. Otherwise it is null.

Returns:

either (a) a SequenceIterator over the sequence of items that the supplied input item maps to, or (b) an Item if it maps to a single item, or (c) null if it maps to an empty sequence.

Throws:

XPathException