OMETransformResolver.h

/*
 * #%L
 * OME-XML C++ library for working with OME-XML metadata structures.
 * %%
 * Copyright © 2016 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_XML_MODEL_OMETRANSFORMRESOLVER_H
#define OME_XML_MODEL_OMETRANSFORMRESOLVER_H

#include <ostream>
#include <set>
#include <string>
#include <utility>

#include <boost/filesystem.hpp>

#include <ome/compat/cstdint.h>
#include <ome/compat/memory.h>

namespace ome
{
  namespace xml
  {

    class OMETransformResolverImpl;

    class OMETransformResolver
    {
    public:
      struct Schema
      {
        Schema():
          name()
        {}

        Schema(const std::string& name):
          name(name)
        {}

        bool
        operator< (const Schema& rhs) const
        {
          return name < rhs.name;
        }

        std::string name;
      };

      enum Quality
      {
        POOR      = 1000000LU, 
        FAIR      = 10000LU,   
        GOOD      = 100LU,     
        EXCELLENT = 1LU        
      };

      static std::string
      quality_name(OMETransformResolver::Quality quality);

      struct Transform
      {
        Transform();

        Transform(const boost::filesystem::path& file);

        Transform(const boost::filesystem::path& file,
                  Quality                        quality);

        bool
        operator< (const Transform& rhs) const
        {
          return schemas < rhs.schemas;
        }

        boost::filesystem::path file;
        std::pair<std::string, std::string> schemas;
        uint32_t weight;
      };

    public:
      OMETransformResolver();

      OMETransformResolver(const boost::filesystem::path& transformdir);

      ~OMETransformResolver();

      std::set<std::string>
      schema_versions() const;

      std::pair<std::vector<Transform>, Quality>
      transform_order(const std::string& source,
                      const std::string& target) const;

      void
      write_graphviz(std::ostream& os);

    private:
      ome::compat::shared_ptr<OMETransformResolverImpl> impl;
    };

    template<class charT, class traits>
      inline std::basic_ostream<charT,traits>&
      operator<< (std::basic_ostream<charT,traits>& os,
                  const OMETransformResolver::Quality& quality)
      {
        return os << OMETransformResolver::quality_name(quality);
      }

  }
}

#endif // OME_XML_MODEL_OMETRANSFORMRESOLVER_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */