xmltooling/io/AbstractXMLObjectMarshaller.h

   1 /*\r
   2 *  Copyright 2001-2006 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 AbstractXMLObjectMarshaller.h\r
  19  * \r
  20  * A thread-safe abstract marshaller.\r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_xmlmarshaller_h__)\r
  24 #define __xmltooling_xmlmarshaller_h__\r
  25 \r
  26 #include <xmltooling/io/Marshaller.h>\r
  27 \r
  28 namespace xmltooling {\r
  29 \r
  30     /**\r
  31      * A thread-safe abstract marshaller.\r
  32      */\r
  33     class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual Marshaller\r
  34     {\r
  35     public:\r
  36         virtual ~AbstractXMLObjectMarshaller() {}\r
  37 \r
  38         /**\r
  39          * @see Marshaller::marshall()\r
  40          */\r
  41         DOMElement* marshall(XMLObject* xmlObject, DOMDocument* document=NULL) const;\r
  42     \r
  43         \r
  44     protected:\r
  45         /**\r
  46          * Constructor.\r
  47          * \r
  48          * @param targetNamespaceURI the namespace URI of either the schema type QName or element QName of the elements this\r
  49          *            marshaller operates on\r
  50          * @param targetLocalName the local name of either the schema type QName or element QName of the elements this\r
  51          *            marshaller operates on\r
  52          */\r
  53         AbstractXMLObjectMarshaller(const XMLCh* targetNamespaceURI, const XMLCh* targetLocalName);\r
  54 \r
  55         /**\r
  56          * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.\r
  57          * \r
  58          * @param xmlObject the XMLObject\r
  59          * @param domElement the DOM element\r
  60          * \r
  61          * @throws MarshallingException thrown if the type on the XMLObject is doesn't contain\r
  62          * a local name, prefix, and namespace URI\r
  63          */\r
  64         void marshallElementType(XMLObject* xmlObject, DOMElement* domElement) const;\r
  65 \r
  66         /**\r
  67          * Creates the xmlns attributes for any namespaces set on the given XMLObject.\r
  68          * \r
  69          * @param xmlObject the XMLObject\r
  70          * @param domElement the DOM element the namespaces will be added to\r
  71          */\r
  72         void marshallNamespaces(const XMLObject* xmlObject, DOMElement* domElement) const;\r
  73     \r
  74         /**\r
  75          * Marshalls the child elements of the given XMLObject.\r
  76          * \r
  77          * @param xmlObject the XMLObject whose children will be marshalled\r
  78          * @param domElement the DOM element that will recieved the marshalled children\r
  79          * \r
  80          * @throws MarshallingException thrown if there is a problem marshalling a child element\r
  81          */\r
  82         void marshallChildElements(const XMLObject* xmlObject, DOMElement* domElement) const;\r
  83 \r
  84         /**\r
  85          * Marshalls the attributes from the given XMLObject into the given DOM element.\r
  86          * The XMLObject passed to this method is guaranteed to be of the target name\r
  87          * specified during this marshaller's construction.\r
  88          * \r
  89          * @param xmlObject the XMLObject being marshalled\r
  90          * @param domElement the DOM Element into which attributes will be marshalled\r
  91          * \r
  92          * @throws UnmarshallingException thrown if there is a problem unmarshalling an attribute\r
  93          */\r
  94         virtual void marshallAttributes(const XMLObject* xmlObject, DOMElement* domElement) const=0;\r
  95 \r
  96         /**\r
  97          * Marshalls data from the XMLObject into content of the DOM Element.\r
  98          * \r
  99          * @param xmlObject the XMLObject\r
 100          * @param domElement the DOM element recieving the content\r
 101          */\r
 102         virtual void marshallElementContent(const XMLObject* xmlObject, DOMElement* domElement) const=0;\r
 103 \r
 104         void* m_log;\r
 105     private:\r
 106         QName m_targetQName;\r
 107     };\r
 108     \r
 109 };\r
 110 \r
 111 #endif /* __xmltooling_xmlmarshaller_h__ */\r