-/*\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 <xmltooling/QName.h>\r
-#include <xmltooling/validation/Validator.h>\r
-\r
-#include <map>\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. 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
- m_map.insert(std::make_pair(key,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::multimap<QName,Validator*> m_map;\r
- };\r
-\r
- /**\r
- * Validator suite for schema-style structural validation.\r
- * \r
- * This is <strong>NOT</strong> a comprehensive replacement for real\r
- * schema validation, but it does basic structural checking of overall\r
- * element relationships and some basic attribute presence checking.\r
- */\r
- extern XMLTOOL_API xmltooling::ValidatorSuite SchemaValidators;\r
- \r
-};\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_valsuite_h__ */\r
+/*
+ * Copyright 2001-2006 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 ValidatorSuite.h
+ *
+ * Groups of rule checkers of XMLObjects based on type or element name.
+ */
+
+#ifndef __xmltooling_valsuite_h__
+#define __xmltooling_valsuite_h__
+
+#include <xmltooling/QName.h>
+#include <xmltooling/validation/Validator.h>
+
+#include <map>
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+ /**
+ * A collection of validators that can be applied to an XMLObject and its children. These collections can represent
+ * usage specific checks, such as those outlined in schemas or profiles of specific XML specifications.
+ *
+ * Registered Validators must be stateless. Validators are fetched based on schema type and
+ * element name, in that order.
+ */
+ class XMLTOOL_API ValidatorSuite
+ {
+ MAKE_NONCOPYABLE(ValidatorSuite);
+ public:
+ /**
+ * Creates a new suite.
+ *
+ * @param id an identifier for the suite
+ */
+ ValidatorSuite(const char* id) : m_id(id) {}
+
+ ~ValidatorSuite() {
+ destroyValidators();
+ }
+
+ /**
+ * Gets a unique ID for this suite.
+ *
+ * @return a unique ID for this suite
+ */
+ const char* getId() {
+ return m_id.c_str();
+ }
+
+ /**
+ * Evaluates the registered validators against the given XMLObject and it's children.
+ *
+ * @param xmlObject the XMLObject tree to validate
+ *
+ * @throws ValidationException thrown if the element tree is not valid
+ */
+ void validate(const XMLObject* xmlObject) const;
+
+ /**
+ * Registers a new validator for the given key.
+ *
+ * @param key the key used to retrieve the validator
+ * @param validator the validator
+ */
+ void registerValidator(const QName& key, Validator* validator) {
+ m_map.insert(std::make_pair(key,validator));
+ }
+
+ /**
+ * Deregisters validators.
+ *
+ * @param key the key for the validators to be deregistered
+ */
+ void deregisterValidators(const QName& key);
+
+ /**
+ * Unregisters and destroys all registered validators.
+ */
+ void destroyValidators();
+
+ private:
+ std::string m_id;
+ std::multimap<QName,Validator*> m_map;
+ };
+
+ /**
+ * Validator suite for schema-style structural validation.
+ *
+ * This is <strong>NOT</strong> a comprehensive replacement for real
+ * schema validation, but it does basic structural checking of overall
+ * element relationships and some basic attribute presence checking.
+ */
+ extern XMLTOOL_API xmltooling::ValidatorSuite SchemaValidators;
+
+};
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_valsuite_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff