Home | History | Annotate | Download | only in xmlserializer 
      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 /**
     36   * The CXmlDocSink class defines how to use a CXmlDocSource.
     37   * The interaction between the xml source and xml sink is defined
     38   * in the process method of CXmlDocSink. One can subclass CXmlDocSink
     39   * for different purpose by implementing the doProcess method and then
     40   * use it with any existing implementation of CXmlDocSource.
     41   */
     42 class CXmlDocSink
     43 {
     44 public:
     45     /**
     46       * Method to be called to use an xmlDocSource.
     47       * Any subclass of XmlDocSink must implement the doProcess
     48       * method that will define how to use the xmlDocSource.
     49       *
     50       * @param[in] xmlDocSource a CXmlDocSource reference
     51       * @param[in] serializingContext a CXmlSerializing Context reference
     52       *
     53       * @return true is there was no error during the processing of xmlDocSource
     54       */
     55     bool process(CXmlDocSource& xmlDocSource, CXmlSerializingContext& serializingContext)
     56     {
     57         if (!xmlDocSource.populate(serializingContext)) {
     58             return false;
     59         }
     60 
     61         return doProcess(xmlDocSource, serializingContext);
     62     }
     63 
     64     virtual ~CXmlDocSink() {}
     65 
     66 private:
     67     /**
     68       * Handle for subclasses to process the source.
     69       * This method will define what to do with the xmlDocSource.
     70       *
     71       * @param[in] xmlDocSource a CXmlDocSource reference
     72       * @param[in] serializingContext a CXmlSerializing Context reference
     73       *
     74       * @return true is there was no error during the processing of xmlDocSource
     75       */
     76     virtual bool doProcess(CXmlDocSource& xmlDocSource, CXmlSerializingContext& serializingContext) = 0;
     77 };
     78