1 /* 2 * Copyright (c) 2011-2014, Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, this 9 * list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation and/or 13 * other materials provided with the distribution. 14 * 15 * 3. Neither the name of the copyright holder nor the names of its contributors 16 * may be used to endorse or promote products derived from this software without 17 * specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #pragma once 32 #include "XmlDocSource.h" 33 #include "XmlSerializingContext.h" 34 35 #include "NonCopyable.hpp" 36 37 /** 38 * The CXmlDocSink class defines how to use a CXmlDocSource. 39 * The interaction between the xml source and xml sink is defined 40 * in the process method of CXmlDocSink. One can subclass CXmlDocSink 41 * for different purpose by implementing the doProcess method and then 42 * use it with any existing implementation of CXmlDocSource. 43 */ 44 class CXmlDocSink : private utility::NonCopyable 45 { 46 public: 47 /** 48 * Method to be called to use an xmlDocSource. 49 * Any subclass of XmlDocSink must implement the doProcess 50 * method that will define how to use the xmlDocSource. 51 * 52 * @param[in] xmlDocSource a CXmlDocSource reference 53 * @param[in] serializingContext a CXmlSerializing Context reference 54 * 55 * @return true is there was no error during the processing of xmlDocSource 56 */ process(CXmlDocSource & xmlDocSource,CXmlSerializingContext & serializingContext)57 bool process(CXmlDocSource &xmlDocSource, CXmlSerializingContext &serializingContext) 58 { 59 if (!xmlDocSource.populate(serializingContext)) { 60 return false; 61 } 62 63 return doProcess(xmlDocSource, serializingContext); 64 } 65 ~CXmlDocSink()66 virtual ~CXmlDocSink() {} 67 68 private: 69 /** 70 * Handle for subclasses to process the source. 71 * This method will define what to do with the xmlDocSource. 72 * 73 * @param[in] xmlDocSource a CXmlDocSource reference 74 * @param[in] serializingContext a CXmlSerializing Context reference 75 * 76 * @return true is there was no error during the processing of xmlDocSource 77 */ 78 virtual bool doProcess(CXmlDocSource &xmlDocSource, 79 CXmlSerializingContext &serializingContext) = 0; 80 }; 81