OMEModelObject.h

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

#include <ome/common/log.h>

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

namespace ome
{
  namespace xml
  {
    namespace model
    {
      namespace detail
      {

        class OMEModelObject : virtual public ::ome::xml::model::OMEModelObject
        {
        protected:
          OMEModelObject (const std::string& objectType = "OMEModelObject");

        public:
          virtual
          ~OMEModelObject ();

        protected:
          OMEModelObject (const OMEModelObject& copy);

        public:
          bool
          validElementName(const std::string& name) const = 0;

          virtual common::xml::dom::Element
          asXMLElement (common::xml::dom::Document& document) const;

          // @copydoc doesn't work here due to doxygen issues with
          // overloading and parameter namespaces, so duplicate
          // entirely.
          virtual void
          asXMLElement (common::xml::dom::Document& document,
                        common::xml::dom::Element&  element) const;
        protected:
          virtual void
          asXMLElementInternal (common::xml::dom::Document& document,
                                common::xml::dom::Element&  element) const = 0;

        public:
          virtual void
          update (const common::xml::dom::Element&  element,
                  ::ome::xml::model::OMEModel& model);

          virtual bool
          link (std::shared_ptr<Reference>&                         reference,
                std::shared_ptr<::ome::xml::model::OMEModelObject>& object);

          static std::vector<common::xml::dom::Element>
          getChildrenByTagName (const common::xml::dom::Element& parent,
                                const std::string&          name);

          static std::string
          stripNamespacePrefix (const std::string& value);

        protected:
          template<typename T>
          class compare_element
          {
          private:
            const std::shared_ptr<const T>& cmp;

          public:
            compare_element(const std::shared_ptr<const T>& cmp):
              cmp(cmp)
            {}

            bool
            operator () (const std::shared_ptr<T>& element)
            {
              return cmp && element && cmp == element;
            }

            bool
            operator () (const std::shared_ptr<const T>& element)
            {
              return cmp && element && cmp == element;
            }

            bool
            operator () (const std::weak_ptr<T>& element)
            {
              std::shared_ptr<const T> shared_element(element);
              return cmp && shared_element && cmp == shared_element;
            }

            bool
            operator () (const std::weak_ptr<const T>& element)
            {
              std::shared_ptr<const T> shared_element(element);
              return cmp && shared_element && cmp == shared_element;
            }
          };

          template<class C, typename T>
          bool
          contains(const C&                  container,
                   const std::shared_ptr<T>& element)
          {
            return (std::find_if(container.begin(),
                                 container.end(),
                                 compare_element<T>(element)) != container.end());
          }

          ome::common::Logger logger;
        };

      }
    }
  }
}

#endif // OME_XML_MODEL_DETAIL_OMEMODELOBJECT_H

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