Class mgr db::Field

Материал из ISPWiki
Перейти к: навигация, поиск

Работа с базами данных

Класс mgr_db::Field

Представление поля таблицы БД

#include <mgrdb_struct.h> 

Описание:

class mgr_db::Field


Потомки:


Открытые члены (кратко)

Field ( CustomTable * , const string & , FieldType )

Конструктор, принимает ссылку на объект таблицы БД, которой принадлежит это поле, имя поля и его тип


virtual  ~Field ()

Виртуальный деструтор


TableDesc::Field & info () const

Возвращает представление поля таблицы базы данных


bool IsNull () const

Возвращает true, если в поле содержится Null-значение, false в противном случае


virtual string AsString () const

Возвращает строковое представление данных поля


virtual string OldValue () const

Возвращает предыдущее значение данных поля из кэша. Если в кэше нет информации о предыдущем значении, возвращает пустую строку


virtual void Set ( const string & )

Устанавливает значение поля


virtual void SetNull ()

Устанавливает значение поля в значение Null.


bool Lookup ( const string &value )

Производит поиск в базе данных по переденному значению поля. Если встретится хотя бы одно поле с указанным значением, возвращает true, иначе false.


size_t index () const

Возвращает номер поля в структуре данных кэшированной таблицы


operator string () const

Возвращает строковое представление данных поля


bool operator!= ( const string &val )

Сравнивает строковое представление данных поля и переданное значение. Возвращает true, если строки не равны, false в обратном случае


bool operator== ( const string &val )

Сравнивает строковое представление данных поля и переданное значение. Возвращает true, если строки равны, false в обратном случае


bool empty () const

Возвращает true, если поле содежит пустое значение


bool IsChanged () const

Возвращает true, если значение поля было изменено, но еще не зафиксированно вызовом метода CustomTable::Post()


virtual void SetSaveHistory ()

Сохранять историю изменений Выставляет свойство save_history для поля в описании таблицы. Имеет смысл использовать только в конструкторе таблицы


virtual void SetGlobalSearchIndex ()

Сохранять значение в таблице глобального поиска GLOBAL_INDEX_TABLE Выставляет свойство index_it для поля в описании таблицы. Имеет смысл использовать только в конструкторе таблицы

Защищённые члены (кратко)

QueryPtr Query ( const string & )

Выполняет запрос к базе данных, принимает строку запроса и возвращает объект запроса к БД

Приватные члены (кратко)

Конструкторы

Field ( CustomTable * , const string & , FieldType )

Конструктор, принимает ссылку на объект таблицы БД, которой принадлежит это поле, имя поля и его тип

virtual ~Field ()

Виртуальный деструтор

Методы

TableDesc::Field &info () const

Возвращает представление поля таблицы базы данных

bool IsNull () const

Возвращает true, если в поле содержится Null-значение, false в противном случае

virtual string AsString () const

Возвращает строковое представление данных поля

В базовом варианте возврящает значение поля в том виде, в котором оно было получено из БД

virtual string OldValue () const

Возвращает предыдущее значение данных поля из кэша. Если в кэше нет информации о предыдущем значении, возвращает пустую строку

virtual void Set ( const string & )

Устанавливает значение поля

virtual void SetNull ()

Устанавливает значение поля в значение Null.

bool Lookup ( const string &value )

Производит поиск в базе данных по переденному значению поля. Если встретится хотя бы одно поле с указанным значением, возвращает true, иначе false.

size_t index () const

Возвращает номер поля в структуре данных кэшированной таблицы

operator string () const

Возвращает строковое представление данных поля

bool operator!= ( const string &val )

Данная функция/метод является inline функцией

Сравнивает строковое представление данных поля и переданное значение. Возвращает true, если строки не равны, false в обратном случае

bool operator== ( const string &val )

Данная функция/метод является inline функцией

Сравнивает строковое представление данных поля и переданное значение. Возвращает true, если строки равны, false в обратном случае

bool empty () const

Данная функция/метод является inline функцией

Возвращает true, если поле содежит пустое значение

bool IsChanged () const

Возвращает true, если значение поля было изменено, но еще не зафиксированно вызовом метода CustomTable::Post()

virtual void SetSaveHistory ()

Сохранять историю изменений Выставляет свойство save_history для поля в описании таблицы. Имеет смысл использовать только в конструкторе таблицы

See also: mgr_db::TableDesc::Field

virtual void SetGlobalSearchIndex ()

Сохранять значение в таблице глобального поиска GLOBAL_INDEX_TABLE Выставляет свойство index_it для поля в описании таблицы. Имеет смысл использовать только в конструкторе таблицы

See also: mgr_db::TableDesc::Field

QueryPtr Query ( const string & )

Данный метод является защищённым

Выполняет запрос к базе данных, принимает строку запроса и возвращает объект запроса к БД