Class Remove

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Remove

All Implemented Interfaces:

Serializable, SourceLocator, Container, Expression, InstructionInfoProvider

public class Remove
extends SystemFunction

The XPath 2.0 remove() function

See Also:

• Serialized Form

Field Summary

Fields inherited from class SystemFunction

operation

Fields inherited from class FunctionCall

argument

Fields inherited from class ComputedExpression

locationId, staticProperties

Fields inherited from interface Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Constructors

Constructor	Description
Remove()

Method Summary

Modifier and Type	Method	Description
ItemType	getItemType(TypeHierarchy th)	Determine the data type of the items in the sequence
SequenceIterator	iterate(XPathContext context)	Evaluate the function to return an iteration of selected nodes.
Expression	simplify(StaticContext env)	Simplify.

Methods inherited from class SystemFunction

addContextDocumentArgument, checkArguments, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getRequiredType, main, makeSystemFunction, setDetails, useContextItemAsDefault

Methods inherited from class FunctionCall

checkArgumentCount, getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, optimize, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplifyArguments, typeCheck

Methods inherited from class ComputedExpression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Remove

public Remove()

Method Details

simplify

public Expression simplify(StaticContext env)
                    throws XPathException

Simplify. Recognize remove(seq, 1) as a TailExpression.

Specified by:

simplify in interface Expression

Overrides:

simplify in class FunctionCall

Parameters:

env - the static context

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

getItemType

public ItemType getItemType(TypeHierarchy th)

Determine the data type of the items in the sequence

Specified by:

getItemType in interface Expression

Overrides:

getItemType in class SystemFunction

Parameters:

th -

Returns:

the type of the input sequence

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Evaluate the function to return an iteration of selected nodes.

Specified by:

iterate in interface Expression

Overrides:

iterate in class ComputedExpression

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