net.sf.saxon.functions
Class Remove

java.lang.Object
  net.sf.saxon.expr.Expression
      net.sf.saxon.expr.FunctionCall
          net.sf.saxon.functions.SystemFunction
              net.sf.saxon.functions.Remove

All Implemented Interfaces:

Serializable, SourceLocator, Container, EvaluableItem, SequenceIterable, InstructionInfoProvider

public class Remove
extends SystemFunction

The XPath 2.0 remove() function

See Also:

Serialized Form

Nested Class Summary

static class

Remove.RemoveIterator An implementation of SequenceIterator that returns all items except the one at a specified position.

Field Summary

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

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Remove()

Method Summary

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

checkArguments, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, main, makeSystemFunction, optimize, setDetails

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Remove

public Remove()

Method Detail

simplify

public Expression simplify(StaticContext env)
                    throws XPathException

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

Overrides:

simplify in class FunctionCall

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

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 SequenceIterable

Overrides:

iterate in class Expression

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