include/anna/xml/Decompressor.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_xml_Decompressor_hpp
  38 #define anna_xml_Decompressor_hpp
  39
  40 #include <anna/core/util/ZBlock.hpp>
  41
  42 namespace anna {
  43
  44 class DataBlock;
  45
  46 namespace xml {
  47
  48 class Document;
  49
  50 /**
  51    Obtiene la información original de un documento XML comprimido con una instancia de la clase Compressor.
  52
  53    \see Compressor
  54
  55    \warning Esta es una clase bastante pesada, por lo que casi-imprescindible reusar una misma instancia cada vez
  56    que se requiera comprimir un documento XML.
  57 */
  58 class Decompressor : ZBlock {
  59 public:
  60   /**
  61    * Constructor.
  62    */
  63   Decompressor();
  64
  65   /**
  66    * Destructor.
  67    */
  68   virtual ~Decompressor();
  69
  70   /**
  71    * Recupera el contenido original del documento XML comprimido con la clase Compressor.
  72    * \param dataBlock Bloque de datos obtenido como resultado de invocar a Compressor::apply.
  73    * \return El documento XML comprimido en el bloque de datos.
  74    */
  75   const Document& apply(const DataBlock& dataBlock) throw(RuntimeException);
  76
  77 private:
  78   Document* a_document;
  79
  80   Decompressor(const Decompressor&);
  81 };
  82
  83 }
  84 }
  85
  86 #endif
  87