anna::dbos::ObjectFacade< T > Class Template Reference

#include <ObjectFacade.hpp>

Collaboration diagram for anna::dbos::ObjectFacade< T >:

Static Public Member Functions
static StorageId	getStorageAreaId ()
static StorageArea *	getStorageArea ()
static void	setStorageArea (StorageArea *storageArea)
static T *	instance (dbms::Connection &connection, Loader &loader) noexcept(false)
static T *	instance (Loader &loader) noexcept(false)
static T *	instance (dbms::Connection &connection, CrossedLoader &crossedLoader, Loader &loader) noexcept(false)
static T *	create (dbms::Connection &connection, Creator &creator) noexcept(false)
static T *	find (Loader &loader) noexcept(false)
static void	release (T *&t)
static void	clear () noexcept(false)
static T *	duplicate (const T *t) noexcept(false)
static bool	isLoaded (const Loader &loader) noexcept(false)
static void	apply (dbms::Connection &connection, Recorder &recorder) noexcept(false)
static void	apply (dbms::Connection &connection, Eraser &eraser) noexcept(false)
static void	erase (T *&t) noexcept(false)
static T *	data (StorageArea::iterator &ii)
static const T *	data (StorageArea::const_iterator &ii)
static Object *	allocator ()

Protected Member Functions
	ObjectFacade ()

Static Protected Attributes
static StorageArea *	st_storageArea

Detailed Description

template<typename T>
class anna::dbos::ObjectFacade< T >

Clase que facilita el acceso y uso de las clases encargadas de la instanciacion de objetos a partir de los datos contenidos en un medio fisico, que normalmente seria la tabla de una base de datos.

Parameters

T	clase debe ser heredada de anna::dbos::Object.

Ejemplo de definicion de una clase usando esta interfaz:

Ejemplo de implementacion de la clase correspondiente a la definicion:

See also

dbos_declare_object

dbos_prepare_object

Constructor & Destructor Documentation

ObjectFacade()

template<typename T>

anna::dbos::ObjectFacade< T >::ObjectFacade ( )

inlineprotected

Constructor.

{}

Member Function Documentation

allocator()

template<typename T>

static Object* anna::dbos::ObjectFacade< T >::allocator ( )

inlinestatic

Metodo creador de nuevas instancias de la clase T.

Returns

Una nueva instancia del tipo de objeto T.

Warning

Solo deberia ser llamado desde anna::comm::StorageArea cuando sea preciso crear nuevas instancias de objetos.

{ return new T; }

apply() [1/2]

template<typename T>

static void anna::dbos::ObjectFacade< T >::apply ( dbms::Connection &  connection, Recorder &  recorder  )

inlinestaticnoexcept

Transfiere la informacion del objeto recibido como parametro al medio fisico usando el Recorder recibido como parametro.

Parameters

connection	Conexion usada si fuera necesario extraer los datos del medio fisico.
recorder	Grabador usado para transferir los datos al medio fisico.

                  {
    if(st_storageArea == NULL) {
      std::string msg(recorder.asString());
      msg += " | ObjectFacade uninitialized";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    st_storageArea->apply(connection, recorder);
  }

apply() [2/2]

template<typename T>

static void anna::dbos::ObjectFacade< T >::apply ( dbms::Connection &  connection, Eraser &  eraser  )

inlinestaticnoexcept

Elimina la informacion del objeto recibido como parametro del medio fisico usando el Eraser recibido como parametro.

Parameters

connection	Conexion usada si fuera necesario extraer los datos del medio fisico.
eraser	Objecto usado para eliminar los datos al medio fisico.

Warning

Si la cuanta de utilizacion de T es 1 se liberaria en otro caso se devolveria una excepcion.

                  {
    if(st_storageArea == NULL) {
      std::string msg(eraser.asString());
      msg += " | ObjectFacade uninitialized";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    st_storageArea->apply(connection, eraser);
  }

clear()

template<typename T>

static void anna::dbos::ObjectFacade< T >::clear ( )

inlinestaticnoexcept

Descarga todos los objetos contenidos en el area de almacenamiento.

                  {
    if(st_storageArea == NULL)
      throw RuntimeException("ObjectFacade uninitialized ", ANNA_FILE_LOCATION);

    st_storageArea->clear();
  }

create()

template<typename T>

static T* anna::dbos::ObjectFacade< T >::create ( dbms::Connection &  connection, Creator &  creator  )

inlinestaticnoexcept

Crea un objeto en el area de almacenamiento un y lo prepara para ser transferido al medio fisico si fuera necesario.

Este cargador deberia tener todos los datos necesarios para localizar la informacion del objeto que debe cargar. Por ejemplo, en caso de tener que obtener el objeto a partir de los datos contenidos en una tabla de una base de datos deberia conocer la clave primaria del objeto a cargar, o alguna otra combinacion de columnas que lo identifiquen univocamente.

Parameters

connection	Conexion usada si fuera necesario acceder al medio fisico.
creator	Creador encargado de generar el objeto de forma que sea facil de localizar posteriormente en el area de almacenamiento.

Returns

La nueva instancia que cumple el patron establecido por el creador.

Warning

Cada llamada a este metodo deberia tener su correspondiente liberacion invocando a release cuando dejemos de usar la instancia.

                  {
    if(st_storageArea == NULL) {
      std::string msg(creator.asString());
      msg += " | ObjectFacade uninitialized ";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    return static_cast <T*>(st_storageArea->create(connection, creator));
  }

data() [1/2]

template<typename T>

static T* anna::dbos::ObjectFacade< T >::data ( StorageArea::iterator &  ii )

inlinestatic

Devuelve el puntero sobre el que estaria posicionado el iterador recibido como parametro.

Returns

El puntero sobre el que estaria posicionado el iterador recibido como parametro.

{ return static_cast <T*>(StorageArea::data(ii)); }

data() [2/2]

template<typename T>

static const T* anna::dbos::ObjectFacade< T >::data ( StorageArea::const_iterator &  ii )

inlinestatic

Devuelve el puntero sobre el que estaria posicionado el iterador recibido como parametro.

Returns

El puntero sobre el que estaria posicionado el iterador recibido como parametro.

{ return static_cast <const T*>(StorageArea::data(ii)); }

duplicate()

template<typename T>

static T* anna::dbos::ObjectFacade< T >::duplicate ( const T *  t )

inlinestaticnoexcept

Devuelve de una copia del objeto recibido como parametro e incrementa la cuenta de utilizacion asociada a la instancia.

Parameters

t	Instancia del tipo T obtenida mediate el metodo instance.

Returns

Una copia del objeto recibido como parametro. Si el parametro recibido es NULL devolveria NULL.

Warning

Cada llamada a este metodo deberia tener su correspondiente liberacion invocando a release cuando dejemos de usar la instancia.

                  {
    if(st_storageArea == NULL)
      throw RuntimeException("ObjectFacade uninitialized ", ANNA_FILE_LOCATION);

    return static_cast <T*>(st_storageArea->duplicate(t));
  }

erase()

template<typename T>

static void anna::dbos::ObjectFacade< T >::erase ( T *&  t )

inlinestaticnoexcept

Elimina toda la informacion referente al objeto recibido como parametro, siempre y cuando solo tenga un unica referencia activa. Descarga el objeto de la memoria de almacenamiento,

Parameters

t	Instancia del tipo T que vamos a descargar de la memoria de almacenamiento.

Warning

• Si el objeto recibido como parametro no fue reservado mediate instance no tiene ningun efecto.
• La instancia a liberar solo puede tener 1 en su cuenta de utilizacion.
• La memoria asignada a la instancia recibida es liberada, por lo que podemos evitar la invocacion al metodo release para esta instancia.

                  {
    if(st_storageArea == NULL)
      return;

    st_storageArea->erase(reinterpret_cast <Object**>(&t));
  }

find()

template<typename T>

static T* anna::dbos::ObjectFacade< T >::find ( Loader &  loader )

inlinestaticnoexcept

Devuelve la informacion de un objeto cargado desde el medio fisico.

Este cargador deberia tener todos los datos necesarios para localizar la informacion del objeto que debe buscar. Por ejemplo, en caso de tener que obtener el objeto a partir de los datos contenidos en una tabla de una base de datos deberia conocer la clave primaria del objeto a cargar, o alguna otra combinacion de columnas que lo identifiquen univocamente.

Parameters

loader

Cargador de clase encargado de localizar la informacion referente al objeto buscado.

Returns

Una instancia que cumple el patron establecido por el cargador. Puede ser NULL si el objeto no fue cargado en el area de almacenamiento.

Warning

Cada llamada a este metodo deberia tener su correspondiente liberacion invocando a release cuando dejemos de usar la instancia.

                  {
    if(st_storageArea == NULL) {
      std::string msg(loader.asString());
      msg += " | ObjectFacade uninitialized ";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    return static_cast <T*>(st_storageArea->find(loader));
  }

getStorageArea()

template<typename T>

static StorageArea* anna::dbos::ObjectFacade< T >::getStorageArea ( )

inlinestatic

Devuelve el area de almacenamiento asociado a esta clase.

Returns

Devuelve el area de almacenamiento asociado a esta clase.

{ return st_storageArea; }

getStorageAreaId()

template<typename T>

static StorageId anna::dbos::ObjectFacade< T >::getStorageAreaId ( )

inlinestatic

Devuelve un numerico que puede ser usado en la definicion del area de almacenamiento.

Returns

Un numerico que puede ser usado en la definicion del area de almacenamiento.

See also

Database::createStorageArea

{ return (StorageId) anna_ptrnumber_cast(&st_storageArea); }

instance() [1/3]

template<typename T>

static T* anna::dbos::ObjectFacade< T >::instance ( dbms::Connection &  connection, Loader &  loader  )

inlinestaticnoexcept

Carga la informacion de un objeto contenida en un medio fisico y la interpreta para adecuarla a una clase C++.

Este cargador deberia tener todos los datos necesarios para localizar la informacion del objeto que debe cargar. Por ejemplo, en caso de tener que obtener el objeto a partir de los datos contenidos en una tabla de una base de datos deberia conocer la clave primaria del objeto a cargar, o alguna otra combinacion de columnas que lo identifiquen univocamente.

Parameters

connection	Conexion usada si fuera necesario extraer los datos del medio fisico.
loader	Cargador de clase encargado de localizar y obtener la informacion referente al objeto que deseamos cargar en memoria.

Returns

Una instancia que cumple el patron establecido por el cargador. Puede ser NULL en caso de que al inicializar el area de almacenamiento asociado a esta clase se halla indicado un errorCode igual a -1 en otro caso si no encuentra el objeto que cumpla el patron devolveria una excepcion.

Warning

Cada llamada a este metodo deberia tener su correspondiente liberacion invocando a release cuando dejemos de usar la instancia.

                  {
    if(st_storageArea == NULL) {
      std::string msg(loader.asString());
      msg += " | ObjectFacade uninitialized ";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    return static_cast <T*>(st_storageArea->instance(connection, loader));
  }

instance() [2/3]

template<typename T>

static T* anna::dbos::ObjectFacade< T >::instance ( Loader &  loader )

inlinestaticnoexcept

Carga la informacion de un objeto contenida en un medio fisico y la interpreta para adecuarla a una clase C++.

Este cargador deberia tener todos los datos necesarios para localizar la informacion del objeto que debe cargar.

Parameters

loader

Cargador de clase encargado de localizar y obtener la informacion referente al objeto que deseamos cargar en memoria.

Returns

Una instancia que cumple el patron establecido por el cargador. Puede ser NULL en caso de que al inicializar el area de almacenamiento asociado a esta clase se halla indicado un errorCode igual a -1 en otro caso si no encuentra el objeto que cumpla el patron devolveria una excepcion.

Warning

Cada llamada a este metodo deberia tener su correspondiente liberacion invocando a release cuando dejemos de usar la instancia.

                  {
    if(st_storageArea == NULL) {
      std::string msg(loader.asString());
      msg += " | ObjectFacade uninitialized ";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    return static_cast <T*>(st_storageArea->instance(loader));
  }

instance() [3/3]

template<typename T>

static T* anna::dbos::ObjectFacade< T >::instance ( dbms::Connection &  connection, CrossedLoader &  crossedLoader, Loader &  loader  )

inlinestaticnoexcept

Carga la informacion de un objeto contenida en un medio fisico y la interpreta para adecuarla a una clase C++.

Este cargador deberia tener todos los datos necesarios para localizar la informacion del objeto que debe cargar. Por ejemplo, en caso de tener que obtener el objeto a partir de los datos contenidos en una tabla de una base de datos deberia conocer la clave primaria del objeto a cargar, o alguna otra combinacion de columnas que lo identifiquen univocamente.

Parameters

connection	Conexion usada si fuera necesario extraer los datos del medio fisico.
crossedLoader	Cargador encargado de encontrar la clave principal a aplicar con el #Loader recibido como parámetro en base a una clave alternativa contenida en el mismo.
loader	Cargador de clase encargado de localizar y obtener la informacion referente al objeto que deseamos cargar en memoria.

Returns

Una instancia que cumple el patron establecido por el cargador. Puede ser NULL en caso de que al inicializar esta clase errorCode se halla indicado un #NoExceptionWhenNotFound en otro caso si no encuentra el objeto que cumpla el patron devolveria una excepcion de ejecucion.

Warning

Cada llamada a este método deberia tener su correspondiente liberacion invocando a release cuando dejemos de usar la instancia.

                  {
    if(st_storageArea == NULL) {
      std::string msg(loader.asString());
      msg += " | ObjectFacade uninitialized ";
      throw RuntimeException(msg, ANNA_FILE_LOCATION);
    }

    return static_cast <T*>(st_storageArea->instance(connection, crossedLoader, loader));
  }

isLoaded()

template<typename T>

static bool anna::dbos::ObjectFacade< T >::isLoaded ( const Loader &  loader )

inlinestaticnoexcept

Permite conocer si un determinado objeto esta alojado en el area de almacenamiento.

Parameters

loader

Cargador de clase encargado de localizar la informacion referente al objeto buscado.

Returns

true Si el objeto identificado por el Loader esta en el area de almacenamiento o false en otro caso.

                  {
    if(st_storageArea == NULL)
      throw RuntimeException("ObjectFacade uninitialized ", ANNA_FILE_LOCATION);

    return st_storageArea->isLoaded(loader);
  }

release()

template<typename T>

static void anna::dbos::ObjectFacade< T >::release ( T *&  t )

inlinestatic

Habilita la reutilizacion del espacio de memoria ocupado por un objeto alojado en el area de almacenamiento.

Este metodo no saca al objeto de la memoria de almacenamiento, sino que marca su espacio de memoria como subceptible de ser reutilizado. De esta forma, si el numero de objetos cargados en memoria se acerca al tamao maximo indicado en la inicializacion, se intentara reusar espacios libres en vez de continuar ampliando la memoria reservada.

Parameters

t	Instancia del tipo T que vamos a liberar.

Warning

Si el objeto recibido como parametro no fue reservado mediate alguno de los metodos de reserva de objetos ofrecidos por esta clase no tendra ningun efecto.

  {
    if(st_storageArea == NULL)
      return;

    try {
      st_storageArea->release(reinterpret_cast <Object**>(&t));
    } catch(RuntimeException& ex) {
      ex.trace();
    }
  }

setStorageArea()

template<typename T>

static void anna::dbos::ObjectFacade< T >::setStorageArea ( StorageArea *  storageArea )

inlinestatic

Establece el area de almacenamiento asociado a esta clase, que deberiaser creado mediante la invocacin al metodo Database::createStorageArea.

Parameters

storageArea

area de almacenamiento asociada esta clase.

Warning

El area de almacenamiento debe establecerse antes de invocar a cualquier otro metodo de esta clase.

                                                       {
    (st_storageArea = storageArea)->setSizeof(sizeof(T));
  }

Member Data Documentation

st_storageArea

template<typename T>

StorageArea* anna::dbos::ObjectFacade< T >::st_storageArea

staticprotected

---

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

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