Package net.sf.saxon.om
Interface FunctionItem
- All Superinterfaces:
Callable
,GroundedValue
,Item
,Sequence
- All Known Implementing Classes:
Abs
,AbstractArrayItem
,AbstractFunction
,AccessorFn
,AccessorFn.DayFromDate
,AccessorFn.DayFromDateTime
,AccessorFn.DaysFromDuration
,AccessorFn.HoursFromDateTime
,AccessorFn.HoursFromDuration
,AccessorFn.HoursFromTime
,AccessorFn.LocalNameFromQName
,AccessorFn.MinutesFromDateTime
,AccessorFn.MinutesFromDuration
,AccessorFn.MinutesFromTime
,AccessorFn.MonthFromDate
,AccessorFn.MonthFromDateTime
,AccessorFn.MonthsFromDuration
,AccessorFn.NamespaceUriFromQName
,AccessorFn.PrefixFromQName
,AccessorFn.SecondsFromDateTime
,AccessorFn.SecondsFromDuration
,AccessorFn.SecondsFromTime
,AccessorFn.TimezoneFromDate
,AccessorFn.TimezoneFromDateTime
,AccessorFn.TimezoneFromTime
,AccessorFn.YearFromDate
,AccessorFn.YearFromDateTime
,AccessorFn.YearsFromDuration
,AccumulatorFn
,AccumulatorFn.AccumulatorAfter
,AccumulatorFn.AccumulatorBefore
,Adjust_1
,Adjust_2
,Aggregate
,AllDifferent
,AllEqual
,AnalyzeStringFn
,AnalyzeUri
,ApplyFn
,ArrayFunctionSet.ArrayAppend
,ArrayFunctionSet.ArrayBuild
,ArrayFunctionSet.ArrayEmpty
,ArrayFunctionSet.ArrayExists
,ArrayFunctionSet.ArrayFilter
,ArrayFunctionSet.ArrayFlatten
,ArrayFunctionSet.ArrayFoldLeft
,ArrayFunctionSet.ArrayFoldRight
,ArrayFunctionSet.ArrayFoot
,ArrayFunctionSet.ArrayForEach
,ArrayFunctionSet.ArrayForEachPair
,ArrayFunctionSet.ArrayFromSequence
,ArrayFunctionSet.ArrayGeneratingFunction
,ArrayFunctionSet.ArrayGet
,ArrayFunctionSet.ArrayHead
,ArrayFunctionSet.ArrayIndexWhere
,ArrayFunctionSet.ArrayInsertBefore
,ArrayFunctionSet.ArrayJoin
,ArrayFunctionSet.ArrayMembers
,ArrayFunctionSet.ArrayOfMembers
,ArrayFunctionSet.ArrayPut
,ArrayFunctionSet.ArrayRemove
,ArrayFunctionSet.ArrayReplace
,ArrayFunctionSet.ArrayReverse
,ArrayFunctionSet.ArraySize
,ArrayFunctionSet.ArraySlice
,ArrayFunctionSet.ArraySplit
,ArrayFunctionSet.ArraySubarray
,ArrayFunctionSet.ArrayTail
,ArrayFunctionSet.ArrayToSequence
,ArrayFunctionSet.ArrayTrunk
,ArrayItem
,ArraySort
,AtomicConstructorFunction
,AtomicEqual
,AvailableEnvironmentVariables
,AvailableSystemProperties
,Average
,BaseUri_1
,BooleanFn
,BuildURI
,CallableFunction
,Ceiling
,CharactersFn
,CharactersFn
,CharFn
,CodepointEqual
,CodepointsToString
,CoercedFunction
,CollatingFunctionFixed
,CollatingFunctionFree
,CollationKeyFn
,CollectionFn
,Compare
,CompileQuery
,CompileStylesheet
,CompileXPath
,Concat
,Concat31
,ConstantFunction
,ConstantFunction.False
,ConstantFunction.True
,Contains
,ContainsToken
,ContextAccessorFunction
,ContextItemAccessorFunction
,ContextItemAccessorFunction.Number_0
,ContextItemAccessorFunction.StringAccessor
,CopyOfFn
,Count
,Current
,CurrentGroup
,CurrentGroupingKey
,CurrentMergeGroup
,CurrentMergeKey
,CurrentOutputUri
,CurriedFunction
,Data_1
,DateTimeConstructor
,DecimalDivide
,DecodeFromURI
,DeepEqual
,DelegatingArrayItem
,DelegatingMapItem
,DictionaryMap
,DistinctValues
,Doc
,Doc_2
,DocAvailable
,DocumentFn
,DocumentUri_1
,DuplicateValues
,DynamicContextAccessor
,DynamicContextAccessor.CurrentDate
,DynamicContextAccessor.CurrentDateTime
,DynamicContextAccessor.CurrentTime
,DynamicContextAccessor.DefaultLanguage
,DynamicContextAccessor.ImplicitTimezone
,ElementAvailable
,Empty
,EncodeForUri
,EndsWith
,EnvironmentVariable
,EQName
,Error
,EscapeHtmlUri
,EscapeNCName
,Eval
,Evaluate
,EveryFn
,Exists
,ExpandedQNameFn
,EXPathBinaryFunctionSet.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.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
,ExsltCommonFunctionSet.NodeSetFn
,ExsltCommonFunctionSet.ObjectTypeFn
,FilterFn
,Floor
,FoldingFunction
,FoldLeftFn
,FoldRightFn
,FootFn
,ForEachFn
,ForEachPairFn
,FormatDate
,FormatInteger
,FormatNumber
,FunctionAnnotations
,FunctionArity
,FunctionAvailable
,FunctionLookup
,FunctionName
,GenerateId_1
,GroupStarting
,HasChildren_1
,HashTrieMap
,HeadFn
,HighestOrLowest
,HighestOrLowest
,IdentityFn
,Idref
,ImmutableArrayItem
,Index
,IndexOf
,IndexWhere
,Innermost
,InScopeNamespacesFn
,InScopePrefixes
,InsertBefore
,Intersperse
,IriToUri
,IsNaN
,ItemsAt
,ItemsEnding
,ItemsEnding.ItemsBefore
,ItemsEnding.ItemsUntil
,ItemsStarting
,ItemsStarting.ItemsAfter
,ItemsStarting.ItemsFrom
,IterateWhileFn
,IXSLFunctionSet.Call
,IXSLFunctionSet.Eval
,IXSLFunctionSet.ScheduleActionFn
,IXSLFunctionSet.Source
,IXSLFunctionSet.Stub
,JsonDoc
,JsonToXMLFn
,KeyFn
,KeyMap
,Lang
,LastModified
,Leading
,ListCastableFunction
,ListConstructorFunction
,LoadXqueryModule
,LocalName_1
,LowerCase
,MapCreate
,MapFunctionSet.MapBuild
,MapFunctionSet.MapContains
,MapFunctionSet.MapEntries
,MapFunctionSet.MapEntry
,MapFunctionSet.MapFilter
,MapFunctionSet.MapFind
,MapFunctionSet.MapForEach
,MapFunctionSet.MapGet
,MapFunctionSet.MapKeys
,MapFunctionSet.MapMerge
,MapFunctionSet.MapOfPairs
,MapFunctionSet.MapPair
,MapFunctionSet.MapPairs
,MapFunctionSet.MapPut
,MapFunctionSet.MapRemove
,MapFunctionSet.MapSize
,MapItem
,MapSearch
,MapUntypedContains
,Matches
,MathFunctionSet.Atan2Fn
,MathFunctionSet.PiFn
,MathFunctionSet.PowFn
,MathFunctionSet.TrigFn1
,MemoFunction
,MessageCount
,Minimax
,Minimax.Max
,Minimax.Min
,Name_1
,NamespaceForPrefix
,NamespaceUriFn_1
,NewAttribute
,NewComment
,NewDocument
,NewElement
,NewNamespace
,NewProcessingInstruction
,NewText
,Nilled_1
,NodeName_1
,NormalizeSpace_1
,NormalizeUnicode
,NotFn
,Number_1
,ObjectMap
,OpFn
,OriginalFunction
,Outermost
,Parcel
,ParcelFn
,Parse
,ParseHtml
,ParseIetfDate
,ParseInteger
,ParseJsonFn
,ParseQNameFn
,ParseURI
,ParseXml
,ParseXmlFragment
,ParseXPath
,Partition
,Parts
,Path_1
,PedigreeArrayItem
,PedigreeFn
,PedigreeMapItem
,PositionAndLast
,PositionAndLast.Last
,PositionAndLast.Position
,Put
,QNameFn
,QueryFn
,RandomNumberGenerator
,RangeKey
,ReadBinaryResource
,RegexFunction
,RegexFunctionSansFlags
,RegexGroup
,Remove
,Replace
,ReplaceWith
,Replicate
,ResolveQName
,ResolveURI
,Reverse
,Root_1
,Round
,RoundHalfToEven
,SaxonDeepEqual
,SaxonSlice
,ScalarSystemFunction
,SchemaFn
,SchemaTypeFn
,SendMail
,SequenceMatching
,SequenceMatching.ContainsSequence
,SequenceMatching.EndsWithSequence
,SequenceMatching.StartsWithSequence
,Serialize
,Serialize
,SimpleArrayItem
,SingleEntryMap
,Slice
,SnapshotFn
,SomeFn
,Sort_1
,Sort_2
,Sort_3
,SQLConnectFn
,SQLDeleteFn
,SQLExecuteFn
,SQLInsertFn
,SQLPreparedQueryFn
,SQLPreparedStatementFn
,SQLQueryFn
,SQLTableFn
,SQLUpdateFn
,StartsWith
,StaticBaseUri
,StaticContextAccessor
,StaticContextAccessor.DefaultCollation
,StreamableUserFunction
,StreamAvailable
,StreamFn
,String_1
,StringJoin
,StringLength_1
,StringToCodepoints
,Subsequence_2
,Subsequence_3
,Substring
,SubstringAfter
,SubstringBefore
,Sum
,SuperId
,SuperId.ElementWithId
,SuperId.Id
,SystemFunction
,SystemFunctionWithBoundContextItem
,SystemProperty
,TailFn
,TimestampFn
,Tokenize_1
,Tokenize_3
,Trace
,TransformFn
,TransformFn
,TransitiveClosure
,Translate
,TreatFn
,TreatFn.ExactlyOne
,TreatFn.OneOrMore
,TreatFn.ZeroOrOne
,Trunk
,TypeAvailable
,UnescapeNCName
,Unindexed
,UnionCastableFunction
,UnionConstructorFunction
,Unordered
,UnparcelFn
,UnparsedEntity
,UnparsedEntity.UnparsedEntityPublicId
,UnparsedEntity.UnparsedEntityUri
,UnparsedText
,UnparsedTextAvailable
,UnparsedTextFunction
,UnparsedTextLines
,UnresolvedXQueryFunctionItem
,UpperCase
,UriCollection
,URIFunctions
,UserFunction
,UserFunctionReference.BoundUserFunction
,ValidateFn
,VendorFunctionSetHE.ArrayAsSequenceOfMaps
,VendorFunctionSetHE.ConcatenateSequences
,VendorFunctionSetHE.DynamicErrorInfoFn
,VendorFunctionSetHE.HasLocalNamespaces
,VendorFunctionSetHE.HasUniformNamespaces
,VendorFunctionSetHE.IsWholeNumberFn
,VendorFunctionSetHE.MapAsSequenceOfMaps
,VendorFunctionSetHE.YesNoBoolean
,VendorFunctionSetPE.AdjustToCivilTime
,VendorFunctionSetPE.Base64BinaryToOctets
,VendorFunctionSetPE.Base64BinaryToString
,VendorFunctionSetPE.ColumnNumber
,VendorFunctionSetPE.ConfigurationFn
,VendorFunctionSetPE.ContextFn
,VendorFunctionSetPE.ControllerFn
,VendorFunctionSetPE.CurrentModeName
,VendorFunctionSetPE.DiscardDocument
,VendorFunctionSetPE.GetContext
,VendorFunctionSetPE.GetPseudoAttribute
,VendorFunctionSetPE.HasSameNodes
,VendorFunctionSetPE.HexBinaryToOctets
,VendorFunctionSetPE.HexBinaryToString
,VendorFunctionSetPE.InSummerTime
,VendorFunctionSetPE.IsDefaulted
,VendorFunctionSetPE.LineNumber
,VendorFunctionSetPE.NamespaceNodeFn
,VendorFunctionSetPE.OctetsToBase64Binary
,VendorFunctionSetPE.OctetsToHexBinary
,VendorFunctionSetPE.ParseDateTime
,VendorFunctionSetPE.PrintStack
,VendorFunctionSetPE.StringToBase64BinaryFn
,VendorFunctionSetPE.StringToHexBinaryFn
,VendorFunctionSetPE.StringToUTF8
,VendorFunctionSetPE.SystemId
,VendorFunctionSetPE.TunnelParamsFn
,VendorFunctionSetPE.TypeAnnotationFn
,VendorFunctionSetPE.UnparsedEntities
,VendorFunctionSetPE.ValidCharacter
,VoidFn
,WithPedigree
,XdmToJsonFn
,XMLToJsonFn
,XQueryFn
XDM 3.0 introduces a third kind of item, beyond nodes and atomic values: the function. Functions
implement this interface.
- Since:
- 12.0; previously named
Function
.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
deepEqual40
(FunctionItem other, XPathContext context, DeepEqual.DeepEqualOptions options) boolean
deepEquals
(FunctionItem other, XPathContext context, AtomicComparer comparer, int flags) Test whether this FunctionItem is deep-equal to another function item, under the rules of the deep-equal functionvoid
Output information about this function item to the diagnostic explain() outputGet the function annotations (as defined in XQuery).int
getArity()
Get the arity of the functionGet a description of this function for use in error messages.Get the item type of the function itemGet the name of the function, or null if it is anonymousdefault Genre
getGenre()
Get the genre of this itemGet the roles of the arguments, for the purposes of streamingboolean
isArray()
Ask whether this function item is an arrayboolean
isMap()
Ask whether this function item is a mapdefault boolean
Ask whether the function is sequence-variadic (accepts a variable number of arguments)boolean
Ask if the function can be trusted to return a result of the correct typemakeNewContext
(XPathContext callingContext, ContextOriginator originator) Prepare an XPathContext object for evaluating the functiondefault String
Provide a short string showing the contents of the item, suitable for use in error messagesMethods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
Methods inherited from interface net.sf.saxon.om.Item
atomize, getLength, getStringValue, getUnicodeStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Method Details
-
isMap
boolean isMap()Ask whether this function item is a map- Returns:
- true if this function item is a map, otherwise false
-
isArray
boolean isArray()Ask whether this function item is an array- Returns:
- true if this function item is an array, otherwise false
-
getFunctionItemType
FunctionItemType getFunctionItemType()Get the item type of the function item- Returns:
- the function item's type
-
getFunctionName
StructuredQName getFunctionName()Get the name of the function, or null if it is anonymous- Returns:
- the function name, or null for an anonymous inline function
-
getArity
int getArity()Get the arity of the function- Returns:
- the number of arguments in the function signature
-
isSequenceVariadic
default boolean isSequenceVariadic()Ask whether the function is sequence-variadic (accepts a variable number of arguments)- Returns:
- true if the function is sequence-variadic; default is false
-
getOperandRoles
OperandRole[] getOperandRoles()Get the roles of the arguments, for the purposes of streaming- Returns:
- an array of OperandRole objects, one for each argument
-
getAnnotations
AnnotationList getAnnotations()Get the function annotations (as defined in XQuery). Returns an empty list if there are no function annotations.- Returns:
- the function annotations
-
makeNewContext
Prepare an XPathContext object for evaluating the function- Parameters:
callingContext
- the XPathContext of the function calling expressionoriginator
- identifies the location of the caller for diagnostics- Returns:
- a suitable context for evaluating the function (which may or may not be the same as the caller's context)
-
deepEquals
boolean deepEquals(FunctionItem other, XPathContext context, AtomicComparer comparer, int flags) throws XPathException Test whether this FunctionItem is deep-equal to another function item, under the rules of the deep-equal function- Parameters:
other
- the other function itemcontext
- the dynamic evaluation contextcomparer
- the object to perform the comparisonflags
- options for how the comparison is performed- Returns:
- true if the two function items are deep-equal
- Throws:
XPathException
- if the comparison cannot be performed
-
deepEqual40
boolean deepEqual40(FunctionItem other, XPathContext context, DeepEqual.DeepEqualOptions options) throws XPathException - Throws:
XPathException
-
getDescription
String getDescription()Get a description of this function for use in error messages. For named functions, the description is the function name (as a lexical QName). For others, it might be, for example, "inline function", or "partially-applied ends-with function".- Returns:
- a description of the function for use in error messages
-
export
Output information about this function item to the diagnostic explain() output- Parameters:
out
- the destination for the information- Throws:
XPathException
- if things go wrong
-
isTrustedResultType
boolean isTrustedResultType()Ask if the function can be trusted to return a result of the correct type- Returns:
- true if the implementation can be trusted
-
toShortString
Provide a short string showing the contents of the item, suitable for use in error messages- Specified by:
toShortString
in interfaceGroundedValue
- Specified by:
toShortString
in interfaceItem
- Returns:
- a depiction of the item suitable for use in error messages
-
getGenre
Get the genre of this item- Specified by:
getGenre
in interfaceItem
- Returns:
- the genre: specifically,
Genre.FUNCTION
. Overridden for maps and arrays.
-