# XQilla Simple API Documentation

- Main Page
- Namespaces
- Classes
- Files
- Examples

- File List
- File Members

# ExternalFunction.hpp

Go to the documentation of this file.

    00001 /*
    00002  * Copyright (c) 2001, 2008,
    00003  *     DecisionSoft Limited. All rights reserved.
    00004  * Copyright (c) 2004, 2015 Oracle and/or its affiliates. All rights reserved.
    00005  *
    00006  *
    00007  * Licensed under the Apache License, Version 2.0 (the "License");
    00008  * you may not use this file except in compliance with the License.
    00009  * You may obtain a copy of the License at
    00010  *
    00011  *     http://www.apache.org/licenses/LICENSE-2.0
    00012  *
    00013  * Unless required by applicable law or agreed to in writing, software
    00014  * distributed under the License is distributed on an "AS IS" BASIS,
    00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    00016  * See the License for the specific language governing permissions and
    00017  * limitations under the License.
    00018  */
    00019
    00020 #ifndef _EXTERNALFUNCTION_HPP
    00021 #define _EXTERNALFUNCTION_HPP
    00022
    00023 #include <xqilla/framework/XQillaExport.hpp>
    00024
    00025 #include <xercesc/util/XMLUniDefs.hpp>
    00026
    00027 class Result;
    00028 class PendingUpdateList;
    00029 class DynamicContext;
    00030 class XPath2MemoryManager;
    00031
    00032 class XQILLA_API ExternalFunction
    00033 {
    00034 public:
    00035   class XQILLA_API Arguments
    00036   {
    00037   public:
    00038     virtual ~Arguments() {}
    00039
    00041     virtual Result getArgument(size_t index, DynamicContext *context) const = 0;
    00042   };
    00043
    00044   virtual ~ExternalFunction() {}
    00045
    00046   const XMLCh *getURI() const { return uri_; }
    00047   const XMLCh *getName() const { return name_; }
    00048   const XMLCh *getURINameHash() const { return uriName_; }
    00049   unsigned int getNumberOfArguments() const { return numArgs_; }
    00050
    00052   virtual Result execute(const Arguments *args, DynamicContext *context) const;
    00054   virtual PendingUpdateList executeUpdate(const Arguments *args, DynamicContext *context) const;
    00055
    00056 protected:
    00057   ExternalFunction(const XMLCh *uri, const XMLCh *name, unsigned int numberOfArgs, XPath2MemoryManager *mm);
    00058
    00059   const XMLCh *uri_;
    00060   const XMLCh *name_;
    00061   const XMLCh *uriName_;
    00062   unsigned int numArgs_;
    00063 };
    00064
    00065 #endif
    00066