include/anna/xml/Compressor.hpp

   1 // ANNA - Anna is Not Nothingness 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_Compressor_hpp
  38 #define anna_xml_Compressor_hpp
  39
  40 #include <anna/core/util/ZBlock.hpp>
  41
  42 namespace anna {
  43
  44 namespace xml {
  45
  46 class Document;
  47
  48 /**
  49    Comprime la información del árbol XML descrita por el nodo o el documento XML recibido como parámetro.
  50
  51    \see Decompressor
  52
  53    \warning Esta es una clase bastante pesada, por lo que casi-imprescindible reusar una misma instancia cada vez
  54    que se requiera comprimir un documento XML.
  55 */
  56 class Compressor : ZBlock {
  57 public:
  58   /**
  59    * Constructor
  60    */
  61   Compressor() {;}
  62
  63   /**
  64    * Comprime la información del nodo recibido como parámetro. Para recuperar el original tendremos que
  65    * usar una instancia de Decompressor.
  66    *
  67    * \param node Nodo que contiene el árbol de nodos XML que queremos comprimir.
  68    * \return Un bloque de datos binario que contiene la información representada por el nodo.
  69    * */
  70   const DataBlock& apply(const Document& xmlDoc) throw(RuntimeException);
  71
  72 private:
  73   Compressor(const Compressor&);
  74 };
  75
  76 }
  77 }
  78
  79 #endif