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