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/AbstractDOMCachingXMLObject.h>\r
  27 \r
  28 #if defined (_MSC_VER)\r
  29     #pragma warning( push )\r
  30     #pragma warning( disable : 4250 4251 )\r
  31 #endif\r
  32 \r
  33 namespace xmltooling {\r
  34 \r
  35     /**\r
  36      * A thread-safe abstract marshaller.\r
  37      */\r
  38     class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual AbstractXMLObject\r
  39     {\r
  40     public:\r
  41         virtual ~AbstractXMLObjectMarshaller() {}\r
  42 \r
  43         DOMElement* marshall(DOMDocument* document=NULL, MarshallingContext* ctx=NULL) const;\r
  44 \r
  45         DOMElement* marshall(DOMElement* parentElement, MarshallingContext* ctx=NULL) const;\r
  46         \r
  47     protected:\r
  48         AbstractXMLObjectMarshaller() {}\r
  49 \r
  50         /**\r
  51          * Sets the given element as the Document Element of the given Document.\r
  52          * If the document already has a Document Element it is replaced by the given element.\r
  53          * \r
  54          * @param document the document\r
  55          * @param element the Element that will serve as the Document Element\r
  56          */\r
  57         void setDocumentElement(DOMDocument* document, DOMElement* element) const {\r
  58             DOMElement* documentRoot = document->getDocumentElement();\r
  59             if (documentRoot)\r
  60                 document->replaceChild(documentRoot, element);\r
  61             else\r
  62                 document->appendChild(element);\r
  63         }\r
  64     \r
  65         /**\r
  66          * Marshalls the XMLObject into the given DOM Element.\r
  67          * The DOM Element must be within a DOM tree rooted in the owning Document.\r
  68          * \r
  69          * @param targetElement the Element into which the XMLObject is marshalled into\r
  70          * @param ctx           optional marshalling context\r
  71          * \r
  72          * @throws MarshallingException thrown if there is a problem marshalling the object\r
  73          * @throws SignatureException thrown if a problem occurs during signature creation \r
  74          */\r
  75         void marshallInto(DOMElement* targetElement, MarshallingContext* ctx) const;\r
  76     \r
  77         /**\r
  78          * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.\r
  79          * \r
  80          * @param domElement the DOM element\r
  81          * \r
  82          * @throws MarshallingException thrown if the type on the XMLObject is doesn't contain\r
  83          * a local name, prefix, and namespace URI\r
  84          */\r
  85         void marshallElementType(DOMElement* domElement) const;\r
  86 \r
  87         /**\r
  88          * Creates the xmlns attributes for any namespaces set on the XMLObject.\r
  89          * \r
  90          * @param domElement the DOM element the namespaces will be added to\r
  91          */\r
  92         void marshallNamespaces(DOMElement* domElement) const;\r
  93     \r
  94         /**\r
  95          * Marshalls the child elements of the XMLObject.\r
  96          * \r
  97          * @param domElement the DOM element that will recieved the marshalled children\r
  98          * \r
  99          * @throws MarshallingException thrown if there is a problem marshalling a child element\r
 100          */\r
 101         void marshallChildElements(DOMElement* domElement) const;\r
 102 \r
 103         /**\r
 104          * Marshalls the attributes from the XMLObject into the given DOM element.\r
 105          * \r
 106          * @param domElement the DOM Element into which attributes will be marshalled\r
 107          * \r
 108          * @throws MarshallingException thrown if there is a problem marshalling an attribute\r
 109          */\r
 110         virtual void marshallAttributes(DOMElement* domElement) const {}\r
 111 \r
 112         /**\r
 113          * Marshalls data from the XMLObject into content of the DOM Element.\r
 114          * \r
 115          * @param domElement the DOM element recieving the content\r
 116          */\r
 117         virtual void marshallElementContent(DOMElement* domElement) const {}\r
 118     };\r
 119     \r
 120 };\r
 121 \r
 122 #if defined (_MSC_VER)\r
 123     #pragma warning( pop )\r
 124 #endif\r
 125 \r
 126 #endif /* __xmltooling_xmlmarshaller_h__ */\r