Компилятор, совместимый с языками семейства xBase и Clipper
Пред.		След.

Глава 12. CLIP Classes

12.1. Class CODBDEPOSITORY

12.1.1. About

Суть этого CODB класса - хранилище объектов, чья структура описана в словаре.

12.1.2. Description

 coDepositioryNew(<sDictID>, <sUser>, <sPasswd>) --> CODBDEPOSITORY object
 coDepository:New(<sDictID>, <sUser>, <sPasswd>)  --> CODBDEPOSITORY object

12.1.2.1. Attributes

<ClassName>	CODBDEPOSITORY
<Error>	String, описание ошибки, возникшей при выполнении последней операции.

12.1.2.2. Methods

APPEND	Добавить объект в хранилище.
CHECKBODY	Проверить объект на принадлежность к классу.
CLOSE	Закрыть открытые файлы.
CREATE	Создать пустой депозитарий.
DELETE	Удалить объект из хранилища.
GETVALUE	Получить объект из хранилища.
ID4PRIMARYKEY	Вернуть идентификатор объекта.
IDLIST	Вернуть объект класса IDLIST.
NEW	Инициализация нового объекта CODBDEPOSITORY.
OPEN	Открыть все необходимые файлы.
PADRBODY	Привести объект в соответствие классу.
SELECT	Вернуть список идентификаторов выбранных объектов.
UPDATE	Обновить объект в хранилище.

12.1.2.3. Example

 * open first depository from MY001
 oDep:=coDepository():new("MY00101")
 oDep:open()
 oDict:=oDep:dictionary()
 * get currency metadata
 currBody:=oDict:classBodyByName("currency")
 if empty(currBody)
 ? "Class 'currency' not found in dictionary"
 quit
 endif
 *this data may be load from txt or dbf source file
 data:={;
 {"USD","USA dollar"},;
 {"UUU","UUU dollar"},;
 {"RUR","Russian rubl"},;
 {"RUA","Ukraina rubl :)"};
 }
 * add currency objects
 for i=1 to len(data)
 obj:=map()
 obj:code := data[i][1]
 obj:name := data[i][2]
 obj_id := oDep:id4primaryKey("currency","code",obj:code)
 if empty(obj_id)
 oDep:append(obj,currBody:id)
 else
 /* object exist in depository */
 obj:id := obj_id
 oDep:update(obj)
 endif
 if !empty(oDep:error)
 ? "Error:",oDep:error
 else
 ? "currency object '"+obj:code+"' added to depository"
 endif
 next
 ? "To depository added ",len(data)," objects"
 c_list:=oDep:select(currBody:id,,,'code="U"')
 ? "Select currency objects with code='U':",c_list
 c_list:=oDep:select(currBody:id)
 ? "Select all currency objects:",c_list
 ? "Loading objects body:"
 for i=1 to len(c_list)
 obj:=oDep:getValue(c_list[i])
 ? "code=",obj:code, "name=",obj:name
 next

 Append(<oData>, <sClassID>) 	--> <sDataID>

12.1.2.7.1. Arguments

<oData>	Object, новый объект для хранения.
<sClassID>	String, идентификатор классаю

12.1.2.7.2. Returns

Возвращает <sDataID> - идентификатор добавленного объекта.

12.1.2.7.3. Description

Append() добавляет новый объект <oData> в хранилище как объект класса <sClassID> и возвращает идентификатор зарегистрированного объекта <sDataID>.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.8. Method CODBDEPOSITORY:CHECKBODY()

Проверить объект на принадлежность к классу.

 CheckBody(<oData>, <sClassID>) 	--> <oData>

12.1.2.8.1. Arguments

<oData>	Object, объект для проверки.
<sClassID>	String, идентификатор класса

12.1.2.8.2. Returns

Возвращает объект <oData>.

12.1.2.8.3. Description

CheckBody() проверяет объект <oData> на принадлежность к классу <sClassID> и при необходимости заполняет атрибуты <oData> значениями по умолчанию.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.9. Method CODBDEPOSITORY:CLOSE()

Закрыть открытые файлы.

 Close() 	--> TRUE || FALSE

12.1.2.9.1. Arguments

No arguments

12.1.2.9.2. Returns

Возвращает TRUE если файлы закрыты.

12.1.2.9.3. Description

Open() закрывает все необходимые для работы словаря файлы или соединение с SQL сервером.

12.1.2.10. Method CODBDEPOSITORY:CREATE()

Создать пустой депозитарий.

 Create() 	--> TRUE || FALSE

12.1.2.10.1. Arguments

No arguments

12.1.2.10.2. Returns

Возвращает TRUE если создан пустой новый депозитарий.

12.1.2.10.3. Description

Create() возвращает TRUE если создан пустой новый депозитарий. Обычно, этот метод не требует прямого вызова, а вызывается автоматически при добавлении нового словаря в CODBDICTIONARY.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.11. Method CODBDEPOSITORY:DELETE()

Удалить объект из хранилища.

 Delete(<sDataID>) 	--> TRUE || FALSE

12.1.2.11.1. Arguments

<sDataID>

String, идентификатор объекта

12.1.2.11.2. Returns

Возвращает TRUE если объект был удален.

12.1.2.11.3. Description

Delete() удаляет объект с идентификатором <sDataID> из депозитария.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.12. Method CODBDEPOSITORY:GETVALUE()

Получить объект из хранилища.

 GetValue(<sDataID>) 	--> <oData>

12.1.2.12.1. Arguments

<sDataID>

String, идентификатор объекта

12.1.2.12.2. Returns

Возвращает объект <oData> с идентификатором <sDataID>.

12.1.2.12.3. Description

GetValue() достает из депозитария и возвращает объект <oData> с идентификатором <sDataID>.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.13. Method CODBDEPOSITORY:ID4PRIMARYKEY()

Вернуть идентификатор объекта.

 Id4PrimaryKey(<sClassName>, <sKeyName>, <KeyValue>) 	--> <sDataID>

12.1.2.13.1. Arguments

<sClassName>	String, имя класса
<sKeyName>	String, название атрибута
<KeyValue>	значение атрибута

12.1.2.13.2. Returns

Возвращает <sDataID> - идентификатор найденного объекта.

12.1.2.13.3. Description

Id4ProperyKey() возвращает <sDataID> - идентификатор найденног объекта, у которого свойство с именем <sKeyName> равно <KeyValue>.

12.1.2.14. Method CODBDEPOSITORY:IDLIST()

Вернуть объект класса IDLIST.

 IdList(<sClassID>[, <nOrder>][, <sName>][, <sWhere>]) 	--> <oIDList>

12.1.2.14.1. Arguments

<sClassID>	String, идентификатор класса
<nOrder>	Numeric, the index number
<sName>	String, значение атрибута <Name>
<sWhere>	String, условие поиска

12.1.2.14.2. Returns

Возвращает <oIDList> - объект класса IDLIST.

12.1.2.14.3. Description

IdList() возвращает <oIDList> - объект класса IDLIST.

12.1.2.15. Method CODBDEPOSITORY:NEW()

Инициализация нового объекта CODBDEPOSITORY.

 New(<sDepID>, <sUser>, <sPasswd>) --> CODBDEPOSITORY object

12.1.2.15.1. Arguments

<sDepID>	Stirng, идентификатор депозитария
<sUser>	String, имя пользователя
<sPasswd>	String, пароль доступа

12.1.2.15.2. Returns

Метод возвращает новый объект CODBDEPOSITORY.

12.1.2.15.3. Description

New() инициализирует новый объект CODBDEPOSITORY возвращает его.

Если объект <sDepID> уже существует, New() открывает и возвращает этот депозитарий.

12.1.2.16. Method CODBDEPOSITORY:OPEN()

Открыть все необходимые файлы.

 Open() 	--> TRUE || FALSE

12.1.2.16.1. Arguments

No arguments

12.1.2.16.2. Returns

Возвращает TRUE если файлы открыты.

12.1.2.16.3. Description

Open() открывает все необходимые для работы словаря файлы или соединение с SQL сервером.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.17. Method CODBDEPOSITORY:PADRBODY()

Привести объект в соответствие классу.

 PadrBody(<oData>, <sClassID>) 	--> <oData>

12.1.2.17.1. Arguments

<oData>	Object, исходный объект
<sClassID>	String, идентификатор класса

12.1.2.17.2. Returns

Возвращает объект <oData>.

12.1.2.17.3. Description

PadrBody() приводит объект <oData> в соответствие классу <sClassID>.

<::Error> содержит описание ошибки, если таковая произошла.

12.1.2.18. Method CODBDEPOSITORY:SELECT()

Вернуть список идентификаторов выбранных объектов.

 Select(<sClassID>[, <nOrder>][, <sName>][, <sWhere>]) 	--> <aIdent>

12.1.2.18.1. Arguments

<sClassID>	String, идентификатор класса
<nOrder>	Numeric, the index number
<sName>	String, значение атрибута <Name>
<sWhere>	String, условие поиска