org.exist.xquery
Interface CompiledXQuery

All Superinterfaces:

org.xmldb.api.base.CompiledExpression

All Known Implementing Classes:

AbstractCompressFunction, AbstractExtractFunction, AbstractMatchFunction, AccountFunctions, AddMatch, AnalyzeString, ApplyImports, ApplyTemplates, AsUser, Attribute, AttributeSet, Base64Functions, BaseConverter, BaseHTTPClientFunction, BasicFunction, BinaryDoc, BinaryOp, BinaryToString, BuiltinFunctions, CacheBasicFunction, CacheFunction, CallFunction, CallTemplate, CatchFunction, CharacterMap, Choose, Clear, ClearFunction, ClearFunction, CloseContextFunction, CollatingFunction, Collations, CollectionName, Comment, Compare, Compile, ContextAttributes, ContextGet, Copy, CopyOf, CountDayInMonthFunction, CounterFunctions, CountInstances, Create, CreateFunction, CreateOrderIndex, CropFunction, Current, DateForFunction, DateFromDateTimeFunction, DateRangeFunctions, DayInWeekFunction, DaysInMonthFunction, DecimalFormat, Declaration, DecodeExiFunction, DeepCopyFunction, DeleteFunction, DELETEFunction, DeleteGroupFunction, DeleteScheduledJob, Deploy, DeprecatedExtDoctype, DeprecatedExtDocument, DeprecatedExtRegexp, DeprecatedExtRegexpOr, DeprecatedExtXCollection, DeprecatedFunItemAt, DescribeFunction, DiffFunction, Directory, DirectoryCreate, DirectoryList, Document, Document, DocumentNameOrId, EchoFunction, Element, EnclosedExpr, EncodeExiFunction, EncodeURL, EncryptionFunctions, Eval, ExclusiveLockFunction, ExecuteFunction, Expand, ExtCollection, ExtFulltext, ExtNear, ExtPhrase, ExtractDocs, Fallback, FileDelete, FileExists, FileIsDirectory, FileIsReadable, FileIsWriteable, FileMove, FileRead, FileReadBinary, FileReadUnicode, FilterNested, FindGroupFunction, FindLastModifiedSince, FindUserFunction, ForEach, ForEachGroup, Format_date, Format_dateTime, Format_number, Format_time, FormatDateFunction, FormatDateTimeFunction, FormatTimeFunction, FtIndexLookup, FunAbs, FunAdjustTimezone, FunAnalyzeString, FunAvg, FunBaseURI, FunBoolean, FunCeiling, FunCodepointEqual, FunCodepointsToString, FunCompare, FunConcat, FunContains, FunCount, Function, Function, FunctionAvailable, FunctionCall, FunctionFunction, FunctionTrace, FunCurrentDateTime, FunData, FunDateTime, FunDeepEqual, FunDefaultCollation, FunDistinctValues, FunDoc, FunDocAvailable, FunDoctype, FunDocumentURI, FunEmpty, FunEncodeForURI, FunEndsWith, FunEquals, FunError, FunEscapeHTMLURI, FunEscapeURI, FunExactlyOne, FunExists, FunFloor, FunGetDateComponent, FunGetDurationComponent, FunId, FunIdRef, FunImplicitTimezone, FunIndexOf, FunInScopePrefixes, FunInsertBefore, FunIRIToURI, FunLang, FunLast, FunLocalName, FunMatches, FunMax, FunMin, FunName, FunNamespaceURI, FunNamespaceURIForPrefix, FunNilled, FunNodeName, FunNormalizeSpace, FunNormalizeUnicode, FunNot, FunNumber, FunOneOrMore, FunPosition, FunQName, FunRemove, FunReplace, FunResolveQName, FunResolveURI, FunReverse, FunRoot, FunRound, FunRoundHalfToEven, FunStartsWith, FunString, FunStringJoin, FunStringPad, FunStringToCodepoints, FunStrLength, FunSubSequence, FunSubstring, FunSubstringAfter, FunSubstringBefore, FunSum, FunTokenize, FunTrace, FunTranslate, FunTrueOrFalse, FunUnEscapeURI, FunUnordered, FunUpperOrLowerCase, FunXCollection, FunZeroOrOne, FuzzyIndexTerms, FuzzyMatchAll, FuzzyMatchAny, GeneralComparison, Generate_id, GenerateSignatureFunction, GenerateXMLSignatureFunction, GetAccountMetadataFunction, GetAttribute, GetAttributeNames, GetBuild, GetConnectionFunction, GetConnectionFunction, GetContextPath, GetCookieNames, GetCookieValue, GetCreationTime, GetData, GetDirContextFunction, GetDirListFunction, GetExistHome, GetExists, GetExists, GetExists, GetField, GetFileFunction, GetFragmentBetween, GetFunction, GETFunction, GetHeader, GetHeaderNames, GetHeightFunction, GetHostname, GetID, GetID, GetIndex, GetIndexStatistics, GetJNDIConnectionFunction, GetLastAccessedTime, GetMaxInactiveInterval, GetMemory, GetMetadataFunction, GetMethod, GetModuleLoadPath, GetNodeById, GetParameter, GetParameterNames, GetPathInfo, GetQueryString, GetRemoteAddr, GetRemoteHost, GetRemotePort, GetRequestAttribute, GetResource, GetRevision, GetRunningJobs, GetRunningXQueries, GetScheduledJobs, GetScheduledJobs, GetScheme, GetSequenceType, GetServerName, GetServerPort, GetThumbnailsFunction, GetUploadedFile, GetUploadedFileName, GetUploadedFileSize, GetUptime, GetURI, GetURL, GetVersion, GetWidthFunction, GrammarTooling, GroupMembershipFunctions, GZipFunction, Hash, HasIndex, HEADFunction, HighlightMatches, HighlightMatches, HmacFunctions, If, Import, ImportSchema, Include, Index, IndexKeyDocuments, IndexKeyOccurrences, IndexKeys, IndexTerms, IndexType, Init, InstallFunction, InternalFunctionCall, Invalidate, IsExternallyAuthenticated, IsMultiPartContent, JavaCall, Jaxp, Jaxv, Jing, Key, Key, KillRunningXQuery, KWICDisplay, LibFunction, ListBackups, ListFunction, LockFunction, LogFunction, LogicalOp, MailFolderFunctions, MailSessionFunctions, MailStoreFunctions, MatchCount, MatchingSubstring, MatchRegexp, Message, MessageListFunctions, MetadataFunctions, ModifyFunction, ModuleInfo, Namespace, NamespaceAlias, NextMatch, NGramSearch, NodeComparison, NodeId, NodeXPath, NonMatchingSubstring, NoParamFunctions, Number, OneParamFunctions, OpAnd, OpNumeric, OpOr, Optimize, OPTIONSFunction, Otherwise, Output, OutputCharacter, Param, Parse, ParseDateFunction, ParseDateTimeFunction, ParseSimpleQL, ParseTimeFunction, PatchFunction, PathExpr, PauseScheduledJob, PerformSort, PermissionsFunctions, POSTFunction, Predicate, PrepareFunction, PreserveSpace, ProcessingInstruction, Profile, PrologFunctions, PutFunction, PUTFunction, QNameFunctions, QNameIndexLookup, Query, QueryField, RandomFunction, RangeExpression, RedirectTo, RegexpFilter, RemoveAttribute, RemoveFunction, RemoveFunction, RemoveIndex, RemoveIndex, RenameFunction, Restore, ResultDocument, ResumeScheduledJob, RetrieveBackup, Run, ScaleFunction, Scan, ScheduleFunctions, Score, Search, SearchFunction, SendEmailFunction, SendFileFunction, SendRequestFunction, SequenceConstructor, SequenceConstructor, Serialize, SerializeToFile, SetAttribute, SetAttribute, SetCookie, SetCurrentUser, SetDateHeader, SetHeader, SetMaxInactiveInterval, SetStatusCode, SharedLockFunction, Shutdown, SimpleConstructor, Sort, Source, StackGet, StepInto, StepOut, StepOver, Stop, Stream, StreamBinary, StripSpace, Sync, System_property, SystemProperty, SystemTime, TarFunction, Template, Text, TextRank, TimeFromDateTimeFunction, Tokenize, Transform, TriggerSystemTask, TwoParamFunctions, UnaryExpr, UnGZipFunction, Unparsed_entity_public_id, Unparsed_entity_uri, Unparsed_text, Unparsed_text_available, UnTarFunction, UnZipFunction, UpdateStatistics, UserDefinedFunction, UUID, ValidateSignatureFunction, Validation, ValueComparison, ValueOf, Variable, Wait, WeekInMonthFunction, When, WithParam, XMLDBAbstractCollectionManipulator, XMLDBAddUserToGroup, XMLDBAuthenticate, XMLDBChangeUser, XMLDBChmodCollection, XMLDBChmodResource, XMLDBCollectionAvailable, XMLDBCopy, XMLDBCreateCollection, XMLDBCreated, XMLDBCreateGroup, XMLDBCreateUser, XMLDBDefragment, XMLDBDeleteUser, XMLDBDocument, XMLDBGetChildCollections, XMLDBGetChildResources, XMLDBGetCurrentUser, XMLDBGetCurrentUserAttribute, XMLDBGetCurrentUserAttributeNames, XMLDBGetMimeType, XMLDBGetUserOrGroup, XMLDBGetUsers, XMLDBGroupExists, XMLDBHasLock, XMLDBIsAdmin, XMLDBIsAuthenticated, XMLDBLoadFromPattern, XMLDBMatchCollection, XMLDBMove, XMLDBPermissions, XMLDBPermissionsToString, XMLDBRegisterDatabase, XMLDBReindex, XMLDBRemove, XMLDBRemoveUserFromGroup, XMLDBRename, XMLDBSetCollectionPermissions, XMLDBSetResourcePermissions, XMLDBSize, XMLDBStore, XMLDBURIFunctions, XMLDBUserAccess, XMLDBXUpdate, XSLPathExpr, XSLStylesheet, ZipEntryFunctions, ZipFunction

public interface CompiledXQuery
extends org.xmldb.api.base.CompiledExpression

Method Summary

void	dump(java.io.Writer writer) Writes a diagnostic dump of the expression structure to the specified writer.
Sequence	eval(Sequence contextSequence) Execute the compiled query, optionally using the specified sequence as context.
XQueryContext	getContext()
XACMLSource	getSource() Gets the source of this query.
boolean	isValid() Is the compiled expression still valid? Returns false if, for example, the source code of one of the imported modules has changed.
void	reset() Reset the compiled expression tree.
void	setContext(XQueryContext context)

Method Detail

reset

void reset()

Reset the compiled expression tree. Discard all temporary expression results.

Specified by:

reset in interface org.xmldb.api.base.CompiledExpression

getContext

XQueryContext getContext()

Returns:

the XQueryContext used to create this query

setContext

void setContext(XQueryContext context)

eval

Sequence eval(Sequence contextSequence)
              throws XPathException

Execute the compiled query, optionally using the specified sequence as context.

Parameters:

contextSequence -

Throws:

XPathException

isValid

boolean isValid()

Is the compiled expression still valid? Returns false if, for example, the source code of one of the imported modules has changed.

dump

void dump(java.io.Writer writer)

Writes a diagnostic dump of the expression structure to the specified writer.

getSource

XACMLSource getSource()

Gets the source of this query.

Returns:

This query's source