OMEModel.h

/*
 * #%L
 * OME-XML C++ library for working with OME-XML metadata structures.
 * %%
 * Copyright © 2006 - 2015 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_OMEMODEL_H
#define OME_XML_MODEL_OMEMODEL_H

#include <map>
#include <string>
#include <vector>

#include <ome/compat/memory.h>

#include <ome/xml/model/OMEModelObject.h>

namespace ome
{
  namespace xml
  {
    namespace model
    {

      class Reference;

      class OMEModel
      {
      public:
        typedef std::vector<ome::compat::shared_ptr<Reference> > reference_list_type;
        typedef std::map<std::string, ome::compat::shared_ptr<OMEModelObject> > object_map_type;
        typedef std::map<ome::compat::shared_ptr<OMEModelObject>, reference_list_type> reference_map_type;
        typedef reference_map_type::size_type size_type;

      protected:
        OMEModel ()
        {}

      public:
        virtual
        ~OMEModel ()
        {}

      private:
        OMEModel (const OMEModel&);

        OMEModel&
        operator= (const OMEModel&);

      public:
        virtual
        ome::compat::shared_ptr<OMEModelObject>
        addModelObject (const std::string&                       id,
                        ome::compat::shared_ptr<OMEModelObject>& object) = 0;

        virtual
        ome::compat::shared_ptr<OMEModelObject>
        removeModelObject (const std::string& id) = 0;

        virtual
        ome::compat::shared_ptr<OMEModelObject>
        getModelObject (const std::string& id) const = 0;

        virtual
        const object_map_type&
        getModelObjects () const = 0;

        virtual
        bool
        addReference (ome::compat::shared_ptr<OMEModelObject>& a,
                      ome::compat::shared_ptr<Reference>&      b) = 0;

        virtual
        const reference_map_type&
        getReferences () const = 0;

        virtual
        size_type
        resolveReferences () = 0;

      };

    }
  }
}

#endif // OME_XML_MODEL_OMEMODEL_H

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