AndroMeta/include/AndroMeta/MDLOntology.h

/*
 * Copyright 2009-2012 AndroMeta LLC. All rights reserved.
 *
 * AndroMeta LLC retains all intellectual property and proprietary 
 * rights to this software and related documentation and any modifications 
 * thereto.  Any use, reproduction, disclosure, or distribution of this 
 * software and related documentation without an express license agreement 
 * from AndroMeta LLC is strictly prohibited.
 * 
 */

#ifndef ANDROMETA_MDL_ONTOLOGY_H
#define ANDROMETA_MDL_ONTOLOGY_H

#include <AndroMeta/MEmitter.h>
#include <AndroMeta/MVar.h>
#include <AndroMeta/MTime.h>

#include <ostream>

namespace Meta{

  class MDLOntology{
  public:
  
    MDLOntology(const mstr& ontologyPath);
    
    MDLOntology(const mstr& ontologyPath, const mstr& flatOntologyPath);
    
    ~MDLOntology();
        
    void findDomains(const mstr& user,
                     const mvec& extends,
                     const mvec& notExtends,
                     mvec& out,
                     const mstr& creator="",
                     const mvar& startDomainMap=undef);
    
    void setErrorStream(std::ostream& estr);
    
    bool hasDomain(const mstr& domain);
    
    mvec normalizeExtends(const mvec& extends);
    
    mvec normalizeNotExtends(const mvec& extends);
    
    mvec domainsExtended(const mstr& domain);
    
    mvec fullDomainsExtended(const mstr& domain);
    
    mvec attributes(const mstr& domain);
    
    void createIndex(mvar& index, bool tags);
    
    void setAttribute(const mstr& creator,
                      const mstr& domain,
                      const mstr& time,
                      const mstr& attribute,
                      const mstr& value);
    
    void createDomain(const mstr& creator, const mstr& domain);
    
    const mstr& creator(const mstr& domain);
    
    mvec setDomainsExtended(const mstr& domain, const mvec& domains);
    
    void addAttribute(const mstr& creator,
                      const mstr& domain,
                      const mstr& attribute,
                      const mstr& attributeDomain);

    void deleteAttribute(const mstr& domain, const mstr& attribute);
    
    void save(bool backup);
    
    mreal epsilon();
    
    void setEpsilon(const mreal& epsilon);
    
    void deleteDomain(const mstr& domain);
    
    void setDomainDescription(const mstr& creator,
                              const mstr& domain,
                              const mstr& description);
    
    mstr domainDescription(const mstr& domain);
    
    void setAttributeDescription(const mstr& creator,
                                 const mstr& domain,
                                 const mstr& attribute,
                                 const mstr& description);
    
    mstr attributeDescription(const mstr& domain, const mstr& attribute);
    
    void removeEvents(const mstr& domain, const mstr& attribute);

    void removeEvent(const mstr& domain,
                     const mstr& time,
                     const mstr& attribute);
    
    mvec events(const mstr& domain);
    
    mvec events(const mstr& domain, const mstr& attribute);
    
    void clearEvents(const mstr& domain);
    
    void addEvent(const mstr& creator,
                  const mstr& domain,
                  const mstr& time,
                  const mstr& attribute,
                  const mstr& value);
    
    bool lock(const mstr& domain, const mstr& user);
    
    void unlock(const mstr& domain, const mstr& user);
    
    bool isLocked(const mstr& domain, const mstr& user);
    
    enum TimeType{
      TimeAt=0,
      TimeNext=1,
      TimePrevious=2
    };
    
    mstr runModel(const mstr& domain,
                  TimeType timeType,
                  const mstr& time,
                  mvar& out,
                  const mtime& timeout,
                  bool full,
                  bool description,
                  bool concise);
    
    void query(const mvec& domains, const mvar& time, mnode code, mvec& out); 
    
    void setPublicRead(const mstr& domain, bool flag);
    
    void setPublicWrite(const mstr& domain, bool flag);
    
    bool isPublicRead(const mstr& domain);
    
    bool isPublicWrite(const mstr& domain);
    
    void walkLinks(const mstr& user,
                   const mstr& domain,
                   const mstr& time,
                   size_t maxLinks,
                   mvar& out);
    
    void flatten(const mstr& outputPath, bool tags);
    
    static void createOntology(const mstr& path);

    static void patchOntology120(const mstr& path, const mstr& newPath);
    
    static void patchOntology200(const mstr& path);
    
    void mergeOntology(const mstr& mergePath);
    
    int addMethod(const mstr& creator, const mstr& domain, const mstr& method="");
    
    void renameMethod(const mstr& creator,
                      const mstr& domain,
                      int methodId,
                      const mstr& newMethod);
    
    void setMethodCode(const mstr& creator,
                       const mstr& domain,
                       int methodId,
                       const mstr& code);
    
    mstr addMethodParameter(const mstr& creator,
                            const mstr& domain,
                            int methodId,
                            const mstr& parameter="");
    
    void renameMethodParameter(const mstr& creator,
                               const mstr& domain,
                               int methodId,
                               const mstr& parameter,
                               const mstr& newParameter);
    
    void setMethodParameterType(const mstr& creator,
                                const mstr& domain,
                                int methodId,
                                const mstr& parameter,
                                const mstr& type);
    
    void setMethodParameterDomain(const mstr& creator,
                                  const mstr& domain,
                                  int methodId,
                                  const mstr& parameter,
                                  const mstr& parameterDomain);
    
    void setMethodParameterDefaultValue(const mstr& creator,
                                        const mstr& domain,
                                        int methodId,
                                        const mstr& parameter,
                                        const mstr& value);
    
    void deleteMethod(const mstr& domain, int methodId);
    
    void deleteMethodParameter(const mstr& creator,
                               const mstr& domain,
                               int methodId,
                               const mstr& parameter);
    
    void reorderMethodParameters(const mstr& creator,
                                 const mstr& domain,
                                 int methodId,
                                 const mvec& parameters);
    
    void methods(const mstr& domain, bool extended, mvec& out);
    
    void codeAssistMethods(const mstr& domain,
                           int methodId,
                           const mstr& code,
                           int cursor,
                           mvec& out);
    
    static MDLOntology* get(const mstr& path);
    
    static void release(MDLOntology* ontology);
    
    static void releaseAll();
    
  private:
    class MDLOntology_* x_;
  };
  
} // end namespace Meta

#endif // ANDROMETA_MDL_ONTOLOGY_H