Module dev.metaschema.core

Package dev.metaschema.core.metapath.function.library

package dev.metaschema.core.metapath.function.library

Built-in Metapath function implementations based on the XPath 3.1 specification.

This package provides concrete implementations of standard XPath 3.1 functions adapted to work with the Metaschema document model. Functions that operate on an XML document model (XDM) in XPath have been adapted to work with the Metaschema module-based model instead.

Function Categories

• String Functions: fn:string, fn:concat, fn:contains, fn:starts-with, fn:ends-with, fn:substring, fn:normalize-space, fn:upper-case, fn:lower-case, fn:tokenize
• Numeric Functions: fn:abs, fn:ceiling, fn:floor, fn:round
• Sequence Functions: fn:count, fn:empty, fn:exists, fn:head, fn:tail, fn:reverse, fn:distinct-values, fn:index-of, fn:insert-before, fn:remove
• Date/Time Functions: fn:current-date, fn:current-time, fn:current-dateTime, fn:year-from-date, fn:month-from-date, fn:day-from-date, and related component extraction functions
• Boolean Functions: fn:boolean, fn:true, fn:false, fn:not
• Array Functions: array:size, array:get, array:head, array:tail, array:reverse, array:flatten, array:join
• Map Functions: map:contains, map:get, map:keys, map:put, map:remove, map:merge
• Document Functions: fn:doc, fn:doc-available, fn:base-uri, fn:document-uri

Metaschema-Specific Extensions

This package also includes Metapath-specific functions not present in XPath 3.1:

• MpRecurseDepth - Recursively evaluates a Metapath expression to a specified depth
• MpBase64Encode - Encodes strings to Base64
• MpBase64Decode - Decodes Base64 strings

Function Registration

All built-in functions are registered in DefaultFunctionLibrary, which is loaded via the Java ServiceLoader mechanism.

See Also:

• XPath and XQuery Functions and Operators 3.1
• dev.metaschema.core.metapath.function

Related Packages

Package	Description
dev.metaschema.core.metapath.function	Provides the core framework for defining and executing Metapath functions.
dev.metaschema.core.metapath.function.regex	Provides regular expression support for implementing Metapath functions.

Class	Description
ArrayAppend	Implements the XPath 3.1 array:append function.
ArrayFlatten	Implements the XPath 3.1 array:flatten function.
ArrayGet	Implements the XPath 3.1 array:get function.
ArrayHead	Implements the XPath 3.1 array:head function.
ArrayInsertBefore	Implements the XPath 3.1 array:insert-before function.
ArrayJoin	Implements the XPath 3.1 array:join function.
ArrayPut	Implements the XPath 3.1 array:put function.
ArrayRemove	Implements the XPath 3.1 array:remove function.
ArrayReverse	Implements the XPath 3.1 array:reverse function.
ArraySize	Implements the XPath 3.1 array:size function.
ArraySubarray	Implements the XPath 3.1 array:subarray function.
ArrayTail	Implements the XPath 3.1 array:tail function.
CastFunction<ITEM extends IAnyAtomicItem>	Implements the XPath 3.1 casting functions.
DefaultFunctionLibrary	Provides built-in Metapath functions based on the XPath 3.1 function specification.
FnAbs	Implements the XPath 3.1 fn:abs function.
FnAdjustDateTimeToTimezone	Implements the XPath 3.1 fn:adjust-dateTime-to-timezone function.
FnAdjustDateToTimezone	Implements the XPath 3.1 fn:adjust-date-to-timezone function.
FnAdjustTimeToTimezone	Implements the XPath 3.1 fn:adjust-time-to-timezone function.
FnAvg	Implements the XPath 3.1 fn:avg function.
FnBaseUri	Implements the XPath 3.1 fn:base-uri functions.
FnBoolean	Implements the XPath 3.1 fn:boolean function.
FnCeiling	Implements the XPath 3.1 fn:ceiling function.
FnCompare	Implements the XPath 3.1 fn:compare function.
FnConcat	Implements the XPath 3.1 fn:concat function.
FnContains	Implements the XPath 3.1 fn:contains function.
FnCount	Implements the XPath 3.1 fn:count function.
FnCurrentDate	Implements the XPath 3.1 fn:current-date function.
FnCurrentDateTime	Implements the XPath 3.1 fn:current-dateTime function.
FnCurrentTime	Implements the XPath 3.1 fn:current-time function.
FnData	Implements the XPath 3.1 fn:data functions.
FnDateTime	Implements the XPath 3.1 fn:dateTime function.
FnDayFromDate	Implements the XPath 3.1 fn:day-from-date.
FnDayFromDateTime	Implements the XPath 3.1 fn:day-from-dateTime.
FnDaysFromDuration	Implements the XPath 3.1 fn:days-from-duration.
FnDeepEqual	/** Implements fn:deep-equal functions.
FnDefaultLanguage	Implements the XPath 3.1 fn:default-language function.
FnDistinctValues	Implements fn:distinct-values functions.
FnDoc	Implements the XPath 3.1 fn:doc function.
FnDocumentAvailable	Implements the XPath 3.1 fn:doc-available function.
FnDocumentUri	Implements the XPath 3.1 fn:document-uri functions.
FnEmpty	Implements the XPath 3.1 fn:empty function.
FnEndsWith	Implements the XPath 3.1 fn:ends-with function.
FnExactlyOne	Implements the XPath 3.1 fn:exactly-one function.
FnExists	Implements the XPath 3.1 fn:exists function.
FnFalse	Implements the XPath 3.1 fn:false function.
FnFunctionArity	/** Implements fn:function-arity functions.
FnFunctionLookup	/** Implements fn:function-lookup functions.
FnFunctionName	/** Implements fn:function-name functions.
FnHasChildren	/** Implements fn:has-children functions.
FnHead	Implements the XPath 3.1 fn:head function.
FnHoursFromDateTime	Implements the XPath 3.1 fn:hours-from-dateTime.
FnHoursFromDuration	Implements the XPath 3.1 fn:hours-from-duration.
FnHoursFromTime	Implements the XPath 3.1 fn:hours-from-time.
FnImplicitTimezone	Implements fn:implicit-timezone.
FnIndexOf	/** Implements fn:index-of functions.
FnInnermost	Implements fn:innermost functions.
FnInsertBefore	Implements the XPath 3.1 fn:insert-before function.
FnLast	Implements fn:last.
FnLocalName	/** Implements fn:local-name functions.
FnLowerCase	Based on the XPath 3.1 fn:lower-case functions.
FnMatches	Implements the XPath 3.1 fn:matches functions.
FnMinMax	Implements the XPath 3.1 fn:min and fn:max functions.
FnMinutesFromDateTime	Implements the XPath 3.1 fn:minutes-from-dateTime.
FnMinutesFromDuration	Implements the XPath 3.1 fn:minutes-from-duration.
FnMinutesFromTime	Implements the XPath 3.1 fn:minutes-from-time.
FnMonthFromDate	Implements the XPath 3.1 fn:month-from-date.
FnMonthFromDateTime	Implements the XPath 3.1 fn:month-from-dateTime.
FnMonthsFromDuration	Implements the XPath 3.1 fn:months-from-duration.
FnName	/** Implements fn:name functions.
FnNamespaceUri	/** Implements fn:namespace-uri functions.
FnNormalizeSpace	Implements the XPath 3.1 fn:normalize-space functions.
FnNot	Implements the XPath 3.1 fn:not function.
FnOneOrMore	Implements the XPath 3.1 fn:one-or-more function.
FnOutermost	/** Implements fn:outermost functions.
FnPath	Implements the XPath 3.1 fn:path functions.
FnPosition	Implements fn:position.
FnQName	/** Implements fn:QName functions.
FnRemove	Implements the XPath 3.1 fn:remove function.
FnResolveUri	Implements the XPath 3.1 resolve-ur functions.
FnReverse	Implements the XPath 3.1 fn:reverse function.
FnRoot	/** Implements fn:root functions.
FnRound	Implements the XPath 3.1 fn:round functions.
FnSecondsFromDateTime	Implements the XPath 3.1 fn:seconds-from-dateTime.
FnSecondsFromDuration	Implements the XPath 3.1 fn:seconds-from-duration.
FnSecondsFromTime	Implements the XPath 3.1 fn:seconds-from-time.
FnStartsWith	Implements the XPath 3.1 fn:starts-with function.
FnStaticBaseUri	Implements the XPath 3.1 fn:static-base-uri function.
FnString	Implements the XPath 3.1 fn:string function.
FnStringJoin	Implements the XPath 3.1 fn:string-join function.
FnStringLength	Implements the XPath 3.1 fn:string-length functions.
FnSubstring	Implements the XPath 3.1 fn:substring functions.
FnSubstringAfter	Implements the XPath 3.1 fn:substring-after function.
FnSubstringBefore	Implements the XPath 3.1 fn:substring-before function.
FnSum	Implements the XPath 3.1 fn:sum functions.
FnTail	Implements the XPath 3.1 fn:tail function.
FnTimezoneFromDate	Implements the XPath 3.1 fn:timezone-from-date function.
FnTimezoneFromDateTime	Implements the XPath 3.1 fn:timezone-from-dateTime function.
FnTimezoneFromTime	Implements the XPath 3.1 fn:timezone-from-time function.
FnTokenize	Implements the XPath 3.1 fn:tokenize function.
FnTrue	Implements the XPath 3.1 fn:true function.
FnUpperCase	Based on the XPath 3.1 fn:upper-case functions.
FnYearFromDate	Implements the XPath 3.1 fn:year-from-date.
FnYearFromDateTime	Implements the XPath 3.1 fn:year-from-dateTime.
FnYearsFromDuration	Implements the XPath 3.1 fn:years-from-duration.
FnZeroOrOne	Implements the XPath 3.1 fn:zero-or-one function.
MapContains	Implements the XPath 3.1 map:contains function.
MapEntry	Implements the XPath 3.1 map:entry function.
MapFind	Implements the XPath 3.1 map:find function.
MapForEach	Implements the XPath 3.1 map:for-each function.
MapGet	Implements the XPath 3.1 map:get function.
MapKeys	Implements the XPath 3.1 map:keys function.
MapMerge	Implements the XPath 3.1 map:merge functions.
MapPut	Implements the XPath 3.1 map:put function.
MapRemove	Implements the XPath 3.1 map:remove function.
MapSize	Implements the XPath 3.1 map:size function.
MpBase64Decode	Provides a new Metapath function that decodes provided encoded text using base64.
MpBase64Encode	Provides a new Metapath function that encodes provided text using base64.
MpRecurseDepth	Provides new Metapath functions that evaluate a Metapath recursively over sequences generated by evaluating that expression.
NumericFunction	Provides a generic implementation of methods defined by XPath 3.1 Functions on numeric values.
NumericFunction.INumericExecutor	Implementations of this interface are used to execute a numeric opertaion on the provided item.