Архив за месяц: Май 2012

Библиотеки, диалоги и документы Writer при работе с OpenOffice Base

(Важное замечания. В связи с Выходом 3-й версии ООфиса автор изменил точку зрения и применяет библиотеки уровня файла базы данных, которых не было во 2-й версии ООфиса)

Написав первые строчки на OpenOffice Basic опытный программист начинает задумываться а как же рационально организовать программный код. Продукт, который от редактора текста эволюционирует в сторону среды для работы клиентской части приложения, работающего с сервером баз данных, тянет за собой неизбежно длинный "хвост", надеюсь, что дальше будет лучше, но уже и сейчас неплохо.

Начнем собственно с OpenOffice Base. Мы уже отмечали раннее, что Форма открывается как документ Writer  и собственно им и является. Отсюда очевидное решение. Зачем "грузить" многофункциональное IDE Base, если можно сразу разрабатывать Форму в IDE Writer. Результат совершенно аналогичный.

Идем дальше. Программный код хранится во внешних библиотеках, которые представляют собой папку/ каталог на диске и макросах/скриптах, которые представляют собой файл .vba. Внешние скрипты отображаются в разделе  My Macros. Существуют еще и внутренние приватные скрипты, которые хранятся вместе с Формой во внутреннем формате документа Writer. Несмотря на то, что такие скрипты удобно распространять (вместе с файлом), их повторная применяемость исключена,  так как они существуют только внутри Формы/документа Writer.

Без внутренних скриптов не обойтись. Они загружаются вместе со своим документом, в то время как внешние библиотеки должны быть явно загружены таким вот оператором:

GlobalScope.BasicLibraries.LoadLibrary("LibName")

Теперь процедуры и функции библиотеки становятся доступны в текущем контексте. К ним можно обращаться как SomeFunction() или Libname.SomeFunction(). В последнем случае мы застрахованы от переопределения функций в разных библиотеках.

Все что сказано о макросах верно и для Диалогов (диалоговых окон). Каждый внешний Диалог хранится в библиотеках/папках/каталогах в отдельном файле. Внутренний - во внутреннем формате документа Writer. Диалог это достаточно мощный инструмент. Он может содержать стандартные элементы управления (кнопки, текстовые поля, радиоклавиши, списки, комбинированные поля), Но все эти элементы управления (в отличие от подобных в Формах) не могут иметь декларативной связи с базами данных и должны заполняться данными программно. Зато эти элементы легковесны и модальны. Загружать внешний Диалог нужно явно как показано в тексте функции

Funcion OpenDialog(sLibName, sDialogName)

  GlobalScope.DialogLibraries.LoadLibrary(sLibName)
  oLib = GlobalScope.DialogLibraries.GetByName(sLibName)
  oDialog = oLib.GetByName(sDialogName)
  oDlg = CreateUnoDialog(oDialog)
  oDlg.Execute()
  OpenDialog = oDlg

End Function

Это все, что сегодня я хотел сказать. Пока.

Подчиненные объекты form и списки в OpenOffice как реляцинные таблицы баз данных

Как мы уже уточнили в прошлом сообщении объект form может непосредственно входить в коллекцию forms,  а может быть подчиненным другому объекту form. Для этого открыв Навигатор форм надо выделить существующую form и правая кнопка мыши|new form.

Вспомним, что объект  form является объектом типа ResultSet. Поэтому с каждой form нужно связать существующую таблицу данных, запрос или SQL-запрос. В подчиненной form отражаются данные отфильтрованные по значению связанных полей в основной form по типу Master/Slave. Для этого в редакторе свойств подчиненной формы нужно заполнить свойства link master fields и link slave fields.

ОК. Теперь в каждую из form добавим по элементу Table Control, выбрав соответствующую form в Навигаторе форм. При этом запустится Мастер, с предложением выбрать таблицу данных или запрос, если Вы еще явно не указали его в свойствах объекта form. После этого Мастер предложить выбрать отображаемые поля. Впрочем, этот процесс можно прервать и заполнить данные в визуальном Конструкторе.

Второй тип связи, который мы рассмотрим - связь типа Справочник. Это распространенный случай. Мы храним в таблице данных ключ объекта (GUID, autoincrement и т.п.) а в отображаемой таблице выводим его полное наименование. Для этого есть удобный механизм. В визуальном Конструкторе таблицы выделяем колонку правая кнопка мыши|Replace With|List Box. Далее редактируем список свойств колонки. На закладке data свойству Тype of List Content присваиваем значение SQL. Запрос в свойстве List Content должен в первой колонке содержать отображаемое значение, а свойство Bound Field индекс колонки с ключевым полем (если считать, что первая колонка имеет индекс 0). То есть в подавляющем большинстве запросов это будет 1 для запросов типа

SELECT USERNAME, USERID FROM USERS ORDER BY USERNAME

Еще одна плюшка - накладывать фильтр на таблицу данных можно по значению введенному в текстовое поле. Для этого напишем на языке OO Basic процедуру обрабатывающую событие от клавиатуры.


Sub TextBox_onKeyUp(oEvent)
 
  oDocument = ThisComponent
  oDocument.LockControllers
  sText = oEvent.Source.text

  if Len(sText) > 3 Then
    oForm =  ThisComponent.Drawpage.Forms.getByName("MyForm")
    oForm.Filter = "USERNAME LIKE '" + sText  + "%'"
    oForm.reload()
  End If

  oDocument.UnlockControllers 

End Sub

Свяжем его с событием Key released текстового поля (на закладке event списка свойств). Заметим, что это поле должно быть расположено в другой form, чтобы перезагрузка form не "обнуляло" его текущее значение, введенное с клавиатуры. Пока.

Формы, Forms и Form в OpenOffice Base

С формами в OpenOffice Base произошла некоторая путаница. Я не ошибся в названии. Дело в том, что в процессе эволюции программного обеспечения оказалось, что Формы, Forms и Form - это немного не одно и то же. И Form - это не только Form. Поясню подробнее.

Когда Вы открываете базу данных OpenOffice Base в режиме редактирования, то видите в левой части экрана четыре закладки. В русифицированной версии это будет звучать как
  • Таблицы
  • Запросы
  • Формы
  • Отчеты
В этом смысле Форма является некоторым самостоятельным приложением, которое запускается в отдельном окне Windows. Замечу еще, что на самом деле это окно в котором запускается экземпляр OpenOffice Writer (ну и ну!)


Каждая Форма имеет коллекцию Forms объектов Form. Вначале эта коллекция пустая. Несмотря на это вы можете открывать и закрывать Форму. И даже выводить в ней текстовую информацию. И только при добавлении нового элемента управления (например кнопки Button) система создаст объект Form с именем Standard, если Вы до этого времени не создали такой объект сами.

Создавать новые формы удобнее всего из Навигатора форм, который вызывается из Главного меню View|Noolbar|Form Navigation. Объекты Form создаются или на верхнем уровне в коллекции Forms или подчиненные другому объекту Form. Это никак не отражается на внешнем виде Формы. Подчинение касается данных отображаемых в форме.

Тут надо отметить одну аномалию объект Form. Этот объект является в первую очередь объектом, связанным с таблицей базы данных или запросом SQL. Можно думать о Form как об объекте ResultSet (так оно и есть на самом деле). С другой стороны, Form является контейнером для элементов управления подобно FORM в документе HTML (и это тоже правда).

Теперь займемся программированием на OO Basic.

Откройте только что созданную Форму в режиме редактирования (правая кнопка мыши|Edit). Создайте в ней новый объект Form с именем Standatd или другим Вам понравившимся. Добавьте в этот объект элемент управления Button.

Для придания функциональности напишем макрос (скрипт) на языке OO Basic. Для этого не закрывая редактируемую Форму откроем из Главного меню Tools|Macros|Organize macros|OpenOffice.com Basic.

В раскрывшемся окне нужно выбрать место положения Вашего макроса/скрипта. В данном случае выберем расположение внутри текущей Формы (ее название можно увидеть в раскрывшемся окне).

Наконец, выбрав имя библиотеки и модуля (можно оставить по умолчанию) введем текст процедуры

Sub Button_Click(oEvent)

  oForm = ThisComponent.Drawpage.Forms.getByName("Standard")
  Xray oForm
  oForm1 = oEvent.Source.getModel().getParent()
  Xray oForm1
  
  If oForm.Name = oForm1.Name Then
    MsgBox "Is equel"
  End If

End Sub

В данной процедуре получен один и тот же объект Form двумя способами - из глобального контекста и из объекта события для кнопки Button. Код слишком очевиден, чтобы дополнительно разбирать его. Следует хорошо запомнить эти способы, они нам еще пригодятся.

Обратите внимание на вызов процедуры Xray. Для вызова этой процедуры требуется плагин/расширение, установку которого мы рассмотрели раннее. После успешной установки в окне редактора макросов/скриптов появится новая неактивная панель Xray Storm. Кликнув по панели мышью запустим процедуру окончательной установки (автозагрузки) плагина/расширения  систему. После чего строка

  Xray oForm

вызовет отладочное окно,  котором можно подробно рассматривать свойства методы и интерфейсы исследуемого объекта. Может случится, что Вам сразу не удалось установить Xray. Тогда нужно удалить/закомментировать вызовы этой процедуры и воспользоваться средствами встроенного отладчика (breakpoint, step, watch)

Теперь осталось связать процедуру с событием нажатия кнопки. Никакие соглашения об именованиях тут не действуют. В дизайнере Формы над кнопкой Button правая кнопка мыши|Control в появившемся окне выбираем закладку Events и событие When initiating, где даем привязку к процедуре Button_Click. В результате соформирутся ссылка похожая на

vnd.sun.star.script:Standard.Module1.Button_Click?language=Basic&location=document

Если скрипт не запускается, следует проверить не отключен ли он в результате слишком высокого уровня безопасности  
Главное меню|Tools||Options|OpenOffice.org|Security|Mcro Security

В данном сообщении объект Form был рассмотрен прежде всего как контейнер для элементов управления. Как объект данных ResultSet рассмотрим в следующем сообщении. Пока.



OpenOffice Base — подключение к серверу баз данных

В предыдущем сообщении описан процесс установки среды для работы с базами данных - сервер PostgreSQL и пакет OpenOffice версии 2.4.1 или выше. Кроме того описано как установить некоторые плагины/расширения для OpenOffice. Сейчас для нас важно иметь плагин/расширение postgresql-sdbc для прямого доступа к серверу PostgreSQL. Не все релизы плагинов/расширений совместимы с конкретным релизом OpenOffice. О чем могут выдаваться предупреждающе сообщения, а могут и не выдаваться.

Если плагин/расширение установлен правильно, он должен иметь статус Enabled в окне Tolls|Extension Manager, вызываемого из Главного меню OpenOffice. Если это так - подключимся к существующей базе данных PostgreSQL. (Создание баз данных в PostgreSQL выходит за рамки этой серии сообщений, поскольку уже хорошо описано в документации PostgreSQL).

Вызываем из Главного меню OpenOffice File|New|Database.
В появившемся диалоге выбираем радиокнопку Connect to an existing database.
В активном выпадающем списке выбираем postgresql. Если этот тип появился там. Если нет - пробуем загрузить другую версию плагина/расширения  postgresql-sdbc.

Далее вводим строку параметров подключения

host=localhost dbname=somedatabase user=someuser password=somepassword

Если Вы еще не корректировали Ваш файл data/pg_hba.conf, в котором заданы параметры подключения как

host all all 127.0.0.1/32 trust

ваша строка подключения будет еще проще 

host=localhost dbname=somedatabase

Напоминаю, что при такой конфигурации Вы можете подключаться к серверу только с локального компьютера, то есть на котором работает сервер.

Далее Вам предложат сохранить новую базу данных OpenOffice в файловой системе и зарегистрировать ее  в списке источников данных. Сохранив новую базу данных OpenOffice, откройте Tools|Options|OpenOffice.com Base|Databases, где вы можете просмотреть и изменить символическое имя базы данных и полный путь к файлу базы данных в файловой системе. Эти сведения мы будем использовать в своих программах для создания объектов из языка OO Basic. По умолчанию символическое имя равно имени файла базы данных OpenOffice, но это всегда можно изменить.

И в заключении о "родном" формате Баз Данных OpenOffice - HSQL. В отличие от MS Access - это чисто монопольная база данных. Поэтому не стоит углубляться в тонкости работы с этим форматом. Тем более, что все базы данных доступны в OpenOffice через интерфейс sdbc (аналог odbc и jdbc). Так что разница в работе будет минимальной. Практически ее не будет. Пока.

Начинаем работу с OpenOffice Base

Кому предназначен этот пост - прежде всего мне. Если Вы ищете средство для быстрой разработки интерфейса к серверу баз данных, например PostgreSQL - значит, возможно, и Вам.

Для 99% случаев, данные стоит хранить на SQL-сервере, не обязательно MS. Не ввязываясь в полемику какой сервер круче, замечу, что бесплатных и легко администрируемых серверов в настоящее время предостаточно. К известным всем решениям я могу добавить только свеженький Cubrid-сервер.

Сервер баз данных - это, конечно, хорошо. Но на чем писать клиентскую часть? Практически все средства быстрой разработки коммерческие. И даже если это стоит недорого - никто не застрахован от наличия в руководстве зациклившихся на своем Эго субъектов, от которых зависит решение. Мне приходилось слышать разные типы отказов от "то же самое можно сделать и в Excel" до "я Вам напишу это за день на Делфях и оба будем счастливы". И вот по крайней мере с версии 2.0 OpenOffice уже содержит хороший набор средств для быстрой разработки клиентской части баз данных. Эти средства пока мало востребованы. Основная причина, на мой взгляд - отсутствие документации. Прошло 5 лет, вышел очередной релиз - OpenOffice 3, наконец, фрагменты кода стали гулять в Интернете. Вышла подробная книга на английском языке и первая книга на русском о программировании на языке OO Basic для OpenOffice и OpenOffice Base.


Дальнейшая часть сообщения посвящена подготовке рабочей среды.

При выборе сервера баз данных, я остановился на PostgreSQL. Его очень легко установить и администрировать. Кроме того, есть хороший плагин для OpenOffice, позволяющий работать без технологий ODBC/JDBC напрямую с сервером. Итак, нам потребуется архив для установки без инсталляции с сайта www.postgresql.org. На сегодня это postgresql-9.1.3-2-windows-binaries.

Этот архив распаковываем  в любую папку/каталог. Далее открываем папку/каталог bin и выполняем команду

initdb.exe -D ../data --locale=Russian_Russia.1251 --encoding=utf-8

Теперь в папке/каталоге data (можно выбрать любое другое имя) будут находиться ваши/наши базы данных. Далее стартуем сервер.

pg_ctl.exe -D ../data start

Не забываем культурно останавливать сервер.

pg_ctl.exe -D ../data stop
 
Для создания баз данных, таблиц и других объектов удобнее всего воспользоваться программой pgAdmin3.exe, которая расположена в папке/каталоге bin. Программа имеет удобный графический интерфейс.

Для начала работы необходимо разобраться с файлом data/pg_hba.conf, в котором содержаться правила доступа к серверу баз данных с различных хостов. По умолчанию возможен только неограниченный доступ с локального компьютера, что определяется строкой в файле

host     all     all     127.0.0.1/32     trust

Впрочем, защита данных это особый разговор.

Теперь загружаем OpenOffice. Я выбрал portable версию 2.4.1. Она сравнительно легковесна и в ней работают все нужные плагины/расширения. Далее Вам потребуется Java. Я поставил себе jre1.4.2, как вполне достаточную и легковесную. Эту программу надо зарегистрировать в OpenOffice из главного меню Tools|Option|OpenOffice.org|Java. Теперь можно загружать плагины/расширения. Их нам потребуется два.

Первый - postgresql-sdbc для прямого доступа к серверу PostgreSQL. Второй- OceanBasicTool, который включает Xray - средство для просмотра свойств и методов объектов. При дефиците документации это средство дает ощутимую помощь.

Плагины/расширения инсталлируют из главного меню OpenOffice Tools|Extension Manager|Add...

Все готово для начала работы. Я не буду описывать как создавать базы данных и таблицы в PostgreSQL. Для этого хватает специализированных ресурсов. Пока.