Package net.sf.saxon.functions

Class Parts

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Parts

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class Parts
extends SystemFunction
implements Callable

Proposed XPath 4.0 function that returns the components of an atomic value as a map (for example, the components of a dateTime, a duration, or a URI).

Constructor Summary

Constructors

Constructor	Description
Parts()

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] args)	Call the Callable.
static SequenceType	getComponentType(BuiltInAtomicType type, java.lang.String componentName)
static SequenceIterator	getComponentValue(AtomicValue value, java.lang.String componentName)
ItemType	getResultItemType(Expression[] args)	Get the return type, given knowledge of the actual arguments
static DictionaryMap	uriComponents(java.lang.String arg)

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, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, getUniStringArg, hashCode, importAttributes, isSequenceVariadic, 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, getSerialNumber, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Detail

Parts

public Parts()

Method Detail

getResultItemType

public ItemType getResultItemType(Expression[] args)

Get the return type, given knowledge of the actual arguments

Overrides:

getResultItemType in class SystemFunction

Parameters:

args - the actual arguments supplied

Returns:

the best available item type that the function will return

call

public Sequence call(XPathContext context,
                     Sequence[] args)
              throws XPathException

Description copied from interface: Callable

Call the Callable.

Specified by:

call in interface Callable

Parameters:

context - the dynamic evaluation context

args - the values of the arguments, supplied as Sequences.

Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

Returns:

the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

getComponentType

public static SequenceType getComponentType(BuiltInAtomicType type,
                                            java.lang.String componentName)

getComponentValue

public static SequenceIterator getComponentValue(AtomicValue value,
                                                 java.lang.String componentName)

uriComponents

public static DictionaryMap uriComponents(java.lang.String arg)