XQQuery.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2008
 *     DecisionSoft Limited. All rights reserved.
 * Copyright (c) 2004-2008
 *     Oracle. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * $Id: XQQuery.hpp 475 2008-01-08 18:47:44Z jpcs $
 */

#ifndef XQQUERY_HPP
#define XQQUERY_HPP

#include <xqilla/framework/XQillaExport.hpp>
#include <vector>
#include <string>
#include <xercesc/util/XMemory.hpp>
#include <xercesc/sax/InputSource.hpp>
#include <xqilla/runtime/ResultImpl.hpp>
#include <xqilla/runtime/LazySequenceResult.hpp>
#include <xqilla/context/StaticContext.hpp>

class DynamicContext;
class XQUserFunction;
class XQGlobalVariable;
class XQQuery;

typedef std::vector<XQUserFunction*, XQillaAllocator<XQUserFunction*> > UserFunctions;
typedef std::vector<XQGlobalVariable*, XQillaAllocator<XQGlobalVariable*> > GlobalVariables;
typedef std::vector<XQQuery*, XQillaAllocator<XQQuery*> > ImportedModules;

class XQILLA_API XQQuery : public XERCES_CPP_NAMESPACE_QUALIFIER XMemory
{
public:
  ~XQQuery();

        // @{

  DynamicContext *createDynamicContext(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                                       XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) const;

  Result execute(DynamicContext* context) const;

  void execute(EventHandler *events, DynamicContext* context) const;

  void staticResolution(StaticContext *context = 0);

  void staticTyping(StaticContext *context = 0);


  // @{

  const XMLCh* getQueryText() const;

  std::string getQueryPlan() const;


  // @{

  ASTNode* getQueryBody() const;
  void setQueryBody(ASTNode* query);

  void addFunction(XQUserFunction* fnDef);
  const UserFunctions &getFunctions() const { return m_userDefFns; }

  void addVariable(XQGlobalVariable* varDef);
  const GlobalVariables &getVariables() const { return m_userDefVars; }

  const ImportedModules &getImportedModules() const { return m_importedModules; }

  const XMLCh* getFile() const;
  void setFile(const XMLCh* file);

  const DynamicContext *getStaticContext() const { return m_context; }


  // @{

  void setIsLibraryModule(bool bIsModule=true);
  bool getIsLibraryModule() const;
  void setModuleTargetNamespace(const XMLCh* uri);
  const XMLCh* getModuleTargetNamespace() const;
  void importModule(const XMLCh* szUri, VectorOfStrings* locations, StaticContext* context, const LocationInfo *location);


private:
  class QueryResult : public ResultImpl
  {
  public:
    QueryResult(const XQQuery *query);

    Item::Ptr next(DynamicContext *context);
    std::string asString(DynamicContext *context, int indent) const;

  private:
    const XQQuery *_query;
    Result _parent;
    bool _toDo;
  };

private:
  XQQuery(const XMLCh* queryText, DynamicContext *context, bool contextOwned = false,
          XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
          XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager);

  XQQuery(const XQQuery &);
  XQQuery &operator=(const XQQuery &);

  void executeProlog(DynamicContext *context) const;

private:
  XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager* m_memMgr;

  DynamicContext *m_context;
  bool m_contextOwned;

  ASTNode* m_query;

  bool m_bIsLibraryModule;
  const XMLCh* m_szTargetNamespace;
  const XMLCh* m_szQueryText;
  const XMLCh* m_szCurrentFile;

  UserFunctions m_userDefFns;
  GlobalVariables m_userDefVars;
  ImportedModules m_importedModules;

  friend class QueryResult;
  friend class XQilla;
};

#endif

---