com.saxonica.functions.extfn

Class DeepEqual

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.DeepEqual

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class DeepEqual
extends SystemFunction

Implements the saxon:deep-equal() function, a variant of fn:deep-equal that provides additional control over how the comparison is performed.

The specification is as follows:

arg1 The first sequence to be compared

arg2 The second sequence to be compared

collation The collation to be used (null if the default collation is to be used)

flags A string whose characters select options that cause the comparison to vary from the standard fn:deep-equals() function. The flags are:

• N - take namespace nodes into account
• J - join adjacent text nodes (e.g, nodes either side of a comment)
• A - compare type annotations
• C - take comments into account
• F - take namespace prefixes into account
• I - take the is-id() and is-idref() properties into account
• P - take processing instructions into account
• S - compare string values, not typed values
• w - don't take whitespace-only text nodes into account

returns true if the sequences are deep equal, otherwise false

Constructor Summary

Constructors

Constructor and Description
DeepEqual()

Method Summary

Modifier and Type	Method and Description
Sequence<?>	call(XPathContext context, Sequence[] arguments) Evaluate this function call at run-time

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

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.Function

argumentArray, getGenre

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DeepEqual

public DeepEqual()

Method Detail

call

public Sequence<?> call(XPathContext context,
                        Sequence[] arguments)
                 throws XPathException

Evaluate this function call at run-time

Parameters:

context - The XPath dynamic evaluation context

arguments - The values of the arguments to the function call. Each argument value (which is in general a sequence) is supplied in the form of a sequence.

Returns:

the results of the function.

Throws:

XPathException - if a dynamic error occurs during evaluation of the function. The Saxon run-time code will add information about the error location.