Update copyright.
[shibboleth/cpp-xmltooling.git] / xmltooling / AbstractAttributeExtensibleXMLObject.h
index c172b50..a18b953 100644 (file)
@@ -1,82 +1,98 @@
-/*\r
- *  Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file AbstractAttributeExtensibleXMLObject.h\r
- * \r
- * An abstract implementation of a DOM-caching AttributeExtensibleXMLObject \r
- */\r
-\r
-#if !defined(__xmltooling_absattrextxmlobj_h__)\r
-#define __xmltooling_absattrextxmlobj_h__\r
-\r
-#include <map>\r
-#include <xmltooling/AbstractDOMCachingXMLObject.h>\r
-#include <xmltooling/AttributeExtensibleXMLObject.h>\r
-\r
-using namespace xercesc;\r
-\r
-#if defined (_MSC_VER)\r
-    #pragma warning( push )\r
-    #pragma warning( disable : 4250 4251 )\r
-#endif\r
-\r
-namespace xmltooling {\r
-\r
-    /**\r
-     * An abstract implementation of a DOM-caching AttributeExtensibleXMLObject.\r
-     */\r
-    class XMLTOOL_API AbstractAttributeExtensibleXMLObject : public virtual AbstractDOMCachingXMLObject\r
-    {\r
-    public:\r
-        virtual ~AbstractAttributeExtensibleXMLObject();\r
-        \r
-        /**\r
-         * @see AttributeExtensibleXMLObject::getAttribute()\r
-         */\r
-        virtual const XMLCh* getAttribute(QName& qualifiedName) const {\r
-            std::map<QName,XMLCh*>::const_iterator i=m_attributeMap.find(qualifiedName);\r
-            return (i==m_attributeMap.end()) ? NULL : i->second;\r
-        }\r
-        \r
-        /**\r
-         * @see AttributeExtensibleXMLObject::setAttribute()\r
-         */\r
-        virtual void setAttribute(QName& qualifiedName, const XMLCh* value);\r
-    \r
-     protected:\r
-        /**\r
-         * Constructor\r
-         * \r
-         * @param namespaceURI the namespace the element is in\r
-         * @param elementLocalName the local name of the XML element this Object represents\r
-         * @param namespacePrefix the namespace prefix to use\r
-         */\r
-        AbstractAttributeExtensibleXMLObject(\r
-            const XMLCh* namespaceURI=NULL, const XMLCh* elementLocalName=NULL, const XMLCh* namespacePrefix=NULL\r
-            ) : AbstractDOMCachingXMLObject(namespaceURI,elementLocalName, namespacePrefix) {}\r
-\r
-    private:\r
-        std::map<QName,XMLCh*> m_attributeMap;\r
-    };\r
-    \r
-};\r
-\r
-#if defined (_MSC_VER)\r
-    #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_absattrextxmlobj_h__ */\r
+/*
+ *  Copyright 2001-2007 Internet2
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file AbstractAttributeExtensibleXMLObject.h
+ * 
+ * AbstractXMLObject mixin that implements AttributeExtensibleXMLObject
+ */
+
+#ifndef __xmltooling_absattrextxmlobj_h__
+#define __xmltooling_absattrextxmlobj_h__
+
+#include <map>
+#include <xmltooling/AbstractXMLObject.h>
+#include <xmltooling/AttributeExtensibleXMLObject.h>
+
+#if defined (_MSC_VER)
+    #pragma warning( push )
+    #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+    /**
+     * AbstractXMLObject mixin that implements AttributeExtensibleXMLObject.
+     * Inherit from this class to add support for attribute wildcarding.
+     */
+    class XMLTOOL_API AbstractAttributeExtensibleXMLObject
+        : public virtual AttributeExtensibleXMLObject, public virtual AbstractXMLObject
+    {
+    public:
+        virtual ~AbstractAttributeExtensibleXMLObject();
+        
+        const XMLCh* getAttribute(const QName& qualifiedName) const {
+            std::map<QName,XMLCh*>::const_iterator i=m_attributeMap.find(qualifiedName);
+            return (i==m_attributeMap.end()) ? NULL : i->second;
+        }
+        
+        void setAttribute(const QName& qualifiedName, const XMLCh* value, bool ID=false);
+    
+        const std::map<QName,XMLCh*>& getExtensionAttributes() const {
+            return m_attributeMap;
+        }
+        
+        const XMLCh* getXMLID() const {
+            return (m_idAttribute == m_attributeMap.end()) ? NULL : m_idAttribute->second;
+        }
+    
+     protected:
+        AbstractAttributeExtensibleXMLObject() {
+            m_idAttribute = m_attributeMap.end();
+        }
+
+        /** Copy constructor. */
+        AbstractAttributeExtensibleXMLObject(const AbstractAttributeExtensibleXMLObject& src);
+
+        /**
+         * Assists in the unmarshalling of extension attributes.
+         * 
+         * @param attribute the DOM attribute node being unmarshalled
+         */
+        void unmarshallExtensionAttribute(const DOMAttr* attribute);
+
+        /**
+         * Assists in the marshalling of extension attributes.
+         * 
+         * @param domElement    the DOM element against which to marshall the attributes
+         */
+        void marshallExtensionAttributes(DOMElement* domElement) const;
+    
+    private:
+        /** Map of arbitrary attributes. */
+        std::map<QName,XMLCh*> m_attributeMap;
+        
+        /** Points to the last attribute designated as an XML ID. */
+        std::map<QName,XMLCh*>::const_iterator m_idAttribute;
+    };
+    
+};
+
+#if defined (_MSC_VER)
+    #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_absattrextxmlobj_h__ */