XQueryProcessor.h

 
// Copyright (c) 2022 - 2025 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License,
// v. 2.0. If a copy of the MPL was not distributed with this file, You can
// obtain one at http://mozilla.org/MPL/2.0/. This Source Code Form is
// "Incompatible With Secondary Licenses", as defined by the Mozilla Public
// License, v. 2.0.
 
#ifndef SAXON_XQUERY_H
#define SAXON_XQUERY_H
 
#include "saxonc_export.h"
#include "saxonc/SaxonProcessor.h"
#include <string>
 
class SaxonProcessor;
class SaxonApiException;
class XdmValue;
class XdmItem;
 
class SAXONC_EXPORT XQueryProcessor {
public:
  XQueryProcessor();
 
  XQueryProcessor(SaxonProcessor *p, std::string cwd = "");
 
  XQueryProcessor(const XQueryProcessor &other);
 
  XQueryProcessor *clone();
 
  ~XQueryProcessor();
 
  void setContextItem(XdmItem *value);
 
  void setOutputFile(const char *outfile);
 
  void setContextItemFromFile(const char *filename);
 
  void setParameter(const char *name, XdmValue *value, bool withParam=true);
 
  void setLanguageVersion(const char *version);
 
  void setStreaming(bool option);
 
  bool isStreaming();
 
  bool removeParameter(const char *name);
 
  void setProperty(const char *name, const char *value);
 
  const char * getProperty(const char *name);
 
  void clearParameters(bool deleteValues = false);
 
  void clearProperties();
 
  void setUpdating(bool updating);
 
  void executeQueryToFile(const char *infilename, const char *ofilename,
                          const char *query, const char *encoding = nullptr);
 
  XdmValue *executeQueryToValue(const char *infilename, const char *query,
                                const char *encoding = nullptr);
 
  const char *executeQueryToString(const char *infilename, const char *query,
                                   const char *encoding = nullptr);
 
  XdmValue *runQueryToValue();
 
  const char *runQueryToString();
 
  void runQueryToFile();
 
  void declareNamespace(const char *prefix, const char *uri);
 
  XdmValue *getParameter(const char *name, bool withParam=true);
 
  std::map<std::string, XdmValue *> &getParameters();
 
  std::map<std::string, std::string> &getProperties();
 
  void setQueryFile(const char *filename);
 
  void setQueryContent(const char *content);
 
  void setQueryBaseURI(const char *baseURI);
 
  const char * getQueryBaseURI();
 
  void setcwd(const char *cwd);
 
 const char * getcwd();
 
  const char *checkException();
 
  bool exceptionOccurred();
 
  void exceptionClear();
 
  const char *getErrorMessage();
 
  const char *getErrorCode();
 
  SaxonApiException *getException();
 
  SaxonProcessor* getSaxonProcessor() { return proc; }
 
private:
  void createException(const char *message = nullptr);
  bool streaming;
  std::string cwdXQ; 
  SaxonProcessor *proc; 
  int64_t cppXQ;
  std::map<std::string, XdmValue *>
      parameters; 
  std::map<std::string, std::string>
      properties; 
  SaxonApiException *exception;
};
 
#endif /* SAXON_XQUERY_H */