anna::dbos::Accesor Class Reference

#include <Accesor.hpp>

Inheritance diagram for anna::dbos::Accesor:

Collaboration diagram for anna::dbos::Accesor:

Public Types
typedef short	Id

Public Member Functions
virtual	~Accesor ()
Id	getId () const
dbms::Statement *	getStatement () noexcept(false)
bool	hasDataBase () const
dbms::Database &	getDatabase ()
dbms::Connection &	getConnection () noexcept(false)
virtual std::string	asString () const =0
virtual const char *	getClassName () const =0
Public Member Functions inherited from anna::Mutex
	Mutex (const Mode::_v mode=Mode::Recursive)
virtual	~Mutex ()
virtual void	lock () noexcept(false)
virtual void	unlock ()
bool	trylock () noexcept(false)
	operator const pthread_mutex_t * () const

Protected Member Functions
	Accesor (dbms::Database &database, const Id id)
	Accesor (dbms::Database &database, const Id id, const Exception::Mode::_v emode)
	Accesor (const Id id)
virtual dbms::Statement *	initialize (dbms::Database &database) noexcept(false)=0
Protected Member Functions inherited from anna::Safe
	Safe ()

Friends
class	StorageArea

Detailed Description

Interfaz que deben cumplir los objetos encargados de acceder al objeto del medio fisico, que normalmente sera alguna base de datos.

Member Typedef Documentation

Id

typedef short anna::dbos::Accesor::Id

Permite identificar el tipo de accesor.

Constructor & Destructor Documentation

~Accesor()

virtual anna::dbos::Accesor::~Accesor ( )

virtual

Destructor.

Accesor() [1/3]

anna::dbos::Accesor::Accesor ( dbms::Database &  database, const Id  id  )

inlineprotected

Constructor.

Parameters

database	Base de datos asociada a este cargador y que deberia servir para obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
id	Identificador de este accesor.

                                               :
    a_database(&database),
    a_id(id),
    a_statement(NULL),
    a_connection(NULL),
    a_emodeIsNull(true)
  {;}

Accesor() [2/3]

anna::dbos::Accesor::Accesor ( dbms::Database &  database, const Id  id, const Exception::Mode::_v  emode  )

inlineprotected

Constructor.

Parameters

database	Base de datos asociada a este cargador y que deberia servir para obtener los datos de un objeto. Debe tener la misma disponibilidad que este cargador.
id	Identificador de este accesor.
emode	Modo de actuar en caso de no encontrar el dato buscado.

                                                                            :
    a_database(&database),
    a_id(id),
    a_statement(NULL),
    a_connection(NULL),
    a_emodeIsNull(false),
    a_exceptionMode(emode)
  {;}

Accesor() [3/3]

anna::dbos::Accesor::Accesor ( const Id  id )

inlineprotected

Constructor.

Parameters

id	Identificador de este accesor.

                       :
    a_database(NULL),
    a_id(id),
    a_statement(NULL),
    a_connection(NULL),
    a_emodeIsNull(true)
  {;}

Member Function Documentation

asString()

virtual std::string anna::dbos::Accesor::asString ( ) const

pure virtual

Devuelve la representacion en forma de cadena de la clave primaria establecida.

Returns

La representacion en forma de cadena de la clave primaria establecida.

getClassName()

virtual const char* anna::dbos::Accesor::getClassName ( ) const

pure virtual

Metodo de debemos re-escribir para devolver el nombre completo del selector de recursos. Para evitar ambigüedades este nombre deberia incluir la lista completa de namespaces a la que pertenece la clase.

Returns

Una cadena con el nombre de este selector.

Implemented in anna::dbos::CrossedLoader, anna::dbos::Eraser, anna::dbos::Loader, anna::dbos::Creator, and anna::dbos::Recorder.

getConnection()

dbms::Connection& anna::dbos::Accesor::getConnection ( )

inlinenoexcept

Devuelve la conexion que esta usando actualmente este cargador.

Returns

la conexion que esta usando actualmente este cargador.

                                                  {
    if(a_connection == NULL) {
      std::string msg(asString());
      msg += " | No available database connection";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    return *a_connection;
  }

getDatabase()

dbms::Database& anna::dbos::Accesor::getDatabase ( )

inline

Devuelve la instancia de la base de datos asociada a este cargador.

Returns

La instancia de la base de datos asociada a este cargador.

Warning

Si el accesor fue inicializado sin base de datos lo resultados no están definidos.

{ return *a_database; }

getId()

Id anna::dbos::Accesor::getId ( ) const

inline

Devuelve el identificador de este accesor.

Returns

El identificador de este accesor.

{ return a_id; }

getStatement()

dbms::Statement* anna::dbos::Accesor::getStatement ( )

inlinenoexcept

Devuelve la instancia de la sentencia statement asociada a este cargador.

Returns

La instancia de la sentencia statement asociada a este cargador. Puede ser NULL.

                  {
    return (a_statement == NULL && a_database != NULL) ? (a_statement = initialize(*a_database)) : a_statement;
  }

hasDataBase()

bool anna::dbos::Accesor::hasDataBase ( ) const

inline

Devuelve true si el accesor fue inicializado con base de datos o false en otro caso.

Returns

true si el accesor fue inicializado con base de datos o false en otro caso.

{ return a_database != NULL; }

initialize()

virtual dbms::Statement* anna::dbos::Accesor::initialize ( dbms::Database &  database )

protectedpure virtualnoexcept

Metodo que deben implementar todos los accesores para definir la sentencia SQL que los definira. Se invocara automaticamente desde el nucleo de anna.dbos la primera vez que se use este accesor, de forma que el programador solo debe preocuparse por definir este metodo.

Parameters

database

Instancia de la base de datos indicada en el constructor.

Friends And Related Function Documentation

StorageArea

friend class StorageArea

friend

---

The documentation for this class was generated from the following file:

• /tmp/anna/include/anna/dbos/Accesor.hpp