net.sf.saxon.functions
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, Expression

public class Remove
extends SystemFunction

The XPath 2.0 remove() function

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.saxon.functions.SystemFunction

operation

Fields inherited from class net.sf.saxon.expr.FunctionCall

argument

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

lineNumber, NO_ARGUMENTS, staticProperties

Constructor Summary

Remove()

Method Summary

ItemType	getItemType() 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() Simplify.

Methods inherited from class net.sf.saxon.functions.SystemFunction

addContextDocumentArgument, checkArguments, computeCardinality, display, getDetails, getName, getRequiredType, main, makeSystemFunction, useContextItemAsDefault

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

analyze, checkArgumentCount, getNumberOfArguments, getSubExpressions, preEvaluate, promote, setArguments, simplifyArguments

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

computeDependencies, computeSpecialProperties, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getDependencies, getIntrinsicDependencies, getLineNumber, getSpecialProperties, markTailFunctionCalls, setLineNumber, typeError

Methods inherited from class java.lang.Object

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

Constructor Detail

Remove

public Remove()

Method Detail

simplify

public Expression simplify()
                    throws XPathException

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

Specified by:

simplify in interface Expression

Overrides:

simplify in class FunctionCall

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

getItemType

public ItemType getItemType()

Determine the data type of the items in the sequence

Specified by:

getItemType in interface Expression

Overrides:

getItemType in class SystemFunction

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