[irc/gameservirc.git] / gameserv-2.0 / libgameservgldl / include / GameServ / DataLayer / DataAccess.h

#ifndef __GS__DATAACCESS_H__\r
#define __GS__DATAACCESS_H__\r
\r
#include <GameServ/DataLayer/IDAOFactory.h>\r
using GameServ::DataLayer::IDAOFactory;\r
\r
#include <boost/shared_ptr.hpp>\r
using boost::shared_ptr;\r
\r
namespace GameServ { namespace DataLayer\r
{\r
	//! Main Access into the DataLayer library of objects\r
	/*!\r
		To make use of the DataLayer in a  generic way use DataAccess to instantiate your\r
		dataLayer factories.  DataAccess requires the use of a Provider string, populated \r
		by parameter, and depending on that provider specified, builds the appropriate factory\r
		to use when creating individual data access objects.  This way not only can the\r
		DataAccessObjects be used in a generic way but the factories themselves can be easily\r
		switched.  If you know exactly what data factory you want to use then there is no need\r
		to request a factory interfacefrom DataAccess\r
\r
		The current providers are:\r
			File: Flat file database system\r
			MySQL\r
	*/\r
	class DataAccess\r
	{\r
	public:\r
		\r
		//! Get's the DAO factory to use for creating factories using a specific factory\r
		/*!\r
			Usually the default GetDataAccessFactory() is used without providing the provider name,\r
			and the provider is picked up from the AppSettings global object.  But sometimes you\r
			just need to have extra control of the data layer.  However, It's not recommended that you mix\r
			data access objects.  Ids and resources in one DataAccessObject of one provider can mean completely\r
			different things in another provider.\r
		*/\r
		static shared_ptr<IDAOFactory> GetDataAccessFactory(const string &Provider);\r
\r
\r
	};\r
\r
}} // GameServ::DataLayer\r
\r
#endif // __GS__DATAACCESS_H__\r
Commit	Line	Data
ce4e8c42	1	#ifndef __GS__DATAACCESS_H__\r
	2	#define __GS__DATAACCESS_H__\r
	3	\r
	4	#include <GameServ/DataLayer/IDAOFactory.h>\r
	5	using GameServ::DataLayer::IDAOFactory;\r
	6	\r
	7	#include <boost/shared_ptr.hpp>\r
	8	using boost::shared_ptr;\r
	9	\r
	10	namespace GameServ { namespace DataLayer\r
	11	{\r
	12	//! Main Access into the DataLayer library of objects\r
	13	/*!\r
	14	To make use of the DataLayer in a generic way use DataAccess to instantiate your\r
	15	dataLayer factories. DataAccess requires the use of a Provider string, populated \r
	16	by parameter, and depending on that provider specified, builds the appropriate factory\r
	17	to use when creating individual data access objects. This way not only can the\r
	18	DataAccessObjects be used in a generic way but the factories themselves can be easily\r
	19	switched. If you know exactly what data factory you want to use then there is no need\r
	20	to request a factory interfacefrom DataAccess\r
	21	\r
	22	The current providers are:\r
	23	File: Flat file database system\r
	24	MySQL\r
	25	*/\r
	26	class DataAccess\r
	27	{\r
	28	public:\r
	29	\r
	30	//! Get's the DAO factory to use for creating factories using a specific factory\r
	31	/*!\r
	32	Usually the default GetDataAccessFactory() is used without providing the provider name,\r
	33	and the provider is picked up from the AppSettings global object. But sometimes you\r
	34	just need to have extra control of the data layer. However, It's not recommended that you mix\r
	35	data access objects. Ids and resources in one DataAccessObject of one provider can mean completely\r
	36	different things in another provider.\r
	37	*/\r
	38	static shared_ptr<IDAOFactory> GetDataAccessFactory(const string &Provider);\r
	39	\r
	40	\r
	41	};\r
	42	\r
	43	}} // GameServ::DataLayer\r
	44	\r
	45	#endif // __GS__DATAACCESS_H__\r