/*

Copyright (c) 2002-2005, Yauheni Akhotnikau
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

*/

/*!
	\file
	\brief Интерфейс объекта, отвечающего за выполнение действий
	над содержимым БД.
*/

#if !defined( _OESS_1__DB__IMPL__DB_CONTENT__DB_CONTENT_HPP_ )
#define _OESS_1__DB__IMPL__DB_CONTENT__DB_CONTENT_HPP_

#include <string>
#include <set>
#include <memory>

#include <cpp_util_2/h/nocopy.hpp>

#include <oess_1/defs/h/types.hpp>
#include <oess_1/defs/h/ent_id.hpp>

#include <oess_1/io/h/stream.hpp>

#include <oess_1/db/h/declspec.hpp>

#include <oess_1/db/storage/h/config.hpp>

namespace oess_1 {

namespace db {

namespace impl {

namespace db_content {

//
// db_content_t
//

/*!
	\brief Интерфейс объекта, отвечающего за выполнение действий
	над содержимым БД.
*/
class	OESS_1__DB__TYPE	db_content_t
	:	private cpp_util_2::nocopy_t
	{
	public :
		virtual ~db_content_t();

		//! Создание новой пустой базы данных.
		/*! В базе нет ни одного раздела. */
		static void
		db_create(
			//! Физическое имя создаваемой БД.
			const std::string & name,
			//! Конфигурация для создаваемой БД.
			const oess_1::db::storage::config_t & config );

		//! Физическое уничтожение указанной базы данных.
		static void
		db_destroy(
			const std::string & name );

		//! Проверка существования указанной базы данных.
		static bool
		db_is_exists(
			const std::string & name );

		/*!
			\brief Открыть указанную БД.
		*/
		virtual void
		open(
			//! Физическое имя открываемой БД.
			const std::string & name,
			//! Конфигурация для открываемой БД.
			const oess_1::db::storage::config_t & config,
			//! true, если БД открывается в режиме read-only.
			bool is_read_only,
			//! true, если поврежденная БД должна быть восстановлена
			//! автоматически. Игнорируется, если БД открывается в
			//! режиме read-only.
			bool is_auto_repair_enabled ) = 0;

		//! Подключить еще одного клиента к БД.
		virtual void
		client_attach(
			const std::string & client_id ) = 0;

		//! Отключить указанного агента от БД.
		/*!
			Если такой клиент к БД не подключен, то это
			ошибкой не считается.

			Если клиент проводил транзакцию, то транзакция автоматически
			откатывается.
		*/
		virtual void
		client_detach(
			const std::string & client_id ) = 0;

		//! Определить количество подключенных клиентов.
		virtual oess_1::uint_t
		client_count() const = 0;

		//! Создание раздела в БД.
		virtual void
		slice_create(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Имя создаваемого раздела.
			const std::string & name ) = 0;

		//! Удаление раздела в БД.
		/*!
			\since v.1.4.0
		*/
		virtual void
		slice_destroy(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Имя удаляемого раздела.
			const std::string & name ) = 0;

		//! Проверка существования раздела в БД.
		/*!
			\since v.1.4.0
			\return true, если раздел существует.
		*/
		virtual bool
		slice_is_exists(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Имя проверяемого раздела.
			const std::string & name ) = 0;

		//! Получение имен всех существующих разделов в БД.
		/*!
			\since v.1.4.0
		*/
		virtual std::set< std::string >
		slice_names(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id ) = 0;

		//! Создать сущность.
		virtual oess_1::ent_id_t
		ent_create(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Раздел, в котором необходимо создать сущность.
			const std::string & slice_name,
			//! Сама сущность.
			oess_1::io::istream_t & ent_value,
			//! Размер сущности.
			oess_1::uint_t ent_size ) = 0;

		//! Удалить сущность.
		virtual void
		ent_destroy(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Идентификатор сущности.
			const oess_1::ent_id_t & ent_id ) = 0;

		//! Удалить все сущности в указанном разделе.
		virtual void
		ent_destroy_all(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Имя раздела.
			const std::string & slice_name ) = 0;

		//! Загрузить сущность.
		virtual void
		ent_load(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Идентификатор сущности.
			const oess_1::ent_id_t & ent_id,
			//! Приемник упакованного значения сущности.
			oess_1::io::ostream_t & ent_value ) = 0;

		//! Изменить значение сущности.
		virtual void
		ent_update(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Идентификатор сущности.
			const oess_1::ent_id_t & ent_id,
			//! Упакованное значение сущности.
			oess_1::io::istream_t & ent_value,
			//! Размер сущности в байтах.
			oess_1::uint_t ent_size ) = 0;

		//! Найти следующую существующую сущность.
		/*! Для поиска первой существующей сущности в разделе
			необходимо указать имя раздела и ent_id,
			эквивалентный NULL.
			Если ent_id не равен NULL, то считается, что
			поиск продолжается и имя раздела игнорируется.
			Если существующих сущностей больше нет, то
			возвращается эквивалентное NULL значение. */
		virtual oess_1::ent_id_t
		ent_find_next(
			//! Клиент, который хочет выполнить эту операцию.
			const std::string & client_id,
			//! Название раздела.
			const std::string & slice_name,
			//! Идентификатор сущности.
			const oess_1::ent_id_t & ent_id ) = 0;

		//! Начать транзакцию.
		/*! \since v.1.1.0 */
		virtual void
		transaction_begin(
			const std::string & client_id ) = 0;

		//! Подтвердить транзакцию.
		/*! \since v.1.1.0 */
		virtual void
		transaction_commit(
			const std::string & client_id ) = 0;

		//! Откатить транзакцию.
		/*! \since v.1.1.0 */
		virtual void
		transaction_rollback(
			const std::string & client_id ) = 0;
};

//
// create_std_db_content
//

/*!
	Создание стандартной реализации интерфейса db_content_t.
	Возвращается указатель на динамически созданный объект,
	который должен быть уничтожен посредством оператора
	delete.
*/
std::auto_ptr< db_content_t >
create_std_db_content();

} /* namespace db_content */

} /* namespace impl */

} /* namespace db */

} /* namespace oess_1 */

#endif
