Added ValidatorSuite around groups of static validators.

[shibboleth/cpp-xmltooling.git] / xmltooling / validation / ValidatorSuite.h

diff --git a/xmltooling/validation/ValidatorSuite.h b/xmltooling/validation/ValidatorSuite.h
new file mode 100644 (file)
index 0000000..6049966
--- /dev/null
+++ b/xmltooling/validation/ValidatorSuite.h
@@ -0,0 +1,115 @@
+/*\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 ValidatorSuite.h\r
+ * \r
+ * Groups of rule checkers of XMLObjects based on type or element name. \r
+ */\r
+\r
+#ifndef __xmltooling_valsuite_h__\r
+#define __xmltooling_valsuite_h__\r
+\r
+#include <map>\r
+#include <vector>\r
+#include <xmltooling/QName.h>\r
+#include <xmltooling/validation/Validator.h>\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
+     * A collection of validators that can be applied to an XMLObject and its children. These collections can represent\r
+     * usage specific checks, such as those outlined in schemas or profiles of specific XML specifications.\r
+     * \r
+     * Registered Validators must be stateless and cloneable. Validators are fetched based on schema type and\r
+     * element name, in that order.\r
+     */\r
+    class XMLTOOL_API ValidatorSuite\r
+    {\r
+    MAKE_NONCOPYABLE(ValidatorSuite);\r
+    public:\r
+        /**\r
+         * Creates a new suite.\r
+         * \r
+         * @param id    an identifier for the suite\r
+         */\r
+        ValidatorSuite(const char* id) : m_id(id) {}\r
+        \r
+        ~ValidatorSuite() {\r
+            destroyValidators();\r
+        }\r
+\r
+        /**\r
+         * Gets a unique ID for this suite.\r
+         * \r
+         * @return a unique ID for this suite\r
+         */\r
+        const char* getId() {\r
+            return m_id.c_str();\r
+        }\r
+\r
+        /**\r
+         * Evaluates the registered validators against the given XMLObject and it's children.\r
+         * \r
+         * @param xmlObject the XMLObject tree to validate\r
+         * \r
+         * @throws ValidationException thrown if the element tree is not valid\r
+         */\r
+        void validate(const XMLObject* xmlObject) const;\r
+\r
+        /**\r
+         * Registers a new validator for the given key.\r
+         * \r
+         * @param key       the key used to retrieve the validator\r
+         * @param validator the validator\r
+         */\r
+        void registerValidator(const QName& key, Validator* validator) {\r
+            std::map< QName, std::vector<Validator*> >::iterator i=m_map.find(key);\r
+            if (i==m_map.end())\r
+                m_map.insert(std::make_pair(key,std::vector<Validator*>(1,validator)));\r
+            else\r
+                i->second.push_back(validator);\r
+        }\r
+\r
+        /**\r
+         * Deregisters validators.\r
+         * \r
+         * @param key       the key for the validators to be deregistered\r
+         */\r
+        void deregisterValidators(const QName& key);\r
+\r
+        /**\r
+         * Unregisters and destroys all registered validators. \r
+         */\r
+        void destroyValidators();\r
+\r
+    private:\r
+        std::string m_id;\r
+        std::map< QName, std::vector<Validator*> > m_map;\r
+    };\r
+\r
+};\r
+\r
+#if defined (_MSC_VER)\r
+    #pragma warning( pop )\r
+#endif\r
+\r
+#endif /* __xmltooling_valsuite_h__ */\r