include/anna/dbos/Eraser.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_dbos_Eraser_hpp
  38 #define anna_dbos_Eraser_hpp
  39
  40 #include <anna/dbos/Accesor.hpp>
  41
  42 namespace anna {
  43
  44 namespace dbos {
  45
  46 class Object;
  47
  48 /**
  49    Interfaz que deben cumplir los objetos encargados de borrar el objeto del medio fisico,
  50    que normalmente sera alguna base de datos.
  51 */
  52 class Eraser : public Accesor {
  53 public:
  54   /**
  55      Devuelve la instancia establecida por #setObject.
  56      \return La instancia establecida por #setObject. Puede ser NULL.
  57   */
  58   Object* getObject() throw() { return a_object; }
  59
  60   /**
  61      Establece la instancia del objeto sobre el que vamos a actuar.
  62      \param object Instancia del objeto sobre el que vamos a actuar.
  63   */
  64   void setObject(Object* object) throw() { a_object = object; }
  65
  66   /**
  67      Metodo de debemos re-escribir para devolver el nombre completo del selector de recursos.
  68      Para evitar ambigüedades este nombre deberia incluir la lista completa de \em namespaces
  69      a la que pertenece la clase.
  70      \return Una cadena con el nombre de este selector.
  71   */
  72   virtual const char* getClassName() const throw() { return "anna::dbos::Eraser"; }
  73
  74 protected:
  75   /**
  76      Constructor.
  77      \param database Base de datos asociada a este cargador y que deberia servir para
  78      obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
  79      \param id Identificador de este accesor.
  80   */
  81   Eraser(dbms::Database& database, const Id id = 0) :
  82     Accesor(database, id),
  83     a_object(NULL)
  84   {;}
  85
  86 private:
  87   Object* a_object;
  88
  89   Index getIndex() const throw() { return 0; }   // No se usa
  90 };
  91
  92 }
  93 }
  94
  95 #endif
  96
  97
  98