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

Class CODBDICTIONARY

Name

CODBDICTIONARY  --  Суть этого CODB класса - хранилище метаданных - объектов, хранящих описание других объектов классов: DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP

Synopsis

 coDictionaryNew(<sDictID>, <sUser>, <sPasswd>) --> CODBDICTIONARY object
 coDictionary:New(<sDictID>, <sUser>, <sPasswd>)  --> CODBDICTIONARY object

Description

Суть этого CODB класса - хранилище метаданных - объектов, хранящих описание других объектов классов: DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP

Attributes

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

Methods

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

Method CODBDICTIONARY:APPEND()

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

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

Описание структур добавляемых метаданных смотрите в разделе CODB метаданные.

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

<oData>

Object, новый объект для хранения.

<sClassName>

String, название класса - одно из DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP.

Returns :

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

Method CODBDICTIONARY:ATTRBODYBYNAME()

 AttrBodyByName(<sObjClassName>) 	--> <oData>

AttrBodyByName() возвращает <oData> - объект класса ATTR с именем <sClassObjName>.

<sClassObjName>

String, название класса.

Returns :

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

Method CODBDICTIONARY:CHECKBODY()

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

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

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

<oData>

Object, объект для проверки.

<sClassName>

String, название метакласса - одно из DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP.

Returns :

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

Method CODBDICTIONARY:CLASSBODYBYNAME()

 ClassBodyByName(<sObjClassName>) 	--> <oData>

ClassBodyByName() возвращает <oData> - объект класса CLASS с именем <sClassObjName>.

<sClassObjName>

String, название класса.

Returns :

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

Method CODBDICTIONARY:CLOSE()

 Close() 	--> TRUE || FALSE

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

Returns :

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

Method CODBDICTIONARY:COUNTER()

 Counter(<sCounterName>, <nDep>[, <nValue>]) 	--> <nCounter>

Counter() возвращает <nCounter> текущее значение счетчика с именем <sCounterName> для депозитария с номером <nDep>.

Если определено значение <nValue>, счетчик <sCounterName> устанавливается в <nValue>.

<sCounterName>

String, название счетчика

<nDep>

Numeric, номер депозитария

<nValue>

Numeric, новое значение счетчика

Returns :

Возвращает текущее значение счетчика.

Method CODBDICTIONARY:CREATE()

 Create() 	--> TRUE || FALSE

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

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

Returns :

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

Method CODBDICTIONARY:DELETE()

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

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

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

<sDataID>

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

Returns :

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

Method CODBDICTIONARY:GETVALUE()

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

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

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

<sDataID>

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

Returns :

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

Method CODBDICTIONARY:HASHNAME()

 HashName(<nHashCode>) 	--> <sName>

HashName() возвращает <sName> название свойства по хэш-коду <nHashCode> или пустую строку в случае неуспеха.

<nHashCode>

Numeric, хэш-код

Returns :

Возвращает название свойства по хэш-коду.

Method CODBDICTIONARY:IDLIST()

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

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

<sClassName>

String, название метакласса - одно из DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP.

<nOrder>

Numeric, the index number

<sName>

String, значение атрибута <Name>

<sWhere>

String, условие поиска

Returns :

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

Method CODBDICTIONARY:NEW()

 New(<sDictID>, <sUser>, <sPasswd>) --> CODBDICTIONARY object

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

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

<sDictID>

Stirng, идентификатор словаря

<sUser>

String, имя пользователя

<sPasswd>

String, пароль доступа

Returns :

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

Method CODBDICTIONARY:OPEN()

 Open() 	--> TRUE || FALSE

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

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

Returns :

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

Method CODBDICTIONARY:PADRBODY()

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

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

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

<oData>

Object, исходный объект

<sClassName>

String, название метакласса - одно из DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP.

Returns :

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

Method CODBDICTIONARY:SELECT()

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

Select() возвращает список идентификаторов объектов, принадлежащих классу <sClassName> в порядке <nOrder>, у которых аттрибут <Name> точно равен <sName> и содержимое аттрибутов соответсвует выражению <sWhere>.

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

<sClassName>

String, название метакласса - одно из DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP.

<nOrder>

Numeric, the index number

<sName>

String, значение атрибута <Name>

<sWhere>

String, условие поиска

Returns :

Возвращает <aIdent> массив идентификаторов объектов, соответствующих заданным условиям.

Method CODBDICTIONARY:UPDATE()

 Update(<oData>) 	--> TRUE || FALSE

Update() обновляет объект <oData> в хранилище. Если словарь не содержит объект с идентификатором <oData:ID>, Update() возвращает FALSE.

Описание структур метаданных смотрите в разделе CODB метаданные.

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

<oData>

Object, объект для обновления

Returns :

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

Example:

 /* create new object of class CODICTIONARY */
 oDict := coDictionary():new("MY001")
 oDict:open()
 ....
 
 /* create new object specifier */
 depBody := map()
 depBody:name := "depository for Russian global information"
 ...
 /* append object to dictionary */
 dep_id := oDict:append(depBody,"DEPOSIT")
 
 /* check error */
 if !empty(oDict:error)
 ? "Error:",oDict:error
 endif

See also

CODBLIST

Platforms

No dependies of platform.

Пред.НачалоСлед.
Class CODBDEPOSITORYУровень вышеClass CODBFORMATTER