xmltooling/XMLObjectBuilder.h

   1 /*\r
   2  *  Copyright 2001-2009 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file xmltooling/XMLObjectBuilder.h\r
  19  * \r
  20  * Factory interface for XMLObjects.\r
  21  */\r
  22 \r
  23 #ifndef __xmltooling_xmlobjbuilder_h__\r
  24 #define __xmltooling_xmlobjbuilder_h__\r
  25 \r
  26 #include <xmltooling/QName.h>\r
  27 #include <xmltooling/XMLObject.h>\r
  28 #include <xmltooling/util/XMLHelper.h>\r
  29 \r
  30 #include <map>\r
  31 #include <memory>\r
  32 \r
  33 #if defined (_MSC_VER)\r
  34     #pragma warning( push )\r
  35     #pragma warning( disable : 4250 4251 )\r
  36 #endif\r
  37 \r
  38 namespace xmltooling {\r
  39 \r
  40     /**\r
  41      * A factory interface for obtaining XMLObjects.\r
  42      * Subclasses MAY supply additional factory methods.\r
  43      */\r
  44     class XMLTOOL_API XMLObjectBuilder\r
  45     {\r
  46     MAKE_NONCOPYABLE(XMLObjectBuilder);\r
  47     public:\r
  48         virtual ~XMLObjectBuilder() {}\r
  49         \r
  50         /**\r
  51          * Creates an empty XMLObject with a particular element name.\r
  52          * <p>The results are undefined if localName is NULL or empty.\r
  53          * \r
  54          * @param nsURI         namespace URI for element\r
  55          * @param localName     local name of element\r
  56          * @param prefix        prefix of element name\r
  57          * @param schemaType    xsi:type of the object\r
  58          * @return the empty XMLObject\r
  59          */\r
  60         virtual XMLObject* buildObject(\r
  61             const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL\r
  62             ) const=0;\r
  63 \r
  64         /**\r
  65          * Creates an empty XMLObject with a particular element name.\r
  66          * \r
  67          * @param q     QName of element for object\r
  68          * @return the empty XMLObject\r
  69          */\r
  70         XMLObject* buildFromQName(const QName& q) const {\r
  71             return buildObject(q.getNamespaceURI(),q.getLocalPart(),q.getPrefix());\r
  72         }\r
  73 \r
  74         /**\r
  75          * Creates an unmarshalled XMLObject from a DOM Element.\r
  76          * \r
  77          * @param element       the unmarshalling source\r
  78          * @param bindDocument  true iff the XMLObject should take ownership of the DOM Document\r
  79          * @return the unmarshalled XMLObject\r
  80          */\r
  81         XMLObject* buildFromElement(xercesc::DOMElement* element, bool bindDocument=false) const {\r
  82             std::auto_ptr<XMLObject> ret(\r
  83                 buildObject(element->getNamespaceURI(),element->getLocalName(),element->getPrefix(),XMLHelper::getXSIType(element))\r
  84                 );\r
  85             ret->unmarshall(element,bindDocument);\r
  86             return ret.release();\r
  87         }\r
  88 \r
  89         /**\r
  90          * Creates an unmarshalled XMLObject from the root of a DOM Document.\r
  91          * \r
  92          * @param doc           the unmarshalling source\r
  93          * @param bindDocument  true iff the XMLObject should take ownership of the DOM Document\r
  94          * @return the unmarshalled XMLObject\r
  95          */\r
  96         XMLObject* buildFromDocument(xercesc::DOMDocument* doc, bool bindDocument=true) const {\r
  97             return buildFromElement(doc->getDocumentElement(),bindDocument);\r
  98         }\r
  99 \r
 100         /**\r
 101          * Creates an unmarshalled XMLObject using the default build method, if a builder can be found.\r
 102          * \r
 103          * @param element       the unmarshalling source\r
 104          * @param bindDocument  true iff the new XMLObject should take ownership of the DOM Document\r
 105          * @return  the unmarshalled object or NULL if no builder is available \r
 106          */\r
 107         static XMLObject* buildOneFromElement(xercesc::DOMElement* element, bool bindDocument=false) {\r
 108             const XMLObjectBuilder* b=getBuilder(element);\r
 109             return b ? b->buildFromElement(element,bindDocument) : NULL;\r
 110         }\r
 111 \r
 112         /**\r
 113          * Retrieves an XMLObjectBuilder using the key it was registered with.\r
 114          * \r
 115          * @param key the key used to register the builder\r
 116          * @return the builder or NULL\r
 117          */\r
 118         static const XMLObjectBuilder* getBuilder(const QName& key) {\r
 119             std::map<QName,XMLObjectBuilder*>::const_iterator i=m_map.find(key);\r
 120             return (i==m_map.end()) ? NULL : i->second;\r
 121         }\r
 122 \r
 123         /**\r
 124          * Retrieves an XMLObjectBuilder for a given DOM element.\r
 125          * If no match is found, the default builder is returned, if any.\r
 126          * \r
 127          * @param element the element for which to locate a builder\r
 128          * @return the builder or NULL\r
 129          */\r
 130         static const XMLObjectBuilder* getBuilder(const xercesc::DOMElement* element);\r
 131 \r
 132         /**\r
 133          * Retrieves the default XMLObjectBuilder for DOM elements\r
 134          * \r
 135          * @return the default builder or NULL\r
 136          */\r
 137         static const XMLObjectBuilder* getDefaultBuilder() {\r
 138             return m_default;\r
 139         }\r
 140 \r
 141         /**\r
 142          * Gets an immutable list of all the builders currently registered.\r
 143          * \r
 144          * @return list of all the builders currently registered\r
 145          */\r
 146         static const std::map<QName,XMLObjectBuilder*>& getBuilders() {\r
 147             return m_map;\r
 148         }\r
 149     \r
 150         /**\r
 151          * Registers a new builder for the given key.\r
 152          * \r
 153          * @param builderKey the key used to retrieve this builder later\r
 154          * @param builder the builder\r
 155          */\r
 156         static void registerBuilder(const QName& builderKey, XMLObjectBuilder* builder) {\r
 157             deregisterBuilder(builderKey);\r
 158             m_map[builderKey]=builder;\r
 159         }\r
 160 \r
 161         /**\r
 162          * Registers a default builder\r
 163          * \r
 164          * @param builder the default builder\r
 165          */\r
 166         static void registerDefaultBuilder(XMLObjectBuilder* builder) {\r
 167             deregisterDefaultBuilder();\r
 168             m_default=builder;\r
 169         }\r
 170 \r
 171         /**\r
 172          * Deregisters a builder.\r
 173          * \r
 174          * @param builderKey the key for the builder to be deregistered\r
 175          */\r
 176         static void deregisterBuilder(const QName& builderKey) {\r
 177             delete getBuilder(builderKey);\r
 178             m_map.erase(builderKey);\r
 179         }\r
 180 \r
 181         /**\r
 182          * Deregisters default builder.\r
 183          */\r
 184         static void deregisterDefaultBuilder() {\r
 185             delete m_default;\r
 186             m_default=NULL;\r
 187         }\r
 188 \r
 189         /**\r
 190          * Unregisters and destroys all registered builders. \r
 191          */\r
 192         static void destroyBuilders();\r
 193 \r
 194     protected:\r
 195         XMLObjectBuilder() {}\r
 196     \r
 197     private:\r
 198         static std::map<QName,XMLObjectBuilder*> m_map;\r
 199         static XMLObjectBuilder* m_default;\r
 200     };\r
 201 \r
 202 };\r
 203 \r
 204 #if defined (_MSC_VER)\r
 205     #pragma warning( pop )\r
 206 #endif\r
 207 \r
 208 #endif /* __xmltooling_xmlobjbuilder_h__ */\r