xmltooling/XMLObjectBuilder.h

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