Package net.sf.saxon.expr

Interface Callable

All Known Subinterfaces:

FunctionItem

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, ArithmeticExpression10, 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, CallableDelegate, CallableFunction, CallableWithBoundFocus, CastExpression, 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, CurrentGroupCall, CurrentGroupingKey, CurrentGroupingKeyCall, 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.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, ExsltCommonFunctionSet.NodeSetFn, ExsltCommonFunctionSet.ObjectTypeFn, ExtensionFunctionCall, FilterFn, Floor, FoldingFunction, FoldLeftFn, FoldRightFn, FootFn, ForEachFn, ForEachPairFn, FormatDate, FormatInteger, FormatNumber, FunctionAnnotations, FunctionArity, FunctionAvailable, FunctionLookup, FunctionName, GeneralComparison10, GenerateId_1, GroupStarting, HasChildren_1, HashTrieMap, HeadFn, HighestOrLowest, HighestOrLowest, IdentityFn, Idref, ImmutableArrayItem, Index, IndexOf, IndexWhere, Innermost, InScopeNamespacesFn, InScopePrefixes, InsertBefore, IntegratedFunctionCall, 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, JavaExtensionFunctionCall, JavaExtensionLibrary.UnresolvedExtensionFunctionCall, JAXPVariableReference, 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, ResourceAccessFunction, Reverse, Root_1, Round, RoundHalfToEven, SaxonDeepEqual, SaxonSlice, ScalarSystemFunction, SchemaFn, SchemaTypeFn, SendMail, SequenceMatching, SequenceMatching.ContainsSequence, SequenceMatching.EndsWithSequence, SequenceMatching.StartsWithSequence, Serialize, Serialize, SimpleArrayItem, SimpleExpression, SingleEntryMap, Slice, SnapshotFn, SomeFn, Sort_1, Sort_2, Sort_3, SQLConnect.ConnectInstruction, SQLConnectFn, SQLDeleteFn, SQLExecuteFn, SQLInsertFn, SQLPreparedQueryFn, SQLPreparedStatementFn, SQLQueryFn, SQLTableFn, SQLUpdateFn, StartsWith, StaticBaseUri, StaticContextAccessor, StaticContextAccessor.DefaultCollation, StaticFunctionCall, StreamableUserFunction, StreamAvailable, StreamFn, String_1, StringJoin, StringLength_1, StringToCodepoints, Subsequence_2, Subsequence_3, Substring, SubstringAfter, SubstringBefore, Sum, SuperId, SuperId.ElementWithId, SuperId.Id, SystemFunction, SystemFunctionCall, SystemFunctionCall.Optimized, 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, 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, XPathFunctionCall, XQueryFn, XQueryFunctionLibrary.UnresolvedCallable

public interface Callable

A generic interface for calling expressions by supplying the values of their subexpressions

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] arguments)	Call the Callable.

Method Details

call

Sequence call(XPathContext context,
 Sequence[] arguments)
       throws XPathException

Call the Callable.

Parameters:

context - the dynamic evaluation context

arguments - 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