Package com.saxonica.functions.extfn
The package com.saxonica.functions.extfn
contains implementations of extension
functions in the Saxon namespace.
It also contains the class VendorFunctionSetPE
which acts as a factory class for
generating instances of these extension functions.
These extension functions are implemented using a variety of mechanisms. Some are implemented in the same way as system functions. Some use the "integrated extension function" mechanism introduced in Saxon 9.2.
-
Class Summary Class Description AnalyzeUri This class implements the saxon:analyze-uri() function which returns a map containing the components of a URICharactersFn Implements the saxon:characters() function.CompileQuery This class implements the saxon:compile-query() extension functionCompileStylesheet This class implements the saxon:compile-stylesheet() extension functionDecimalDivide Implements the saxon:decimal-divide() functionEnding This class supports the two extension functions saxon:ending-where and saxon:ending-before.Ending.ItemsBefore Ending.ItemsUntil EQName This class implements the saxon:EQName extension function.EscapeNCName Thesaxon:escape-NCName
function takes an arbitrary string and converts it to an NCName.Eval This class implements the saxon:eval() extension functionEvaluate This class implements the saxon:evaluate() extension functionEvaluate.PreparedExpression Inner class PreparedExpression represents a compiled XPath expression together with the standard variables $p1 ..EXPathBinaryFunctionSet Implementation of extension functions in the EXPath Binary package, see http://expath.org/spec/binaryEXPathBinaryFunctionSet.BinaryAnd EXPathBinaryFunctionSet.BinaryBin EXPathBinaryFunctionSet.BinaryDecodeString EXPathBinaryFunctionSet.BinaryEncodeString EXPathBinaryFunctionSet.BinaryFind EXPathBinaryFunctionSet.BinaryFromOctets EXPathBinaryFunctionSet.BinaryHex EXPathBinaryFunctionSet.BinaryInsertBefore EXPathBinaryFunctionSet.BinaryJoin EXPathBinaryFunctionSet.BinaryLength EXPathBinaryFunctionSet.BinaryNot EXPathBinaryFunctionSet.BinaryOctal EXPathBinaryFunctionSet.BinaryOr EXPathBinaryFunctionSet.BinaryPackDouble EXPathBinaryFunctionSet.BinaryPackFloat EXPathBinaryFunctionSet.BinaryPackInteger EXPathBinaryFunctionSet.BinaryPadLeft EXPathBinaryFunctionSet.BinaryPadRight EXPathBinaryFunctionSet.BinaryPart EXPathBinaryFunctionSet.BinaryShift EXPathBinaryFunctionSet.BinaryToOctets EXPathBinaryFunctionSet.BinaryUnpackDouble EXPathBinaryFunctionSet.BinaryUnpackFloat EXPathBinaryFunctionSet.BinaryUnpackInteger EXPathBinaryFunctionSet.BinaryUnpackUnsignedInteger EXPathBinaryFunctionSet.BinaryVersion EXPathBinaryFunctionSet.BinaryXor EXPathFileFunctionSet Implementation of the file:base-dir function in the EXPath file library.EXPathFileFunctionSet.EXPathFileFunction EXPathFileFunctionSet.FileAppend EXPathFileFunctionSet.FileAppendBinary EXPathFileFunctionSet.FileAppendText EXPathFileFunctionSet.FileAppendTextLines EXPathFileFunctionSet.FileBaseDir EXPathFileFunctionSet.FileChildren EXPathFileFunctionSet.FileCopy EXPathFileFunctionSet.FileCreateDir EXPathFileFunctionSet.FileCreateTempDir EXPathFileFunctionSet.FileCreateTempFile EXPathFileFunctionSet.FileCurrentDir EXPathFileFunctionSet.FileDelete EXPathFileFunctionSet.FileDirSeparator EXPathFileFunctionSet.FileExists EXPathFileFunctionSet.FileIsDir EXPathFileFunctionSet.FileIsFile EXPathFileFunctionSet.FileLastModified EXPathFileFunctionSet.FileLineSeparator EXPathFileFunctionSet.FileList EXPathFileFunctionSet.FileMove EXPathFileFunctionSet.FileName EXPathFileFunctionSet.FileParent EXPathFileFunctionSet.FilePathSeparator EXPathFileFunctionSet.FilePathToNative EXPathFileFunctionSet.FilePathToUri EXPathFileFunctionSet.FileReadBinary EXPathFileFunctionSet.FileReadText EXPathFileFunctionSet.FileReadTextLines EXPathFileFunctionSet.FileResolvePath EXPathFileFunctionSet.FileSize EXPathFileFunctionSet.FileTempDir EXPathFileFunctionSet.FileWrite EXPathFileFunctionSet.FileWriteBinary EXPathFileFunctionSet.FileWriteText EXPathFileFunctionSet.FileWriteTextLines ExpressionFn This class implements the saxon:expression() extension function.FunctionAnnotations Implementation of the saxon:function-annotations() extension function.GroupStarting This class supports the extension function saxon:group-starting.HighestOrLowest This class implements the saxon:highest() and saxon:lowest() extension functions.Index This class supports the extension function saxon:index, which returns an indexed sequenceIndexWhere The saxon:index-where() extension functionInScopeNamespacesFn Implementation of the saxon:in-scope-namespaces extension function.IsNaN Implements the saxon:is-NaN() function.KeyMap Implementation of the saxon:key-map() extension function.LastModified Extension function to determined the last-modified date of a fileLeading This class implements the saxon:leading() extension functions.Mailer2 Helper class for saxon:send-mail() extension functionMapSearch The saxon:map-search function, new in Saxon 9.9MessageCount This class implements the saxon:message-count() function which returns the value of message counters at the moment of executionNewAttribute Implements the saxon:new-attribute() function.NewComment Implements the saxon:new-comment() function.NewDocument Implements the saxon:new-text() function.NewElement Implements the saxon:new-text() function.NewNamespace Implements the saxon:new-namespace() function.NewProcessingInstruction Implements the saxon:new-processing-instruction() function.NewText Implements the saxon:new-text() function.ObjectMap Extension function saxon:object-map(), which converts an external object to a mapParse This class implements the saxon:parse() extension function, which is specially-recognized by the system because it needs access to parts of the static contextParseHtml Supports the saxon:parse-html() function, a variant of saxon:parse() that differs only in that it uses the TagSoup HTML parserParseXPath This class implements the saxon:parse-XPath() extension function, which is specially-recognized by the system because it needs access to parts of the static contextPedigreeFn The saxon:pedigree function, new in Saxon 9.9.QueryFn This class implements the saxon:query() extension functionReadBinaryResource Implement saxon:read-binary-resource extension functionReplaceWith This class implements the saxon:replace-with() function for replacing substrings that match a regular expression by means of a callback to a user-supplied functionResourceAccessFunction Extends SystemFunction with a method to resolve a resource and return a stream.SaxonDeepEqual Implements the saxon:deep-equal() function, a variant of fn:deep-equal that provides additional control over how the comparison is performed.SendMail This class implements the extension function saxon:send-mail().Serialize This class implements the saxon:serialize() extension function, which is specially-recognized by the system because it needs access to parts of the static contextSlice This class implements the saxon:slice() (proposed as fn:slice() for 4.0))Starting This class supports the two extension functions saxon:items-from and saxon:items-after.Starting.ItemsAfter Starting.ItemsFrom TimestampFn This class implements the saxon:timestamp() function which returns the date/time at the moment of executionTransformFn This class implements thesaxon:transform()
extension function (not to be confused with the standardfn:transform()
function in XPath 3.1)UnescapeNCName Thesaxon:unescape-NCName
function reverses the effect ofsaxon:escape-NCName
: it takes an NCName constructed usingsaxon:escape-NCName
as input, and returns the string from which it was constructed.Unindexed The extension function saxon:unindexed returns the value of its argument unchanged.VendorFunctionSetPE The VendorFunctionLibraryPE represents additions to the set of Saxon vendor-supplied extension functions that are available only with the Saxon-PE and Saxon-EE editionsVendorFunctionSetPE.AdjustToCivilTime VendorFunctionSetPE.Base64BinaryToOctets VendorFunctionSetPE.Base64BinaryToString VendorFunctionSetPE.ColumnNumber VendorFunctionSetPE.ConfigurationFn VendorFunctionSetPE.ContextFn VendorFunctionSetPE.ControllerFn VendorFunctionSetPE.CurrentModeName VendorFunctionSetPE.DiscardDocument Implement the saxon:discard-document() function, which returns its argument unchanged, but with the side-effect of removing it from the document pool, making it eligible for garbage collection.VendorFunctionSetPE.GetContext VendorFunctionSetPE.GetPseudoAttribute VendorFunctionSetPE.HasSameNodes VendorFunctionSetPE.HexBinaryToOctets VendorFunctionSetPE.HexBinaryToString VendorFunctionSetPE.InSummerTime VendorFunctionSetPE.IsDefaulted Ask whether an attribute node exists as a result of the expansion of default and fixed values defined in a schema.VendorFunctionSetPE.LineNumber VendorFunctionSetPE.NamespaceNodeFn Implement saxon:namespace-node extension functionVendorFunctionSetPE.OctetsToBase64Binary VendorFunctionSetPE.OctetsToHexBinary VendorFunctionSetPE.ParseDateTime VendorFunctionSetPE.PrintStack VendorFunctionSetPE.StringToBase64BinaryFn VendorFunctionSetPE.StringToHexBinaryFn VendorFunctionSetPE.StringToUTF8 Implement saxon:string-to-utf8 extension functionVendorFunctionSetPE.SystemId VendorFunctionSetPE.TunnelParamsFn Implement saxon:tunnel-params extension function.VendorFunctionSetPE.TypeAnnotationFn Extension function saxon:type-annotation, which returns the type annotation of a node or atomic value as an xs:QName value.VendorFunctionSetPE.UnparsedEntities Implement saxon:unparsed-entities extension functionVendorFunctionSetPE.ValidCharacter Implement saxon:valid-character extension functionWithPedigree The saxon:with-pedigree function, new in Saxon 9.9.XQueryFn This class implements the saxon:xquery() extension function