DevelopmenOnTheEdge - Новые страницы [ru]

Сборка BE4 и BE-SQL

2016-08-16T07:23:56Z

Uuinnk:

== Сборка BE-SQL ==

BE-SQL — полноценный Maven-проект. Смотрите настройку доступа в Maven(Nexus) [https://sites.google.com/a/developmentontheedge.com/wiki/home/sistemnoe-administrirovanie/maven-repozitorij-nexus во внутренней вики]. Все этапы сборки выполняются с помощью maven, включая компиляцию javacc-грамматики. Для сборки новой версии:

* Выкачать проект dote/dote_modules
* Зайти в dote_modules/sql
* Изменить номер версии в pom.xml:

<version>0.0.24</version>

* Запустить mvn deploy.

После этого новая версия попадёт в Nexus-репозиторий и будет доступна для других разработчиков. Деплоить одну и ту же версию дважды не выйдет. Если что-то пошло не так, увеличивайте номер версии снова и деплойте заново.

Чтобы воспользоваться новой версией BE-SQL в BE4, вам придётся выпустить также новую версию BE4 с обновлёнными зависимостями (см. ниже).

== Структура BE4 ==

Проект BE4 состоит из двух частей. Исходный код по историческим причинам лежит вместе, но разделён по проектам:

* BE4 Core: ядро BE4, необходимое для работы через [[Использование ant|Ant]]. Состоит из пакетов (включая подпакеты):
** com.beanexplorer.enterprise.be4core
** com.beanexplorer.enterprise.metadata
* BE Eclipse IDE: плагины для Eclipse, реализующие пользовательский интерфейс. Включает в себя все остальные пакеты и зависит от BE4 Core.

BE4 Core содержит меньше зависимостей и является полноценным Maven-проектом (все зависимости есть в Maven). Pom-файл расположен в be4/pom/pom.xml.

BE Eclipse IDE собирается через Eclipse с помощью Ivy. При этом некоторые зависимости присутствуют явно в виде jar (каталоги be4/lib и be4/plugins — кое-что из BioUML), но большая часть зависимостей выкачивается автоматом через Ivy. Конфигурация ivy в be4/src/ivy.xml. Проект в Eclipse настроен так, что зависимости скачиваются в каталог be4/dep и потом оттуда используются. По факту с точки зрения сборки BE Eclipse IDE включает в себя BE4 Core.

== Добавление/обновление зависимости в BE4 ==

Рассмотрим как обновить версию зависимости BE4 на примере BE-SQL. Предположим, требуется обновить версию BE-SQL с 0.0.24 на 0.0.25.

1. Обновите версию в be4/pom/pom.xml (необходимо для сборки BE4 Core; этот шаг не нужен для зависимостей, которые требуются только BE Eclipse IDE):

<dependency>
<groupId>com.developmentontheedge</groupId>
<artifactId>sql</artifactId>
<version>0.0.24</version> --> 0.0.25
</dependency>

2. Обновите версию в be4/src/ivy.xml (необходимо для компиляции BE Eclipse IDE)

<dependency org="com.developmentontheedge" name="sql" rev="0.0.24" />
-->
<dependency org="com.developmentontheedge" name="sql" rev="0.0.25" />

3. Обновите версию в be4/META-INF/MANIFEST.MF в разделе Bundle-ClassPath (необходимо для работы BE Eclipse IDE):

dep/sql-0.0.24.jar, --> dep/sql-0.0.25.jar,

Следует делать все изменения одновременно. Даже если вы не используете Eclipse-версию, пользователи Eclipse могут пострадать, если ограничиться первым пунктом.

После любых изменений зависимостей, как и после изменений исходного кода, необходимо выпустить новую версию BE4, чтобы другие пользователи могли увидеть ваши изменения (см. ниже). Исключение составляют только пользователи BE Eclipse IDE, которые не обновляются с Update-site, а используют режим с двумя Eclipse-инсталляциями. Желательно со временем перевести этих пользователей на Eclipse Update site.

== Сборка версии BE4 ==

Предположим, последняя выпущенная версия 0.1.46 и мы хотим выпустить версию 0.1.47.

1. Сборка Maven-артефакта. Аналогично BE-SQL: идём в файл be4/pom/pom.xml, меняем версию <code><nowiki><version>0.1.46</version></nowiki></code> на <code><nowiki><version>0.1.47</version></nowiki></code> и запускаем команду mvn deploy. После этого BE4 попадает в Nexus.

2. Обновление версии по умолчанию. Ant-скрипты по умолчанию пользуются версией BE4, которая указана в файле be4/src/be4version.properties, который выглядит так:

BE4_VER=0.1.46

Чтобы все пользователи перешли на новую версию, замените здесь на 0.1.47 и закоммитьте. Если вдруг в новой версии обнаружатся критические проблемы, достаточно будет просто вернуть здесь версию на стабильную. Также при запуске любого ant-таргета можно указать версию явно. Например, так: <code>ant -DBE4_VER=0.1.46</code>. Таким образом можно сравнивать поведение в разных версиях.

Обратите внимание, что хотя Java-код BE4 используется из стабильных сборок, опубликованных через Maven (код из Git не используется), ftl-макросы используются из be4/macro. Поэтому там ошибки повлияют на работу коллег.

3. Обновление Eclipse Update Site. Для этого делаются следующие шаги:

3.1. Обновляем версию в be4/META-INF/MANIFEST.INF в строчке Bundle-Version:

Bundle-Version: 0.1.46

3.2. Импортируем в Eclipse проекты be4/.project, be4/com.beanexplorer.be4.feature/.project, be4/com.beanexplorer.be4.site/.project

3.3. Открываем /com.beanexplorer.be4.feature/feature.xml в Feature Manifest Editor.

3.4. Во вкладке Overflow меняем версию 0.1.46.qualifier на 0.1.47.qualifier.

3.5. Во вкладке Plugins нажимаем правой кнопкой на com.beanexplorer.enterprise.eclipse, Synchronize Versions, Copy versions from plug-in and fragment manifests, Finish

3.6. Сохраняем feature.xml (обязательно сейчас, не позже!)

3.7. Открываем /com.beanexplorer.be4.site/site.xml в Site Manifest Editor

3.8. Во вкладке Site Map разворачиваем beanexplorer4 и удаляем features/com.beanexplorer.be4.feature_0.1.46.qualifier.jar. Затем нажимаем Add feature, пишем com.beanexplorer и выбираем в списке com.beanexplorer.be4.feature.

3.9. Сохраняем и нажимаем Build All.

3.10. После этого каталог be4/com.beanexplorer.be4.site является полноценным update site'ом Eclipse. Скопируйте его в \\logrus.dote.ru\pub2\be4\com.beanexplorer.be4.site (лучше старую версию переименовать, чтобы если что можно было откатиться.

== beanexplorerdev, beanhelpers для be4 ==

cd BeanExplorer/release/
mvn deploy:deploy-file -DgroupId=com.beanexplorer -DartifactId=beanhelpers -Dversion=0.0.3 -Dpackaging=jar -Dfile=beanhelpers.jar -Durl=http://nexus.dote.ru/nexus/content/repositories/releases/ -DrepositoryId=dote
mvn deploy:deploy-file -DgroupId=com.beanexplorer -DartifactId=beanexplorerdev -Dversion=0.0.3 -Dpackaging=jar -Dfile=beanexplorer_dev.jar -Durl=http://nexus.dote.ru/nexus/content/repositories/releases/ -DrepositoryId=dote

TODO может деплоить snapshots?

mvn deploy:deploy-file -DgroupId=com.beanexplorer -DartifactId=beanhelpers -Dversion=0.0.4-SNAPSHOT -Dpackaging=jar -Dfile=beanhelpers.jar -Durl=http://nexus.dote.ru/nexus/content/repositories/snapshots/ -DrepositoryId=dote
mvn deploy:deploy-file -DgroupId=com.beanexplorer -DartifactId=beanexplorerdev -Dversion=0.0.4-SNAPSHOT -Dpackaging=jar -Dfile=beanexplorer_dev.jar -Durl=http://nexus.dote.ru/nexus/content/repositories/snapshots/ -DrepositoryId=dote

Установка BeanExplorer4

2016-06-21T11:03:14Z

Lan:

Для установки BeanExplorer4 надо иметь установленный Eclipse Luna и воспользоваться Eclipse Update Site по следующему адресу:

\\logrus.dote.ru\pub2\be4\com.beanexplorer.be4.site

Help -> Install New Software -> Add..., указать любое имя и этот путь:

[[Файл:BE4InstallationUpdateSite.png]]

Если ничего не видно, снять галочку Group items by category. Должно быть такое окошко:

[[Файл:BE4InstallationInstall.png]]

Выделить BeanExplorer4Feature, нажать Next, со всем согласиться, установить и перезапустить Eclipse.

После установки можно почитать [[BeanExplorer4|вводную статью про BeanExplorer4]].

BeanExplorer5 API

2015-11-25T05:46:06Z

Asko: /* Основные интерфейсы и классы API */

== Backend ==
<big>BeanExplorer5 проект - это OSGi бандл, поддерживающий расширения через <code>plugin.xml</code>.</big>

При сборке BeanExplorer5 проекта он воспринимается как OSGi бандл, поэтому у него должен быть манифест <code>META-INF/MANIFEST.MF</code>. В этом манифесте указывается, от каких бандлов зависит данный бандл. Основные классы API находятся в бандле <code>com.beanexplorer.be5</code>, поэтому его необходимо указать в манифесте.

Помимо этого в структуру BeanExplorer5 проекта входит <code>plugin.xml</code>, в котором возможно объявлять свои компоненты, используя точку расширения <code>com.beanexplorer.be5.component</code>, которая объявлена в бандле <code>com.beanexplorer.be5</code>. Пример объявления компонента:

<extension point="com.beanexplorer.be5.component">
...
<component
class="com.beanexplorer.enterprise.components.Menu"
id="menu"
name="Menu">
</component>

Указанный класс должен реализовывать интерфейс <code>Component</code>:

package com.beanexplorer.enterprise.components;

public interface Component {
void generate(ComponentParameters parameters);
}

<code>com.beanexplorer.be5.component</code> - это единственная точка расширения BeanExplorer5, она позволяет регистрировать свои backend компоненты, которые будут доступны по следующим URL:

//domain/app/main/:componentId
//domain/app/main/:componentId/:any/:path

Например:

http://localhost:8080/biostore_be5/main/menu
http://localhost:8080/biostore_be5/main/menu/withIds

При запросе к веб-приложению по этим запросам будет создан новый экземпляр компонента и вызван его метод generate. Для того, чтобы узнать путь после имени компонента (<code>:any/:path</code>), нужно вызвать метод <code>parameters.getRequestUri()</code>. В случае пустого пути возвращается пустая строка. В случае наличия пути, он возвращается без начального слеша.

=== Основные интерфейсы и классы API ===

* <code>Component</code> - главный интерфейс, который должны реализовывать BE5 компоненты. Поскольку проще всего общаться с frontend посредством пересылки JSON, существуют абстрактные классы, которые упрощают написание таких компонентов:
** <code>JsonComponent</code> - при наследовании этого класса необходимо только реализовать один метод, возвращающий строку, представляющую собой JSON.
** <code>NetSfJsonComponent</code> - при наследовании этого класса необходимо только реализовать один метод, возвращающий <code>net.sf.json.JSONObject</code>.
* <code>ComponentParameters</code> - всё, что необходимо компоненту. Если необходимо что-то ещё, то либо мы что-то забыли или не предусмотрели (и об этом непременно стоит сообщить нам), либо вы неправильно используете API BeanExplorer5. К чему возможно доступиться из этого компонента:
** <code>Project</code> - BE4 проект.
** <code>Meta</code> - полезные методы для работы с BE4 проектом.
** <code>UserService</code> - работа с сессиями, ролями, выбором языка.
** <code>ResponseService</code> - формирование текстового ответа. Необходимо только для абстрактных компонентов, обеспечивающих обмен текстовыми сообщениями в каком-нибудь формате (JSON, XML и т.п.).
** <code>HttpServletRequest</code> и <code>HttpServletResponse</code> - предполагается, что в обычной ситуации они не используются. Необходимы только для реализации абстрактных компонентов, обеспечивающих работу с каким-нибудь протоколом на низком уровне. Для обмена текстом достаточно <code>ResponseService</code>.

<big>Обратите внимание на то, что другие классы не являются частью API, в т.ч. класс Be5 и классы, связанные с реализацией конкретных компонентов.</big>

Частью API также '''не''' являются соглашения о том, какие данные возвращают компоненты, поскольку эти соглашения используются обмена сообщениями между frontend и backend частями компонентов. Исключением являются соглашения о том, какие данные возвращают компоненты, описанные в разделе [[#REST API|REST API]].

== Frontend ==
<big>Компоненты BE5 на frontend - это React.js компоненты.</big>

Компоненты подключаются через SystemJS, при этом используется синтаксис ES2015 или метод <code>define</code>.

import Component from 'components/component';

define([ 'components/component' ], function(Component) {
// use(Component)
// ...
return {};
});

Кнопки и ссылки на компоненты (в частности запросы и формы) в BE5 не должны писаться вручную.

Не всё, что находится в проекте be5-frontend, является частью API.

=== Основные части API ===

* <code>be5</code> - ядро frontend. Функции, являющиеся частью API:
** <code>be5.net.request: function(path, params, success, failure)</code> - делает асинхронный POST запрос к ''вашему'' backend компоненту (<code>path</code> - <code>componentId/any/path</code>).
** <code>be5.registerAction: function(actionName, fn)</code> - регистрирует действие, которое будет вызвано при клике по кнопке или ссылке. Вызов действия является следствием смены hash url, при этом адрес разбирается на позиционные и именованные параметры. В зарегистрированную функцию передаются все позиционные параметры, за которыми идёт объект с именованными параметрами. Именованными параметрами считаются части URL, которые содержат символ '=', а позиционными считаются все остальные.
** <code>be5.ui.registerDocumentType: function(type, creator)</code> - регистрирует новый вид документа. Функция, переданная вторым параметром в <code>registerDocumentType</code> обычно вызывает <code>React.createElement</code> и возвращает результат вызова. Результат будет помещён в стандартное для проекта место отображения документа. На данный момент на backend невозможно добавлять свои виды документов, но документ возможно создать посредством вызова <code>be5.ui.recreateDocument</code>.
** <code>be5.ui.recreateDocument</code> - пересоздаёт документ. В качестве аргумента передаётся объект с двумя полями: <code>type</code> и <code>value</code>. Первое указывает тип документа, второе - значение документа, которое интерпретируется обработчиком документа, зарегистрированным посредством вызова <code>be5.ui.registerDocumentType</code>.
** <code>be5.ui.createDocument</code> - похож на <code>be5.ui.recreateDocument</code>, однако позволяет встраивать документы в произвольное место страницы. Полезно, если тип документа заранее неизвестен.
** <code>be5.load.css(path)</code> - подгружает CSS динамически, это необходимо во frontend компонентах, которым нужен CSS. <code>path</code> - путь к файлу CSS, например <code>css/menu.css</code>.
** <code>be5.messages</code> - объект с локализованными сообщениями (русский и английский язык).

==== Другой способ определения действий ====
Вы также можете определить действие неявным способом не вызывая <code>be5.registerAction</code>. Для этого создаётся файл с именем <code>/actions/yourAction.js</code>, который определяет AMD модуль посредством метода <code>define</code>. Объявдяемым элементом в этом модуле является функция, которая используется так же, как и функция, регистрируемая вызовом <code>be5.registerAction</code>, однако при этом подгрузка компонента произойдёт лениво - при первом его использовании.

=== Компоненты ===
<big>API React компонентов описывается в соответствующих файлах в <code>propTypes</code> React компонентов.</big>

Компоненты, не указанные ниже, не являются частью API. По соглашениям именования мы сопоставляем имя компонента <code>ComponentName</code> SystemJS модулю <code>component/componentName</code>, который находится в файле <code>component/componentName.js</code> (или <code>component/componentName.jsx</code>, если для вашего проекта настроена компиляция JSX).

==== Be5Block ====
Простая таблица внутри Bootstrap 4 Card.

==== Be5Form ====
Простая форма внутри Bootstrap 4 Card.

==== Be5View ====
Обобщённый компонент для таблиц, форм и статических страниц.

==== SimpleTable ====
Простая таблица.

==== SimpleForm ====
Простая форма.

==== Document ====
Место для любого документа, в т.ч. формы или таблицы.

== REST API ==
Запросы отсылаются с телом <code>application/x-www-form-urlencoded</code>.

=== document ===
Пример запроса (здесь указано содержимое тела запроса - на самом деле оно выглядит несколько иначе, поскольку кодируется в <code>application/x-www-form-urlencoded</code>):

category: servers
page: All records
values:

Пример таблицы:

{
"type": "table",
"value": {
"title": "Servers: All records",
"category": "servers",
"page": "All records",
"operations": [ {
"name": "Edit",
"title": "Edit",
"visibleWhen": "anySelected",
"requiresConfirmation": false,
"isClientSide": false
} ],
"selectable": true,
"columns": [ "Edit", "Provider", "Location", "Name", "Address", "Description", "Products", "Remote address" ],
"rows": [ {
"id": "1",
"cells": [ "html", "html", "html", "html", "", "html", "html", "html", "", "" ]
}, {
"id": "3",
"cells": [ "html", "html", "", "html", "html", "html", "", "", "", "" ]
} ],
"length": 20,
"parameters": {},
"totalNumberOfRows": 20
}
}

=== document/count ===
Запрос выглядит так же, как и у <code>document</code>.

Пример ответа:

{ "value": 3 }

=== form ===
Пример запроса:

category: groups
page: All records
action: Insert
values:
selectedRows:
isViewParameters: false

Пример ответа:

{
"type": "form",
"value": {
"category": "groups",
"page": "All records",
"action": "Insert",
"title": "Insert",
"selectedRows": "",
"fields": [ {
"name": "name",
"title": "Name",
"isReadOnly": false,
"canBeNull": false,
"type": "textInput",
"value": ""
}, {
"name": "language",
"title": "Language",
"isReadOnly": false,
"canBeNull": false,
"type": "comboBox",
"options": [ {
"name": "Afar",
"value": "aa"
}, ..., {
"name": "Zulu",
"value": "zu"
} ],
"value": "en"
}, {
"name": "description",
"title": "Description",
"isReadOnly": false,
"canBeNull": false,
"type": "textArea",
"columns": 40,
"rows": 4,
"value": ""
}, {
"name": "maxUsers",
"title": "Max Users",
"isReadOnly": false,
"canBeNull": true,
"type": "textInput",
"value": ""
} ],
"parameters": {},
"isViewParameters": false
}

=== form/apply ===
Пример запроса:

category: groups
page: All records
action: Insert
selectedRows:
values: [{"name":"name","value":"a","required":true},{"name":"language","value":"en","required":true},{"name":"description","value":"a","required":true},{"name":"maxUsers","value":"5","required":false}]
isViewParameters: false

Пример ответа:

{
type: "formResult",
value: {
content: "",
redirect: "table/groups/All records"
}
}

<code></code>

[[Category:BeanExplorer5]]

Сборка BeanExplorer5 проекта

2015-11-23T11:56:54Z

Dimka: /* Подготовка BeanExplorer5 */

<big>Для сборки BeanExplorer5 проекта необходимо сначала подготовить BeanExplorer5 для сборки.</big>

== Подготовка инструментов ==
* Необходим Ant. Для установки под Windows необходимо скачать Ant с [http://ant.apache.org/ официального сайта].
* Необходим NPM. Для установки под Windows необходимо скачать Node.js с [https://nodejs.org/en/ официального сайта]. Мы используем 4 версию.
* Необходим Gulp. <code>npm install --global gulp</code>.

== Подготовка BeanExplorer5 ==
* В папке <code>be5/be5_build</code> вызвать <code>ant prepareworkspace</code>.
* В папке <code>be5</code> вызвать <code>npm install</code>.
* В папке <code>be5/be5-frontend</code> вызвать <code>npm install</code>, затем <code>gulp</code>.

== Работа с проектом ==
* При первой сборке вызывается <code>ant be5.deploy</code> в папке проекта.
* При изменении frontend проекта вызывать <code>ant be5.frontend</code> в папке проекта.
* Не предусмотрено Ant цели для вызова при изменении backend кода.
* Если вы редактируете <code>be5-frontend</code>, то необходимо вызвать <code>gulp watch</code> и ''помимо этого'' после редактирования вызывать <code>ant be5.frontend</code> из папки BeanExplorer5 проекта.

== При создании проекта ==
Пример frontend проекта находится в <code>be5/be5-demo</code>, он содержит пример настройки Gulp для инкрементальной сборки.

Пример объявления целей be5.deploy и be5.frontend:

<code>
<target name="be5.deploy" depends="prepare">
<property name="appabsolutepath" location=".." />
<ant dir="../../be5" target="compileapp" inheritAll="false">
<property name="modules" value="${MODULES}" />
<property name="usedatasource" value="true" />
<property name="appname" value="${PROJECT_NAME}" />
<property name="appdir" value="${appabsolutepath}" />
<property name="appencoding" value="UTF-8" />
<property name="SRCDIR" value="${appabsolutepath}/src" />
<property name="PROJECT_SOURCE" value="${PROJECT_SOURCE}" />
</ant>
<ant antfile="${COMMONDIR}/makefiles/be_webxml.xml" target="install_context"/>
</target>

<target name="tomcat">
<available property="tomcat.is.installed" file="${TOMCAT_HOME}/webapps" type="dir"/>
</target>

<target name="be5.frontend" depends="tomcat,check_for_tomcat">
<property name="appabsolutepath" location=".." />
<ant dir="../../be5" target="fastfrontend" inheritAll="false">
<property name="appname" value="${PROJECT_NAME}" />
<property name="appdir" value="${appabsolutepath}" />
</ant>
</target>
</code>

[[Category:BeanExplorer5]]

BeanExplorer5

2015-11-23T11:32:35Z

Uuinnk:

<big>Это основная статья о BeanExplorer5.</big>

Поскольку эта основная статья недописана, остальная её часть для тех, кто будет дорабатывать BeanExplorer5, а не использовать.

==Концепции и технологии==

Основные технологии, которые мы используем - это Java, Java Servlet, OSGi, React, SystemJS, ES2015 через Babel.

===Frontend===

Основные frontend компоненты написаны на React, но могут быть написаны на чём угодно. Поскольку React - это лишь "V" из MVC, то часть функционала полноценного frontend framework было необходимо реализовать, и этот функционал находится в be5/be5-frontend/src/scripts/be5.js (или просто be5 - далее буду писать имена скриптов кратко). Это покрывает функционал routing, requests, frontend localization. Также полезный базовый функционал находится в be5/bus, be5/createStore, be5/createSimpleStore, be5/ext.
* bus - сообщения (брокер из паттерна pub/sub); например, bus.fire('DocumentChange', value), bus.listen('DocumentChange', value => ...);
* ext - расширения;
* createStore - создание store для управления данными на frontend; позволяет подписаться на его изменения;
* createSimpleStore - создание store, полным состоянием которого является результат GET запроса.

Необходимые части frontend подгружаются динамически с помощью SystemJS.

JSX+ES2015 скрипты компилируются с помощью Babel при сборке проекта.

Нерешённые проблемы:
* frontend подготовлен, но не переведён на [https://github.com/reactjs/react-redux redux], а это необходимо для упрощения работы с React компонентами (без redux или Flux бывает довольно нетривиально управлять состоянием React компонентов);
* be5.js требует разделения на небольшие части, также, как выделены bus и ext;
* невозможно отказаться от компиляции ES2015, даже если она будет поддерживаться всеми браузерами. SystemJS проверяет наличие ES2015 синтаксиса в скриптах, и в случае его наличия пытается использовать транслятор в браузере, даже если явно указано, что транслятора нет.

Tips на будущее:
* используйте [https://github.com/reactjs/react-redux redux], [https://facebook.github.io/react/docs/two-way-binding-helpers.html React two-way binding], [https://github.com/JedWatson/classnames React classNames].

===Backend===

Основные части API находятся в com.beanexplorer.enterprise.api. Проще всего начать знакомство с BE5, посмотрев на содержимое этого пакета и его подпакетов. В com.beanexplorer.enterprise.api.experimental.v1 хранятся маленькие полезности. Если они становятся не экспериментальными, а доказавшими полезность, можно переносить их в другие подпакеты api. v1 в названии пакета необходимо для поддержки разного API для одинакового функционала, если невозможно быстро отрефакторить код с экспериментальным функционалом или если хочется проверить, какой подход окажется полезнее.

Сердце всего BE5 - это ServiceProvider. ServiceProvider доступен компонентам, а в конструкторы сервисов инжектируются другие сервисы или сам ServiceProvider.

Good practices:
* Разделяем модельные элементы на бины без логики, сервисы и репозитории.
* Презентационный код пишется в компонентах. Если в компоненте много строчек кода, то что-то пошло не так.

Нерешённые проблемы:
* При написании operation почти любая строчка кода приводит к увеличению зависимости от наличия метаданных в БД, а также ухудшению возможности что либо протестировать, равно как и невозможности переиспользовать написанный код. Необходимо новое API для операций, полагающееся на сервисы - содержимого com.beanexplorer.enterprise.api.experimental и com.beanexplorer.enterprise.api.experimental.v1 недостаточно.
* Нет предусмотренного сетапа для тестирования.
* Нет API для запросов из БД, которое покрывает все возможные SQL запросы.
* Мы не избавились от метаданных в базе данных, поскольку BeanExplorer5 использует legacy код, который полагается на наличие метаданных в базе данных.
* Нет стандартного способа взять запрос из Query (той, что определена в YAML) и запустить его. Дело в том, что концептуально сейчас Query - это запросы, которые используются как запросы для таблиц, которые может увидеть пользователь. Такие запросы помечаются набором ролей, обладатели которых могут запускать запросы. Однако бывает необходимость описать запрос на BE-SQL и запустить его из Java. На мой взгляд не только роли должны игнорироваться, но и вообще такие запросы должны либо где-то в другом месте лежать (например, namedQueries.yaml), либо быть приписанными к Entity и не находиться в разделе queries, а, например, находиться в разделе "systemQueries" (причём поскольку это новые запросы, они никогда не должны попадать в БД, а быть только в in-memory meta/project; сейчас запустить обычную Query через BE-SQL игнорируя роли можно так:

<code><pre>
executorService.createExecutor(meta.getQueryIgnoringRoles("entityName", "queryName"), request).execute())
</pre></code>

Tips на будущее:
* Можно ресширить функционал ServiceProvider добавлением способности обрабатывать аннотированные поля сервисов - это избавит от проблем обхода циклических зависимостей сервисов и написания boilderplate в конструкторах. Также возможно попробовать сэмулировать поведение из Spring Core или Google Guice - это бы позволило просто перйти на них при возможности (см. следующее).
* Можно даже использовать Google Guice или переиспользовать Spring Core, если найдётся хороший способ регистрации сервисов из разных OSGi модулей (сам BE5 и BE5 приложение - в разных OSGi модулях).
* В идеальном случае было бы хорошо не писать репозитории, да и сервисы для запросов - для этого есть Hibernate, реализации JPA и другие ORM. А ещё лучше - попробовать переиспользовать Spring Data (объявлять интерфейсы с методами, описывающими запрос, без необходимости писать сам код запроса - как personRepository.findByEmailAndActive("email", true) - вызов метода из интерфейса, реализацию которого подкладывает Spring).
* Или хотя бы доделать SQL builder (SqlBuilder) и SQL Service (SqlService), потому что они сейчас не позволяют делать запросы с LEFT JOIN и WITH RECURSIVE.
* В таком случае было бы хорошо реализовывать код репозиториев с использованием одного универсального парсера из ResultSet в бины (при этом он должен работать по принципу fail-fast, а не как Dynamic.assign(Object bean, DynamicPropertySet dynamicProperties), который игнорирует все ошибки).

==Сборка BeanExplorer5==
См. [[Сборка BeanExplorer5 проекта|Сборка BeanExplorer5 проекта]].

==BeanExplorer5 API==
См. [[BeanExplorer5 API|BeanExplorer5 API]]

[[Category:BeanExplorer5]]

BE-SQL

2015-11-19T10:19:07Z

Uuinnk:

'''BE-SQL''' — диалект SQL, который поддерживается BeanExplorer SQL Parser. Поддерживаются только запросы SELECT. Больше всего он похож на PostgreSQL, но некоторые конструкции из других диалектов тоже поддерживаются. Он также должен понимать различные BE-специфичные теги вроде <if>, <unless> и т. д. В данный момент находится в разработке: не все реальные запросы из проектов успешно разбираются BE-SQL.

Соответствие FreeMarker-конструкций и BE-SQL конструкций:

* chr(...) — CHR() или CHAR()
* concat(...) — CONCAT() или ||
* coalesce(...) — COALESCE() или IFNULL()
* round(...) — ROUND()
* length(...) — LENGTH() или LEN()
* lpad(...) — LPAD()
* replace(...) — REPLACE()
* substring(...) — SUBSTR() или SUBSTRING()
* if(...) — IF() (может транслироваться в предложение CASE WHEN ...)
* ?dateFormat — FORMAT_DATE()
* ?dateTimeFormat — FORMAT_DATETIME()
* ?dateFormatRus — FORMAT_DATE_RUS()
* ?asInt — CAST(x AS BIGINT), TO_NUMBER(x)
* ?asVarChar — CAST(x AS CHAR), CAST(x AS VARCHAR), TO_CHAR(x)
* ?asDate — CAST(x AS DATE), TO_DATE(x)
* ?asPK — CAST(x AS KEY), TO_KEY(x)
* ?lower — LOWER()
* ?upper — UPPER()
* ?monthStart — DATE_TRUNC('MONTH', x)
* ?yearStart — DATE_TRUNC('YEAR', x)
* ?year — YEAR(), EXTRACT(YEAR FROM x)
* ?month — MONTH(), EXTRACT(MONTH FROM x)
* ?day — DAY(), EXTRACT(DAY FROM x)
* ?indexOf — INSTR(string, subString) или POSITION(subString IN string)
* ?str — просто пишите в 'одинарных кавычках', экранируйте одинарную кавычку с помощью '\'
* ?quote — просто пишите в "двойных кавычках" или в `обратных кавычках`, оба варианта должны сработать и транслироваться при необходимости
* currentDateTime — CURRENT_TIMESTAMP или NOW()
* currentDate — CURRENT_DATE
* addMonths(date,mon) — ADD_MONTHS(date, mon)
* addDays(date, days) — ADD_DAYS(date, days)
* addMillis(date, ms) — ADD_MILLIS(date, ms)
* fromFakeTable — FROM DUAL или можно не писать FROM вообще

Для ограничения количества записей можно просто писать SELECT ... LIMIT 1: это транслируется в соответствующий диалект SQL.

=== Список всех поддерживаемых SQL-функций ===

В скобках указываются синонимы

CONCAT, COALESCE (IFNULL), COUNT, SUM, MAX, MIN, SUBSTR (SUBSTRING), LENGTH (LEN), UPPER, LOWER, CHR (CHAR), TO_CHAR, TO_NUMBER, TO_DATE, TO_KEY,
REPLACE, RTRIM, LTRIM, TRIM, LPAD, ROUND, TRUNC (TRUNCATE), INSTR (STRPOS), IF, NOW, FORMAT_DATE (=TO_CHAR(x, 'YYYY-MM-DD')), YEAR, MONTH, DAY,
FORMAT_DATETIME (=TO_CHAR(x, 'YYYY-MM-DD HH24:MI:SS')), FORMAT_DATE_RUS (=TO_CHAR(x, 'DD.MM.YYYY')), FORMAT_DATE_RUS_SHORT (=TO_CHAR(x, 'DD.MM.YY')),
FORMAT_MONTHYEAR(=TO_CHAR(x, 'month YYYY')), FORMAT_FMDAYMONTH, FORMAT_FMDAYMONTH, FORMAT_HOURMINUTE, FORMAT_DAY_OF_WEEK, FORMAT_YYYYMMDD,
FORMAT_YYYYMM, DATE_TRUNC, POSITION, DATE_ADD, ADD_MONTHS, ADD_DAYS, ADD_MILLIS, LAST_DAY, TIMESTAMPDIFF, YEARDIFF, MONTHDIFF, DAYDIFF, HOURDIFF,
MINUTEDIFF, SECONDDIFF, LEAST, GREATEST, GROUPING, ROW_NUMBER, RANK, RIGHT, LEFT, NULLIF, ABS, AVG, DECODE, TRANSLATE (DB2, Oracle, PostgreSQL),
REGEXP_LIKE (MySQL, Oracle, PostgreSLQ), REGEXP_REPLACE (DB2, Oracle, PostgreSQL), STRING_AGG (с поддержкой DISTINCT: MySQL, PostgreSQL; без: DB2, Oracle).

=== Функции для работы с датами и временем ===

==== Форматирование даты ====

Для форматирования даты в строку можно использовать <code>TO_CHAR(дата, <строка_формата>)</code> или <code>DATE_FORMAT(дата, <строка_формата>)</code>. Строка формата должна быть одной из предопределённых констант из списка, иначе будет ошибка:

* 'YYYY-MM-DD' или '%Y-%m-%d' (также можно использовать функцию FORMAT_DATE())
* 'YYYY-MM-DD HH24:MI:SS' или '%Y-%m-%d %H:%i:%S' (также можно использовать функцию FORMAT_DATETIME())
* 'DD.MM.YYYY' или '%d.%m.%Y' (также можно использовать функцию FORMAT_DATE_RUS())
* 'DD.MM.YY' или '%d.%m.%y' (также можно использовать функцию FORMAT_DATE_RUS_SHORT())
* 'month YYYY' или '%M %Y' (также можно использовать функцию FORMAT_MONTHYEAR())
* 'FMDD.MM' или '%e.%c' (режим заполнения, также можно использовать функцию FORMAT_FMDAYMONTH())
* 'DD.MM' или '%d.%m' (также можно использовать функцию FORMAT_DAYMONTH())
* 'HH24:MI' или '%H:%i' (также можно использовать функцию FORMAT_HOURMINUTE())
* 'YYYYMMDD' или '%Y%m%d' (также можно использовать функцию FORMAT_YYYYMMDD())
* 'YYYYMM' или '%Y%m' (также можно использовать функцию FORMAT_YYYYMM())
* 'D' или '%w' (также можно использовать функцию FORMAT_DAY_OF_WEEK())
* 'YYYY' или '%Y'
* 'MM' или '%m'
* 'DD' или '%d'

SELECT NOW(), FORMAT_DATE(NOW());

NOW FORMAT_DATE
----------------------- -----------
2016-03-04 11:12:38.360 2016-03-04

SELECT NOW(), FORMAT_DATETIME(NOW());

NOW FORMAT_DATETIME
----------------------- -------------------
2016-03-04 11:12:38.360 2016-03-04 11:12:38

SELECT NOW(), FORMAT_DATE_RUS(NOW());

NOW FORMAT_DATE_RUS
----------------------- ---------------
2016-03-04 11:12:38.360 04.03.2016

SELECT NOW(), FORMAT_DATE_RUS_SHORT(NOW());

NOW FORMAT_DATE_RUS_SHORT
----------------------- ---------------------
2016-03-04 11:12:38.360 04.03.16

SELECT TO_CHAR(NOW(), 'YYYY');
-> 2016

Для получения числа, месяца или года заданной даты в виде числа используются функции <code>DAY(дата)</code>, <code>MONTH(дата)</code> или <code>YEAR(дата)</code> соответственно:

SELECT YEAR(CURRENT_DATE);
-> 2016

Аналогично можно использовать <code>EXTRACT(YEAR FROM CURRENT_DATE)</code>.

==== Разница между датами ====

Для получения разницы между датами в годах, месяцах, днях, часах, минутах или секундах используются следующие функции:

* <code>YEARDIFF(startDate, endDate)</code> или <code>EXTRACT(YEAR FROM AGE(endDate, startDate))</code>
* <code>MONTHDIFF(startDate, endDate)</code> или <code>EXTRACT(MONTH FROM AGE(endDate, startDate)) + 12 * EXTRACT(YEAR FROM AGE(endDate, startDate))</code>
* <code>DAYDIFF(startDate, endDate)</code> или <code>EXTRACT(DAY FROM(endDate - startDate))</code>
* <code>HOURDIFF(startDate, endDate)</code> или <code>FLOOR(EXTRACT(EPOCH FROM(endDate - startDate)) / 3600)</code>
* <code>MINUTEDIFF(startDate, endDate)</code> или <code>FLOOR(EXTRACT(EPOCH FROM(endDate - startDate)) / 60)</code>
* <code>SECONDDIFF(startDate, endDate)</code> или <code>EXTRACT(EPOCH FROM(endDate - startDate))</code>

SELECT EXTRACT(YEAR FROM AGE('2015-05-01', '2013-02-01'));
-> 2

SELECT YEARDIFF('2013-02-01', '2015-05-01');
-> 2

SELECT MONTHDIFF('2013-02-01', '2015-05-01');
-> 27

Также можно использовать функцию <code>TIMESTAMPDIFF(<интервал>, startDate, endDate)</code>, где в качестве интервала должно быть YEAR, MONTH, DAY, HOUR, MINUTE или SECOND.

SELECT TIMESTAMPDIFF(DAY, '2016-01-01', '2017-01-01');
-> 366

SELECT TIMESTAMPDIFF(SECOND, '2016-01-01', '2016-01-02' );
-> 86400

==== Добавление интервала к дате ====

Для добавления к дате месяцев, дней или миллисекунд используются функции <code>ADD_MONTHS(дата, количество)</code>, <code>ADD_DAYS(дата, количество)</code>, <code>ADD_MILLIS(дата, количество)</code> соответственно:

SELECT CURRENT_DATE, ADD_MONTHS(CURRENT_DATE, 2);

CURRENT_DATE ADD_MONTHS
------------ ----------
2016-03-04 2016-05-04

SELECT CURRENT_DATE, ADD_DAYS(CURRENT_DATE, 7);

CURRENT_DATE ADD_DAYS
------------ ----------
2016-03-04 2016-03-11

SELECT NOW(), ADD_MILLIS(NOW(), 3000);

NOW ADD_MILLIS
----------------------- -----------------------
2016-03-04 11:12:38.360 2016-03-04 11:12:41.360

==== Последний день месяца ====

Для получения последнего дня месяца используется функция <code>LAST_DAY(дата)</code>:

SELECT CURRENT_DATE, LAST_DAY(CURRENT_DATE) "Last", LAST_DAY(CURRENT_DATE) - CURRENT_DATE "Days Left";

CURRENT_DATE Last Days Left
------------ ---------- ---------
2016-03-04 2016-03-31 27

=== Список всех поддерживаемых операций ===

+, -, *, /, >, <, >=, <=, = (или ==), != (или <>), || (конкатенация строк), OR, AND (или &&), NOT (или !), LIKE, FLOOR, MOD (или %),
& (побитовое и), | (побитовое или), ~ (соответствие регулярному выражению; MySQL, Oracle, PostgreSQL).

=== Что точно не работает пока ===

Использование этих возможностей скорее всего приведёт к ошибке валидации. В некоторых случаях к некорректному переформатированию в другом движке.

* BE-теги <if>/<unless> в некоторых нетривиальных местах. Так как в BE-SQL строится синтаксическое дерево, подобные теги нельзя размещать где угодно. Точно работает <if>/<unless> в следующих местах:
** В списке колонок (<code>SELECT a, <if ...>b,</if> c FROM table</code>)
** Для UNION SELECT (<code>SELECT a FROM table <if ...>UNION SELECT b FROM table</if></code>, а также <code><if ...>SELECT a FROM table UNION</if> SELECT b FROM table</code>)
** Для всего предложения FROM (<code>SELECT a <if ...>FROM table</if></code>)
** Для всего предложения WHERE (<code>SELECT a FROM table <if ...>WHERE b = c</if></code>)
** Для всего и в списке колонок внутри GROUP BY (<code>SELECT * FROM table GROUP BY a,<if ...>b, c,</if> d</code>)
** Для всего и в списке колонок внутри ORDER BY (<code>SELECT * FROM table ORDER BY a DESC <if ...>, b, c</if>, d</code>)
** Для одной (не самой первой) из веток CASE WHEN (<code>SELECT CASE WHEN x > 5 THEN 'a' <if ...>WHEN x > 10 THEN 'b'</if>ELSE 'c' END FROM table</code>)
** Для одного или нескольких предложений JOIN (<code>SELECT a FROM table <if ...>JOIN table2 ON (...) JOIN table3 ON (...)</if></code>)
** Для фрагмента булевого выражения, начинающегося с AND или OR (<code>SELECT a FROM table WHERE x > 2 <if ...>AND y > 3</if><if ...>OR z > 4</if></code>)
** Для фрагмента конкатенации строк через ||, начинающегося с || (<code>SELECT a || b <if ...>|| c || d</if> || e</code>)
** Для простого выражения, обязательно с альтернативой (<code>SELECT a FROM table WHERE x > <if ...>5<else>6</if></code>)
** Внутри строкового литерала (<code>'<a href="/test?<if parameter='xyz'>xyz=true&</if>abc=true">'</code>)
* genericRef, joinGenericRef

=== Создание макросов ===

Предусмотрена возможность создания собственных макросов. Определение макроса начинается с <code>MACRO</code>. За ним идет имя макроса и список аргументов в скобках, который может состоять из обязательных и следующих за ними аргументов с заданным по умолчанию значением. В случае отсутствия аргументов скобки нужно оставить пустыми. Далее следуют выражения, которые будут подставляться при вызове макроса, в их числе могут быть другие макросы, подстановки параметров, условные выражения. Заканчивается определение ключевым словом <code>END</code>.

MACRO MY_MACRO(arg1, arg2='000000')
CONCAT(SUBSTR(arg1, 1, 5 ), arg2)
END

Вызываются макросы как обычные функции:

SELECT MY_MACRO(code) FROM table t;

Такой запрос будет преобразован в <code>SELECT CONCAT(SUBSTR(code, 1, 5 ), '000000') FROM table t</code>.

=== Определение СУБД-специфичных функций ===

Определение СУБД-специфичных функций начинается с <code>DBMS_TRANSFORM</code>. За ним идет название функции и список аргументов в скобках. В случае отсутствия аргументов скобки необходимо оставить пустыми. Далее следует выражение <code>CASE</code>, в котором в блоках <code>WHEN</code> перечисляются СУБД, а в блоках <code>THEN</code> указывается возвращаемое выражение при трансляции в соответствующую СУБД. Это выражение может содержать функции, которые не были определены ранее, однако это не сделает возможным их дальнейшее использование вне трансляции. Если функцию необходимо транслировать как есть, после <code>THEN</code> указывается <code>AS IS</code>. В блоке <code>WHEN</code> ожидаются названия из списка: <code>'db2'</code>, <code>'mysql'</code>, <code>'oracle'</code>, <code>'postgres'</code>, <code>'sqlserver'</code>. Если СУБД, в которую необходимо выполнить трансляцию функции, отсутствует во всех условиях <code>WHEN</code>, произойдет ошибка. Заканчивается определение ключевым словом <code>END</code>.

DBMS_TRANSFORM LPAD(str, size, fill)
CASE WHEN 'postgres', 'oracle', 'mysql', 'db2' THEN AS IS
WHEN 'sqlserver' THEN RIGHT(REPLICATE(fill, size) + str, size)
END

Запрос <code>SELECT LPAD('lpad', 8, '0') FROM table t</code> для DB2, MySQL, Oracle и PostgreSQL сохранит свой вид, а при трансляции в Microsoft SQL Server будет преобразован в <code>SELECT RIGHT(REPLICATE('0', 8) + 'lpad', 8)</code> FROM table t.

Icon

2015-10-26T05:10:32Z

Lan: Иконки теперь в BeanExplorer

{{DISPLAYTITLE:Иконки}}
Иконки можно задавать для [[Entity|сущностей]], [[Query|представлений]] и [[Operation|операций]], чтобы они отображались в пользовательском интерфейсе (в меню или на кнопках операций). Иконки задаются в виде ссылки на файл. Поддерживаются форматы png и gif. Есть два варианта:

* Ссылка вида <code>be:имя_файла</code> (например, <code>be:question.gif</code>): файл ищется в каталоге <code>BeanExplorer/src/html/icons</code>.

* Ссылка вида <code>project:имя_файла</code> (например, <code>project:myicon.gif</code>): файл ищется в каталоге проекта, по умолчанию в подкаталоге <code>src/icons</code> (можно поменять через [[ProjectFileStructure|кастомизацию структуры проекта]]).

ColumnDef

2015-10-22T07:05:30Z

Lan: /* Примеры YAML */

{{ElementType|com.beanexplorer.enterprise.metadata.model.ColumnDef|да|да}}

'''Определение колонки''' (ColumnDef) — это модельный объект, соответствующий колонке в базе данных. Обладает следующими свойствами:

* '''name''' — имя колонки. В некоторых движках регистр имеет значение, в некоторых нет. Две колонки не могут отличаться только регистром.
* '''type''' — [[Типы_колонок|тип колонки]].
* '''canBeNull''' — логическое значение, может ли колонка хранить NULL-значения (по умолчанию — нет).
* '''primaryKey''' — логическое значение, является ли колонка первичным ключом.
* '''oldNames''' — список старых имён колонки. Если колонка когда-то была переименована, разумно указать здесь старое имя. Тогда при обновлении DDL BeanExplorer сгенерирует запрос на переименование колонки без потери данных. Если старое имя не указать, то старая колонка будет удалена и создана новая, что может привести к потере данных.
* '''defaultValue''' — значение по умолчанию.
* '''reference''' — ссылка, если колонка является [[TableRef|ссылкой на ключ в другой таблице]]:
** Либо просто имя целевой таблицы (ссылка на первичный ключ). Не рекомендуется использовать при ссылках на таблицы, определённые в m4!
** Либо <code><имя таблицы>.<имя колонки></code>: явное задание целевой колонки
** Либо список таблиц для generic-ссылки.
** Либо совокупность двух полей: '''to''' — сама ссылка (с указанием колонки или нет), '''view''' — имя selection view.
*: Для колонки-ссылки можно не указывать тип, если целевая таблица определена в be4-проекте, либо это generic-ссылка. В таких случаях тип колонки будет определён автоматически.

== Примеры YAML ==

Текстовая колонка длиной до 30 символов, являющаяся первичным ключом:

- CODE:
type: VARCHAR(30)
primaryKey: true

Колонка перечислимого типа со значением по умолчанию (обратите внимание, надо брать значение по умолчанию в тройные кавычки):

- type:
type: ENUM('import','export')
defaultValue: <nowiki>'''import'''</nowiki>

Колонка с датой и значением по умолчанию — текущая дата:

- purchaseDate:
type: DATE
defaultValue: NOW()

Текстовая колонка максимальной длины 255 символов, допускающая значения NULL:

- comments:
type: VARCHAR(255)
canBeNull: true

Колонка-ссылка на первичный ключ другой таблицы:

- companyID:
reference: companies

Колонка-ссылка с явным указанием selection view:

- munCode:
reference:
to: munExchangeTypes.munCode
view: 'MunCode view'

Колонка с generic-ссылкой и документацией:

- ownerID:
doc: владелец счета
reference:
to:
- companies
- persons
view: <nowiki>''</nowiki>

Entity

2015-10-22T06:31:16Z

Lan: +icon

{{ElementType|com.beanexplorer.enterprise.metadata.model.Entity|да|да}}

'''Сущность''' (Entity) представляет собой SQL-таблицу, либо фиктивную таблицу, предназначенную для создания пунктов меню. Каждая сущность относится к одному из [[Module|модулей]]. Сущность имеет следующие свойства:

* '''name''' — имя. Соответствует имени SQL-таблицы и используется внутри модели для ссылок на данную сущность.
* '''icon''' — ссылка на [[icon|иконку]] для отображения в меню.
* '''type''' — тип сущности. Имеется пять типов:
** table — обычная таблица
** collection — коллекция
** genericCollection — обобщённая коллекция
** dictionary — справочник
** metadata — таблица с метаданными (используется только для внутренних таблиц BeanExplorer
* '''displayName''' — отображаемое имя. Имя сущности, которое выводится в пользовательском интерфейсе. Может быть дополнительно изменено через локализации.
* '''order''' — двузначное число, задающее порядок сущности в меню (чем больше, тем ниже сущность располагается в меню).
* '''primaryKey''' — первичный ключ таблицы (для фиктивных сущностей обычно используется _dummy_)

В определение сущности входит [[TableDef|схема]], [[Operation|операции]] и [[Query|представления]]. Также есть возможность использовать [[Entity template|шаблон для сущности]].

Пример простой фиктивной сущности в Yaml:

_myMenuItem_:
type: table
displayName: Основное меню
order: '29'
primaryKey: _dummy_
queries:
- Главная таблица:
type: static
roles: [Operator,PaymentOperator,ServiceOperator,Reception]
value: 'myTable.redir'

Пример сущности-справочника с представлением Selection view и без операций:

myDictionary:
type: table
displayName: Мой справочник
primaryKey: CODE
scheme:
columns:
- CODE:
type: VARCHAR(30)
primaryKey: true
- name:
type: VARCHAR(255)
queries:
- '*** Selection view ***':
code: SELECT CODE AS "Code", name AS "Name" FROM myDictionary

Entity template

2015-10-21T10:43:17Z

Lan: Новая страница: «Шаблон для сущности упрощает создание похожих сущностей, позволяя наследовать не…»

Шаблон для [[entity|сущности]] упрощает создание похожих сущностей, позволяя наследовать неизменённые свойства из шаблона. Шаблоны размещаются вот здесь:

/be4/src/com/beanexplorer/enterprise/metadata/model/templates/

Сохраняются в обычных yaml-файлах, как сущности. Но следует помнить, что имя шаблона не совпадает с именем реальной сущности. Поэтому в тексте запросов надо использовать Freemarker-выражения для обращения к текущей сущности. Например, так:

SELECT ${entity.primaryKey} AS "Code", name AS "Name" FROM ${entity.name}

Для создания нового шаблона надо расположить его в том же каталоге и зарегистрировать в списке {{Method|com.beanexplorer.enterprise.metadata.model.Templates.TEMPLATES}}. При создании или изменении шаблона следует прогнать юнит-тест {{Class|com.beanexplorer.enterprise.metadata._test.TemplatesTest}}. Если упал, скорее всего написан некорректный yaml.

Для использования шаблона необходимо при описании сущности указать <code>template: <имя шаблона></code>. Затем переопределять то, чего в шаблоне не хватает. Пример есть в модуле financial:

/beclipse/modules/financial/src/meta/entities/intangibleTypes.yaml

На текущий момент в шаблоне никак не задать группу ролей. Отдельные роли можно, а группы придётся определять в самой сущности. Также пока недоделано сохранение сущности, содержащей ссылку на шаблон (будет сделано).

Использовать шаблон можно только для сущностей, определённых в текущем проекте (в meta/entities). Нельзя задавать шаблон в meta/modules, так как сущности оттуда уже кастомизируют сущность из соответствующего модуля и не могут одновременно наследовать шаблон.

BeConnectionProfile

2015-08-20T09:15:48Z

Lan: +ask

{{ElementType|com.beanexplorer.enterprise.metadata.model.BeConnectionProfile|да}}

Профиль соединения (connection profile) — совокупность настроек, описывающих отдельную доступ к базе данных и инсталляцию be4-приложения. Содержит следующую информацию:

* '''connectionUrl''': URL соединения к базе данных (например: jdbc:postgresql://localhost:5432/mydb)
* '''username''': имя пользователя для доступа к базе данных (например: user)
* '''password''': пароль для доступа к базе данных
* '''tomcatPath''': путь к инсталляции Tomcat на локальной системе
* '''tomcatAppName''': имя приложения в Tomcat (имя war-файла). По умолчанию совпадает с названием [[Project|проекта]].
* '''tomcatManagerScriptUserName'''/'''tomcatManagerScriptPassword''': имя и пароль для управления удалённой перезагрузкой Tomcat-приложения
* '''tomcatManagerReloadUrlTemplate''': путь для выполнения удалённой перезагрузки Tomcat-приложения (пример: <code><nowiki>http://localhost:8080/manager/text/reload?path=/{projectName}</nowiki></code>)
* '''protected''': если true, то профиль считается защищённым. При попытках работать с ним могут запрашиваться дополнительные подтверждения
* '''properties''': произвольные текстовые свойства (имя-значение). При работе через ant они доступны в переменных ant. Таким образом можно сконфигурировать дополнительно любые специфичные для данной инсталляции вещи (настройки контекста и т. д.). Также эти свойства доступны во Freemarker-скриптах и при задании [[extras]].
* '''ask''': список элементов, которые необходимо запросить с командной строки при использовании профайла. Помимо вышеупомянутых (например, <code>tomcatAppName</code>) можно использовать <code>properties/<имя свойства></code> для запроса пользовательского свойства, а также детальные параметры jdbcUrl: <code>jdbcUrl/host</code>, <code>jdbcUrl/db</code>, <code>jdbcUrl/properties/SID</code> и т. д.

Пример задания профиля в [[yaml]]:

connectionProfiles:
profiles:
condo:
connectionUrl: jdbc:postgresql://localhost:5432/condo
username: condo
password: condo
protected: true
tomcatPath: C:/apache-tomcat-7.0.52/webapps
tomcatAppName: condo
tomcatManagerScriptUserName: tomcat
tomcatManagerScriptPassword: tomcat
tomcatManagerReloadUrlTemplate: http://localhost:8080/manager/text/reload?path=/condo
properties:
- INITIAL_SIZE: '30'
- MAX_ACTIVE: '2000'
- MIN_IDLE: '1'
- MAX_IDLE: '20'

Для разработчиков BE4

2014-12-05T05:04:18Z

Asko: /* Автосериализация */

Здесь будет информация по архитектуре BE4.

На высоком уровне BE4 состоит из нескольких частей:
* '''com.beanexplorer.enterprise.metadata*''' - ядро;
* com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse;
* com.beanexplorer.enterprise.be4core - класс Be4QueryExecutor, необходимый для запуска Query относительно простым образом без необходимости хранить Query в таблице (в BE3 запуск Query происходит по имени или идентификатору Query в таблице queries, а мы в BE4 работаем только с модельными объектами представленными в виде Java объектов, а не строк в SQL таблицах); используется для запуска Query в BEeclipse и BE5;
* com.beanexplorer.enterprise.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;
* com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));
* com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы;
* com.beanexplorer.enterprise.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].

== Ядро ==
* '''com.beanexplorer.enterprise.metadata*''' - ядро.
** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].
** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].
** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных.
** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML.
** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.
*** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.
** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI

== UI ==
Поскольку BEclipse - это плагин для Eclipse, UI реализован классическим способом для Eclipse плагинов. А именно:
* весь основной функционал описан в plugin.xml,
** это могут быть меню, команды, view, редакторы, wizard, страницы настроек и прочее. Для просмотра всего фунционала открываем plugin.xml на странице "Extensions".

=== Команды ===
Для создания команды неоходимо зарегистрировать два расширения:
* org.eclipse.ui.commands
* org.eclipse.ui.handlers
Дело в том, что в Eclipse одна и та же команда может быть запущена разными обработчиками, так что команда разделена на две части - собственно command, представляет собой абстрактную команду с именем и описанием, и handler - обработчик, ссылается на класс, реализующий функционал этой команды и указывающий, может ли он в данный момент обработать действие. Например, в Eclipse есть стандартная команда "Debug". В разных контекстах её обрабатывает разный обработчик - Java код запускается одним способом, а C++ код другим. При этом кнопка на панели инструментов и биндинг постоянно F11 ссылаются на одно и то же действие.

Наши обработчики команд лежат в com.beanexplorer.enterprise.eclipse.handlers и имеют названия, представляющие собой глаголы.

Так что для создания новой команды
* кликаем на org.eclipse.ui.commands в нашем редакторе plugin.xml на вкладке Extensions, New -> command, даём уникальный идентификатор, читаемое имя и категорию (categoryId) com.beanexplorer.be4.ui.commands,
* кликаем на org.eclipse.ui.handlers , New -> handler, выбираем только что созданную команду и новый класс из com.beanexplorer.enterprise.eclipse.handlers.

=== Меню ===
Это расширение org.eclipse.ui.menus (New -> menuContribution). Общий вид ссылки на меню (locationURI):
* [menu|popup|toolbar]:<menuOrPartName>[?after=additions]
Здесь "menu", "popup", "toolbar" - предопределённые строки. <menuOrPartName> - либо "известное" имя типа org.eclipse.ui.main.menu или org.eclipse.ui.main.toolbar, либо имя редактора или view типа com.beanexplorer.enterprise.eclipse.BeProjectView.

popup:com.beanexplorer.enterprise.eclipse.BeProjectView - это, в частности, контекстное меню нашего дерева проекта. Для добавления в него новой команды кликаем на надпись "popup:com.beanexplorer.enterprise.eclipse.BeProjectView" (слева в дереве), New -> command, выбираем команды, указываем текст и выбираем иконку. Готово!

==== Замечание ====
Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.

=== Редакторы и view ===
Хранятся в
* com.beanexplorer.enterprise.eclipse.editors и
* com.beanexplorer.enterprise.eclipse.views соответственно.
Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -> editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку "class" позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).

=== Готовые диалоговые окна ===
com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.

=== MVVM и упрощение написания UI ===
Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.

Хорошей практикой являет написание UI с использованием шаблона проектирования MVVM. Пример - CreateDaemonWizard.CreateDaemonWizardPage из CreateDaemon. Это хороший пример с использованием MVVM и моментальной валидацией ввода пользовательских данных, который полагается на класс Ui из com.beanexplorer.enterprise.eclipse.jface. Другие примеры можно найти поискав использования Ui.SimpleBinding<T>.addToWizardPage (Ctrl+Shift+G) или других методов Ui.SimpleBinding<T>.

Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов).

Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).

=== События ===

==== Автосериализация ====
Начинать смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируются события разные события "codeChanged(SomeClass)" - в конечном счёте они вызывают Serialization.save(SomeClass).

==== Автодесериализация ====
Начинасть смотреть с BeanExplorerProjectProvider.setProject - здесь регистрируется "onModify" (статическая функция ON_MODIFY). ON_MODIFY.apply(Path) определяет по пути тип файла и десериализует его. При открытии проекта путь файла регистрируется через project.getAutomaticDeserializationService().registerFile(Path, Type). WatchDir же слушает изменения в файловой системе и отправляет их в onModify.

==== Другие события ====
См. различные BeanExplorerProjectProvider.registerLocal(ConcreteListener, Composite). Замечу, что structural change - полезное событие для того, чтобы обновить UI, если изменилось дерево модельных объектов. Изменени модельных объектов не вызывает автоматического перерисования UI - у нас нет такого вида событий!

=== Действия и возможности ===

==== Сохранение и открытие проекта ====
BeanExplorerProjectSource - простейший фасад для сохранения и открытия проекта из YAML.

LegacyBeanExplorerProjectImporter - предоставляет возможность открывать BE3 проект из базы данных.

==== JavaScript отладчик ====
com.beanexplorer.enterprise.eclipse.javascript.RunJavaScriptOperationImpl и DebugJavaScriptOperationImpl - основные классы реализации.

==== Запуск Query ====
Основывается на Be4QueryExecutor из com.beanexplorer.enterprise.be4core. См. класс "RunQuery" в качестве примера.

==== Data Tools Platform: Connection Profiles ====
com.beanexplorer.enterprise.eclipse.model.ConnectionProfiles позволяет преобразовывать наши модельные настройки в DTP connection profile и наоборот.

==== Поиск в Project View ====
com.beanexplorer.enterprise.eclipse.jface.DataElementsFilter

==== Иконки и подсказки в Project View ====
com.beanexplorer.enterprise.eclipse.views.BeanExplorerProjectViewLabelProvider - вычисляет иконки, рисует простые подсказки и делегирует сложные tooltip'ы (в виде таблиц с ошибками) классу FancyToolTipSupport из того же пакета.

==== Сохранение состояния view ====
См. в качестве примера BeanExplorerProjectView.saveState (простейшие примеры - сохранение имени открытого проекта и выделенного элемента) и BeanExplorerProjectView.init (загрузка).

==== Настройки ====
См. BeanExplorerPreferencesPage.createFieldEditors и BeanExplorerPreferences из com.beanexplorer.enterprise.eclipse.preferences.BeanExplorerPreferencesPage.

==== Фоновые процессы ====
Запуск - new Job("name") { implementation }.schedule(). "Подождать" - пример в BeanExplorerProjectProvider.waitForSynchronization, "отменить" - пример в BeanExplorerProjectSource.cancelOpening. Замечу, что любые действия с UI должны делаться в UI потоке, поэтому для запуска кода в UI потоке из Job можно использовать:
* UiFunction.async(function) - оборачивает функцию;
* new AbstractUiSyncFunction<A, R>() { implementation }.apply(arg);
* EclipseUtils.runInUiThread(runnable) или EclipseUtils.runInUiThread(supplier) - асинхронный и синхронный запуск соответственно.
Подолнительно в EclipseUtils имеются методы для показа окошек с ошибками и предупреждениями из не UI потоков (типа openErrorByNonUiThread).

==== Утилиты Eclipse ====
EclispeUtils содержит множество полезных методов, относящихся только к Eclipse UI:
* открытие или создание Java класса;
* создание проектов;
* открытие редакторов, view или wizard по идентификатору;
* копирование в буфер обмена;
* получение содержимого редакторов;
* сохранение открытых редакторов.
=== Статьи по SWT ===
[http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.

А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.

Подключение скриптов

2014-10-09T10:32:32Z

Lan:

Для подключения скриптов во [[Freemarker]]'е используется директива #include. В BeanExplorer4 включен собственный загрузчик скриптов, который загружает их из [[структура проекта|дерева проекта]]. Соответственно путь вам надо писать относительно текущего скрипта в дереве. Например, для подключения скрипта в той же папке надо написать просто его имя (без расширения .ftl, так как в дереве проекта расширений нет). Для подключения макросов из модуля можно написать, например, так (учитывая, что текущий скрипт находится в myproject/application/Scripts):

<#include "../../Modules/realty/Macros/somemodulemacros"/>

Заметьте, что скрипт common.ftl из каждого доступного модуля подключается автоматически.

Если подключаемый скрипт отсутствует, вы получите ошибку выполнения Freemarker. Иногда требуется игнорировать отсутствие скрипта. Тогда можно подписать к пути скрипта :optional. Например, так можно подключить специфичные для региона словари, если они есть:

<#if REGION??>
<#include '${REGION}/dictionaries:optional'>
</#if>

[[Категория:Freemarker]]

Documentation

2014-09-19T10:02:27Z

Lan: Lan переименовал страницу Documentation в Документация без оставления перенаправления: По-русски

[[Файл:DocumentationEditing.png|thumb|Редактирование документации]]
[[:Категория:Элементы с поддержкой документации|Многие элементы]] в [[Структура проекта|дереве проекта]] поддерживают документацию: вы можете написать произвольный сопроводительный текст. В интерфейсе для этого есть вкладка Documentation: достаточно выделить в дереве проекта элемент, который вы хотите документировать, и написать текст во вкладке.

Помимо просто текста можно автоматически создавать задачи, если написать в документации <code>@todo</code>, <code>@check</code> или <code>@pending</code>. Текст после этой метки автоматически попадёт в [[Tasks|список задач]] проекта.

Документация сериализуется в [[yaml]]-элемент doc внутри соответствующего родительского элемента.

TableRef

2014-09-19T09:12:28Z

Lan:

{{ElementType|com.beanexplorer.enterprise.metadata.model.TableRef|нет|да}}

'''Ссылка на ключ в другой таблице''' (TableRef) позволяет устанавливать вспомогательные связи между таблицами, которые могут использоваться [[Operation|операциями]], например, для заполнения выпадающих списков. Связь имеет следующие свойства:

* tableFrom: исходная сущность. Это та [[Entity|сущность]], в которой связь объявлена.
* columnFrom: исходная колонка. В данном случае это псевдо-колонка (например, kladr::search::street). Если вы хотите установить связь к существующей колонке, это необходимо сделать непосредственно в [[ColumnDef|определении колонки]].
* tableTo: целевая сущность.
* columnTo: целевая колонка. Может быть не указана, тогда автоматически используется первичный ключ целевой сущности.
* view: имя [[Query|представления]] в целевой сущности, которое используется для выбора элементов. По умолчанию — *** Selection view ***.

Ссылки располагаются в дереве проекта в папке References внутри сущности. Имя ссылки формируется автоматически по имени колонки и целевой сущности.

Ссылки сериализуются в [[yaml]]-файл сущности в секцию references. В качестве ключа указывается columnFrom. Свойства tableTo и columnTo сериализуются в одно поле to через точку. Если кроме поля to ничего нет, можно имя поля опустить.

=== Примеры ===
users:
references:
kladr::search::city:
to: addresses.dummy
view: City from KLADR
Здесь создаётся ссылка с tableFrom = users, columnFrom = kladr::search::city, tableTo = addresses, columnTo = dummy, view = City from KLADR (такое представление должно существовать в сущности addresses, иначе будет предупреждение при [[синхронизация|синхронизации]]).

buildings:
references:
buildingID: buildings
Здесь создаётся ссылка с tableFrom = buildings, columnFrom = buildingID, tableTo = buildings, columnTo = ID (первичный ключ у таблицы buildings), view = *** Selection view *** (по умолчанию).

Yaml

2014-09-19T08:44:34Z

Lan: Новая страница: «{{Stub}} '''Yaml''' — основной формат структурированных данных, который используется в [[BeanExplorer4]…»

{{Stub}}
'''Yaml''' — основной формат структурированных данных, который используется в [[BeanExplorer4]].

Дополнительная информация по Yaml здесь:
* http://ru.wikipedia.org/wiki/YAML
* http://www.yaml.org/

Для работы с Yaml в BeanExplorer4 используется библиотека [https://code.google.com/p/snakeyaml/ SnakeYaml]

LanguageLocalizations

2014-09-19T08:40:33Z

Lan: +пример

{{Stub}}
{{ElementType|com.beanexplorer.enterprise.metadata.model.LanguageLocalizations|да}}
'''Локализации для языка''' — папка, расположенная внутри папки [[Localizations|Localization]], которая содержит локализованные сообщения для конкретного языка. Имя папки — двухбуквенный код [https://ru.wikipedia.org/wiki/ISO_639-1 ISO 639-1], обозначающий язык (например, ru для русского). Дочерние элементы — [[EntityLocalizations|локализации для сущностей]].

Локализация для каждого языка сериализуется в отдельный [[yaml]]-файл по умолчанию в папке src/l10n. На верхнем уровне содержится секция документации (doc) и секция сущностей (entities), в которую сериализуются локализации для сущностей. Пример:
ru:
doc: |-
Локализованные сообщения для русского языка
@TODO: навести порядок
entities:
- algorithmDetails:
- topics: All records
entries:
- Algorithm: Алгоритм
- categories:
- topics:
- '*** Selection view ***'
- All records
entries:
- Type: Тип

Типы колонок

2014-09-19T08:28:18Z

Fedor:

=> github/be5 +

В BeanExplorer4 определены типы [[ColumnDef|колонок]] таблиц, независимые от движка СУБД. В коде тип колонок хранится в классе {{Class|com.beanexplorer.enterprise.metadata.model.SqlColumnType}}. У типа всегда есть строковое представление. Имеются следующие типы:
* KEYTYPE — тип, который используется по умолчанию для первичного ключа таблицы (обычно совпадает с BIGINT).
* Текстовые:
:* CHAR — строка фиксированной длины. Длина задаётся в скобках. Например: CHAR(10).
:* VARCHAR — строка произвольной длины вплоть до заданной. Длина задаётся в скобках. Например: VARCHAR(15).
:* TEXT — большое текстовое поле (не меньше 4000 символов).
:* BIGTEXT — очень большое текстовое поле {{TODO|уточнить минимальную длину}}.
* Двоичные:
:* BLOB — бинарные данные {{TODO|уточнить минимальную длину}}.
:* MEDIUMBLOB — бинарные данные {{TODO|уточнить минимальную длину}}.
* Численные:
:* INT — целое знаковое число (минимум 32-битное).
:* INT UNSIGNED — целое беззнаковое число (минимум 32-битное). Поддерживается не всеми движками.
:* BIGINT — целое знаковое число (минимум 64-битное).
:* BIGINT UNSIGNED — целое беззнаковое число (минимум 64-битное). Поддерживается не всеми движками.
:* SMALLINT — целое знаковое число (минимум 16-битное).
:* DECIMAL — дробное число указанной длины с указанной точностью (количество десятичных знаков). Например DECIMAL(10,2).
:* CURRENCY — валюта. Сейчас совпадает с DECIMAL(18,2).
* Дата и время:
:* DATE — дата.
:* DATETIME — дата и время.
:* TIMESTAMP — дата и время. Совпадает с DATETIME во всех движках кроме MySQL. Подробнее тут: [http://habrahabr.ru/post/61391/ Datetime или timestamp].
* Перечислимые:
:* ENUM — перечисление допустимых значений. Например ENUM(on,off,pending)
:* BOOL — допустимо два значения — 'no' и 'yes' (совпадает с ENUM(no,yes))

=== Сопоставление типов колонок ===

{| border="1" style="border-collapse: collapse; text-align: center;"
||'''Тип BE4'''
||'''MySQL'''
||'''PostGres'''
||'''DB2'''
||'''MS SQL 2008'''
||'''Oracle'''
|-
|'''BLOB'''
|rowspan="2"|MEDIUMBLOB
|rowspan="2"|BYTEA
|BLOB(4M)
|rowspan="2"|IMAGE
|BLOB
|-
|'''MEDIUMBLOB'''
|BLOB(16M)
|MEDIUMBLOB
|-
|'''TEXT'''
|colspan="2" rowspan="2"|TEXT
|CLOB(64K)
|rowspan="2"|VARCHAR(MAX)
|VARCHAR2(4000 CHAR)
|-
|'''BIGTEXT'''
|CLOB(128K)
|CLOB
|-
|'''VARCHAR'''
|VARCHAR
(если размер >255, то TEXT)
|colspan="3"|VARCHAR
|VARCHAR2
|-
|'''CHAR'''
|colspan="5"|CHAR
|-
|'''KEYTYPE'''
|BIGINT UNSIGNED
|colspan="3"|BIGINT
|VARCHAR2(15 CHAR)
|-
|'''INT'''
|INT
|rowspan="2" colspan="3"|INT
|rowspan="2"|NUMBER(10)
|-
|'''INT UNSIGNED'''
|INT UNSIGNED
|-
|'''BIGINT'''
|BIGINT
|rowspan="2" colspan="3"|BIGINT
|rowspan="2"|NUMBER(20)
|-
|'''BIGINT UNSIGNED'''
|BIGINT UNSIGNED
|-
|'''SMALLINT'''
|colspan="4"|SMALLINT
|NUMBER(5)
|-
|'''DECIMAL'''
|colspan="4"|DECIMAL
|NUMBER
|-
|'''CURRENCY'''
|colspan="4"|DECIMAL(18,2)
|NUMBER(18,2)
|-
|'''DATE'''
|colspan="5"|DATE
|-
|'''DATETIME'''
|DATETIME
|rowspan="2" colspan="2"|TIMESTAMP
|rowspan="2"|DATETIME
|rowspan="2"|TIMESTAMP
|-
|'''TIMESTAMP'''
|TIMESTAMP
|-
|'''ENUM'''
|ENUM
|rowspan="2" colspan="3"|VARCHAR + CONSTRAINT
|rowspan="2"|VARCHAR2 + CONSTRAINT
|-
|'''BOOL'''
|ENUM('no','yes')
|}

StaticPage

2014-09-17T04:58:39Z

Lan: Новая страница: «{{ElementType|com.beanexplorer.enterprise.metadata.model.StaticPage|нет}} Статическая страница (static page) — предопределён…»

{{ElementType|com.beanexplorer.enterprise.metadata.model.StaticPage|нет}}
Статическая страница (static page) — предопределённая HTML-страница с заданным именем. Для каждого языка локализации может быть свой вариант страницы с данным именем. По соглашению принято добавлять к именам статических страниц суффикс .be. По умолчанию статические страницы сериализуются в файл pages.yaml. Если указать статической странице имя файла, то её содержимое будет сериализовано в отдельный файл (по умолчанию в каталоге src/pages). Статических страниц не может быть в проекте-модуле.

Для отображения статической страницы надо создать в дереве статическое [[Query|представление]], указав имя статической страницы в качестве кода.

=== Пример файла pages.yaml ===
pages:
ru:
emailVerified.be:
file: emailVerified.html
welcome.be: |2
<h2>Добро пожаловать в наше приложение!</h2>

Страница emailVerified.be подгрузится из внешнего файла src/pages/emailVerified.be, а текст страницы welcome.be размещён непосредственно в pages.yaml.

IndexDef

2014-09-16T09:30:13Z

Lan:

{{ElementType|com.beanexplorer.enterprise.metadata.model.IndexDef|да|да}}
'''Индекс''' (IndexDef) — это определение индекса для таблицы в базе данных. Элементы IndexDef расположены внутри [[TableDef|определения таблицы]] в папке Indices. У индекса есть имя, признак уникальности (unique) и набор [[IndexColumnDef|колонок]] (как минимум одна), которые отображаются в дереве [[Project|проекта]] как дочерние элементы.

Длина имени индекса ограничена 30 символами, но обратите внимание, что в DB2 не удастся создать индекс с именем длиннее 18 символов. Также обратите внимание, что не все СУБД поддерживают функциональные индексы (смотрите [[IndexColumnDef|определение колонки индекса]]).

Любые изменения индексов (включая удаление) считаются неопасными, поэтому выполняются без предупреждения при [[Синхронизация|синхронизации]] со структурой. Любое изменение индекса при синхронизации приведёт к его уничтожению и повторному созданию.

Определения индексов записывается в [[yaml]]-файле [[Entity|представления]] в секции indices внутри секции scheme. Примеры:

buildings:
scheme:
...
indices:
- IDX_BUID_ID_KLADRCODE:
unique: true
columns:
- ID
- kladrStreetCode
extras: kladr
- IDX_BUILD_KLADR:
columns: kladrStreetCode
extras: kladr
doc: значения могут быть не уникальны
- IDX_BUILDINGS_NWK:
unique: true
columns:
- buildingNo
- lower(wing)
- lower(letters)
- kladrStreetCode
extras: kladr
doc: функциональный индекс с уникальными значениями

IndexColumnDef

2014-09-16T08:20:19Z

Lan: Новая страница: «{{ElementType|com.beanexplorer.enterprise.metadata.model.IndexColumnDef|нет}} '''Колонка индекса''' — дочерний элемент IndexDe…»

{{ElementType|com.beanexplorer.enterprise.metadata.model.IndexColumnDef|нет}}
'''Колонка индекса''' — дочерний элемент [[IndexDef|индекса]]. Имя элемента — имя колонки, по которой выполняется индексирование. Также может содержать описание дополнительного преобразования. Поддерживаются следующие преобразования:

* upper: в индекс будет внесено содержимое колонки в верхнем регистре
* lower: в индекс будет внесено содержимое колонки в нижнем регистре
* generic: к содержимому колонки слева будет подписано имя таблицы и точка (для индексирования по ключу таблиц, на которые имеются generic-ссылки)

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

Колонка индекса сериализуется просто. Если преобразования нет, то это имя колонки. Если есть преобразование, пишется его имя, затем в скобках имя колонки. Например:
indices:
- IDX_OCCUP_ID_CONCAT:
unique: true
columns: generic(ID)

или

indices:
- IDX_BUILDINGS_NWK:
unique: true
columns:
- buildingNo
- lower(wing)
- lower(letters)
- kladrStreetCode
extras: kladr

Разумеется, порядок колонок в индексе имеет значение.

Daemon

2014-09-11T07:53:16Z

Lan:

{{ElementType|com.beanexplorer.enterprise.metadata.model.Daemon|да|да}}

Демон (Daemon) — фоновый процесс BeanExplorer. Вы можете определять своих демонов как в [[Project|проекте]], так и в [[Module|модулях]].

Демон имеет следующие свойства:
;Имя
:уникальное имя демона. Если хочется запустить несколько одинаковых демонов, имена всё равно должны быть разными.
;Класс (className)
:полное имя класса демона (должен наследовать {{Class|com.beanexplorer.enterprise.process.Daemon}})
;Секция конфигурации (configSection)
:Имя секции в таблице [[systemSettings]], которая будет по умолчанию относиться к демону. Чтобы достать настройки из этой секции, используйте метод {{Method|com.beanexplorer.enterprise.process.Daemon.getSetting(String)}}.
;Тип демона (daemonType)
:Одно из следующих значений:
:*periodic
:*cron
:*service
:*manual
;Описание (description)
:Описание демона
;slaveNo

Демоны сохраняются по умолчанию в файл daemons.yaml. В дереве проекта они хранятся в коллекции Daemons внутри [[Module|модуля]].

Пример задания демона в [[yaml]]:
daemons:
CheckRequestsDaemon:
className: com.myproject.daemons.CheckRequestsDaemon
configSection: CheckRequestsDaemon
daemonType: periodic
description: Daemon to check the requests

RoleGroup

2014-09-11T07:31:51Z

Lan:

{{ElementType|com.beanexplorer.enterprise.metadata.model.RoleGroup|нет}}

Группа ролей (role group) — поименованная совокупность [[role|ролей]], которую можно назначить разом какому-либо элементу (например, [[Operation|операции]] или [[Query|представлению]]). При использовании в списке ролей группы необходимо перед её именем поместить символ '@'. Группы ролей позволяют кастомизировать права доступа для [[Module|модулей]]: вы можете определить в модуле группу и задать ей набор ролей по умолчанию (обычно пустой), а в проекте приложения переопределить эту группу, задав другие роли. Поэтому рекомендуется использовать в модулях только группы ролей.

Одна группа может включать другую группу. Циклическое включение не приведёт к ошибкам и какому-либо эффекту.

Для удобства существуют также предопределённые группы: <code>@AllRoles</code> (все доступные роли проекта) и <code>@AllRolesExceptGuest</code> (все роли кроме роли Guest).

Группы ролей по умолчанию сериализуются в файл security.yaml, в секцию groups. В дереве [[Project|проекта]] они хранятся в папке Security/Role groups.

Пример задания группы ролей в [[yaml]]:

security:
groups:
PortalReadOnlyRoles: '@AllRolesExceptGuest'
UtilityDispatcherRoles: Dispatcher
SocRegReadWriteRoles:
- Operator
- Reception
UtilityAddressManagerRoles: []

Role

2014-09-11T05:56:06Z

Lan:

{{ElementType|com.beanexplorer.enterprise.metadata.model.Role|да|да}}

Роль (role) — это базовый элемент подсистемы безопасности. Роли могут выдаваться конкретным пользователям. [[Operation|Операции]] и [[Query|представления]] могут быть доступны определённым ролям. Роли могут объединяться в [[RoleGroup|группы ролей]], но при внесении в базу группы разворачиваются, поэтому в базе есть только отдельные роли.

Обычно роли называют с большой буквы в CamelCase (например, SecurityOperator, Accountant и т. д.). Имеются стандартные роли, которые могут специально обрабатываться BeanExplorer: Administrator, Guest, DbAdmin, SystemDeveloper.

Роли вместе с группами ролей по умолчанию сохраняются в файл security.yaml в секцию roles. В дереве [[Project|проекта]] они хранятся в папке Security/Roles.

Для ролей поддерживаются [[extras]].

Пример задания ролей в [[yaml]]:

security:
roles:
Administrator: {}
Cashier:
doc: Учет поступления оплаты от населения за услуги ЖКХ
NeedyFamilies:
doc: Учет малообеспеченных семей, семей "группы риска" и семей в трудной жизненной ситуации
extras: module:soccalc

Extras

2014-09-05T08:04:34Z

Lan:

'''Extras''' — способ задания условий, по которым данный элемент [[Project|проекта]] будет использоваться. На данный момент поддерживается для следующих типов элементов:
* [[Entity|Сущность (entity)]]
* [[Query|Представление (query)]]
* [[Operation|Операция (operation)]]
* [[ColumnDef|Определение колонки (columnDef)]]
* [[IndexDef|Определение индекса (indexDef)]]
* [[Role|Роль (role)]]
* [[Daemon|Демон (daemon)]]
* [[TableRef|Ссылка на другую колонку (tableRef)]]

Extras — набор текстовых строк, представляющих собой условия. Если строк несколько, требуется соблюдение всех условий сразу.

Каждая строка имеет следующий формат:
[!]<prefix>:<value>

Восклицательный знак означает отрицание (элемент доступен в случае, если условие не выполнено). Определены следующие префиксы:
* '''db''' — используется ли данный движок СУБД. Возможные значения value: db2, mysql, oracle, sqlserver, postgres
* '''dbcap''' — обладает ли движок СУБД определённой функциональностью. На данный момент возможны следующие значения:
** '''fnindex''' — поддерживаются ли функциональные индексы
** '''customincrement''' — поддерживается ли создание autoincrement-колонки, начинающейся с определённого значения
** '''gencolumn''' — поддерживаются ли вычислимые колонки. Если да, можно использовать в качестве default value колонки что-то типа generic(ID)
* '''module''' — присутствует ли в проекте [[Module|модуль]] с данным именем.
* '''feature''' — подключена ли указанная фича.
* '''extra''' — доступен ли указанный extras в указанном модуле (формат: <code>extra:moduleName::extraName</code>). Может потребоваться, если надо проверить extras, объявленный для другого модуля.
* '''var''' — определена ли указанная переменная или равна ли она заданному значению. К примеру <code>var:REGION=54</code> выполняется, если определена переменная REGION и её значение — 54.

Также в модулях в качестве extras может встречаться просто строка. Если та же строка определена в проекте приложения в секции данного модуля, то этот extras выполняется.

MassChange

2014-09-02T09:19:20Z

Lan: опечатка

{{ElementType|com.beanexplorer.enterprise.metadata.model.MassChange|да}}

'''MassChange''' (массовое изменение) — возможность применить однотипное изменение к различным элементам дерева [[Project|проекта]] по условию. В дереве проекта хранятся в коллекции Mass changes в [[Module|модуле]] приложения. На файловой системе хранятся по умолчанию в src/massChanges.yaml. Пример:

- select: Entity#messages Query
roles: []

Данное массовое изменение выбирает все представления сущности messages и устанавливает им пустой список ролей.

Каждый элемент списка содержит селектор (select) и определение элемента. Для всех элементов, которые соответствуют селектору, производится переопределение указанных свойств точно так же, как в приложении кастомизируется элемент из модуля. В принципе селектор может соответствовать элементам разного типа, в некоторых случаях это сработает. Например:
- select: Entity#blahblah Query, Entity#blahblah Operation
roles: []
Удалит все роли у всех представлений и операций сущности blahblah. Но лучше разносить подобное на отдельные селекторы.

Селектор пока может выбирать Query, Operation или Entity. Если селектор выбрал что-то другое, будет ошибка.

== Селекторы ==
Синтаксис селекторов похож на CSS. Спецсимволы обрабатываются в соответствии со [http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier стандартом CSS]. Поддерживаются следующие возможности:

* Выбор по классу (аналог CSS [http://www.w3.org/TR/selectors4/#type-selector type selector]). Указывается просто название типа элементов. Пока поддерживаются Module, Entity, Query, Operation. Например:
Operation
:Такой селектор просто выберет все представления.
:
* Выбор по атрибуту (аналог CSS [http://www.w3.org/TR/selectors4/#attribute-representation attribute value selectors]). Поддерживаются формы <code>[attr=val], [attr^=val], [attr$=val], [attr*=val]</code> для точного совпадения значения, префикса, суффикса и подстроки. Список доступных атрибутов зависит от типа данных и обычно похож на список полей при сериализации в [[yaml]]. Например:
[name="messages"]
:Такой селектор выберет все элементы с именем messages.
:
* Выбор имени. Для сокращения предыдущий селектор можно написать так:
#messages
:Но при этом значение уже должно удовлетворять свойствам идентификатора, а не строки (например, нужно экранировать пробелы).
:
* Выбор типа. У Entity, Query и Operation бывает тип. Его можно выбрать через <code>[type="..."]</code>, но короче через точку:
.table
:Выберет все элементы с типом table. Доступные типы:
:* Для Entity: table, dictionary, collection, genericCollection, metadata
:* Для Query: 1D, 1D_unknown, 2D, static, custom, container, javascript
:* Для Operation: java, sql, javafunction, js (=javascript), jsserver (=javascriptserver), dotnet, javadotnet

* Сложный селектор (CSS: [http://www.w3.org/TR/selectors4/#compound compound selector]). Несколько правил, написанных слитно. Выбирается элемент, удовлетворяющий всем правилам. Например:
Entity#messages
:Тут два правила: выбрать элементы по классу Entity (то есть сущности) и выбрать элементы с именем messages. В результате будет выбрана сущность с именем messages.
:
* Комбинатор-потомок (CSS: [http://www.w3.org/TR/selectors4/#descendant-combinators descendant combinator]). Если перечислить несколько селекторов через пробел, будут выбраны элементы, удовлетворяющие последнему селектору, у которых есть родитель (не обязательно непосредственный), удовлетворяющий предпоследнему, и т. д. Например:
Entity#messages Query
:Выберет все представления сущности с именем messages. Другие CSS-комбинаторы (>, +, ~) не поддерживаются.
:
* Список селекторов (CSS: [http://www.w3.org/TR/selectors4/#grouping selector list]). Можно перечислить через запятую несколько селекторов, тогда элемент будет выбран, если он подходит под любой из селекторов. Например:
Query, Operation
:Выберет все представления и все операции.
:
* Псевдокласс :not (CSS: [http://www.w3.org/TR/selectors4/#negation negation]). Выберет элементы, которые не удовлетворяют заданному в скобках селектору. Например:
Entity:not(.table)
:Выберет все сущности, тип которых не table.
:
* Псевдокласс :matches (CSS: [http://www.w3.org/TR/selectors4/#matches matches]). Выберет элементы, которые удовлетворяют хотя бы одному из заданных в скобках селекторов. Например:
Entity:matches(#users,#persons) Query
:Выберет все представления из сущностей с именами users и persons.

== Примеры ==
Примеры старого <code style="color: blue">SQL</code>-кода и соответствующего массового изменения:
=== Изменение кода операций ===
<pre style="color:blue">UPDATE operations SET code = 'com.beanexplorer.enterprise.operations.SilentEditOperation'
WHERE code = 'com.beanexplorer.enterprise.operations.EditOperation' AND table_name != 'colorSchemes';</pre>
select: Entity:not(#colorSchemes) Operation[code="com.beanexplorer.enterprise.operations.EditOperation"]
code: com.beanexplorer.enterprise.operations.SilentEditOperation
=== Специальная операция для редактирования словарей ===
<pre style="color:blue">UPDATE operations SET code = 'com.beanexplorer.ru.social.operations.DictionaryEdit'
WHERE table_name IN ( SELECT name FROM entities WHERE type = 'dictionary' )
AND code = 'com.beanexplorer.enterprise.operations.EditOperation'
AND name = 'Edit';</pre>
select: Entity.dictionary Operation#Edit[code="com.beanexplorer.enterprise.operations.EditOperation"]
code: com.beanexplorer.ru.social.operations.DictionaryEdit

=== Удаление ролей для нескольких таблиц ===
<pre style="color:blue">DELETE FROM queries_per_role
WHERE queryID IN ( SELECT q.ID FROM queries q WHERE q.name IN ( 'All records' ) AND q.table_name IN ( 'gpsDeviceTypes', 'gpsDevices' ) );</pre>
select: Entity:matches(#gpsDevices,#gpsDeviceTypes) Query[name="All records"]
roles: []
Или
select: Entity[name^=gpsDevice] Query[name="All records"]
roles: []
=== Удаление ролей для всех операций по имени ===
<pre style="color:blue">DELETE FROM operations_per_role
WHERE operID IN ( SELECT o.ID FROM operations o WHERE o.name IN ( 'Explain Plan', 'Parent Record' ) );</pre>
select: Operation[name="Explain Plan"], Operation[name="Parent Record"]
roles: []
Или
select: Operation:matches([name="Explain Plan"], [name="Parent Record"])
roles: []
=== Разрешить фильтровать словари всем ===
<pre style="color:blue">INSERT INTO operations_per_role
SELECT o.ID, r.role_name
FROM operations o, roles r
WHERE o.table_name IN (
SELECT name FROM entities WHERE type = 'dictionary'
) AND o.name IN ( 'Filter' ) AND r.role_name IN ( r.role_name ) ;</pre>
select: Entity.dictionary Operation#Filter
roles: '@AllRoles'
=== Администратору базы данных разрешить менять все словари ===
<pre style="color:blue">DELETE FROM operations_per_role
WHERE role_name IN ( SELECT r.role_name FROM roles r WHERE r.role_name IN ( 'DbAdmin' ) )
AND operID IN ( SELECT o.ID FROM operations o WHERE o.table_name IN
( SELECT name FROM entities WHERE type='dictionary' AND origin IN ('ru.mfc') ) AND o.name in ( o.name ) );
INSERT INTO operations_per_role
SELECT o.ID, r.role_name
FROM operations o, roles r
WHERE o.table_name IN ( SELECT name FROM entities WHERE type='dictionary' AND origin IN ('ru.mfc') )
AND o.name IN ( o.name ) AND r.role_name IN ( 'DbAdmin' ) ;</pre>
select: Module#ru\.mfc Entity.dictionary Operation
roles: +DbAdmin
=== Добавить специальный запрос во все сущности кроме dummy ===
<pre style="color:blue">INSERT_INTO(queries) table_name, name, isInvisible, query )
SELECT name, 'Exchange: Modified Data', 'yes',
_DBMS_CONCAT( 'SELECT * FROM ', name, '<if parameter="dateFrom"> WHERE modificationDate___ >= ''<parameter:dateFrom /> 00:00:00''</if>' )
FROM entities WHERE SUBSTRING(name,1,1) != '_';</pre>
select: Entity:not([name^=_])
queries:
- 'Exchange: Modified Data':
code: SELECT * FROM ${entity.getName()} <if parameter="dateFrom"> WHERE modificationDate___ >= '<parameter:dateFrom /> 00:00:00'</if>
invisible: true
=== Добавить запрос Table definition в сущности, primary key которых не является dummy ===
<pre style="color:blue">-- add missing table defs in one powerful stroke ;-)
INSERT INTO queries( table_name, name, query, type )
SELECT e.name, 'Table definition', ' ', '1D'
FROM entities e
WHERE e.primaryKeyColumn != '_dummy_'
AND NOT EXISTS( SELECT 1 FROM queries q
WHERE q.table_name = e.name AND q.name = 'Table definition' );</pre>
select: Entity:not([primaryKey="_dummy_"])
queries:
- Table definition: {}

Built-ins (BeanExplorer4)

2014-08-22T07:16:42Z

Lan:

[http://freemarker.org/docs/ref_builtins_alphaidx.html Built-ins] во Freemarker — это встроенные суффиксы к значениям (через вопросительный знак), которые выполняют какие-либо преобразования. К примеру, ${"<test>"?[http://freemarker.org/docs/ref_builtins_string.html#ref_builtin_html html]} вернёт <code><test></code>.

Мы определили ряд дополнительных built-ins (хотя разработчики Freemarker против этого) для упрощения работы именно в контексте BeanExplorer.
* '''?str''' — превратит строку в sql-строку, используя особенности текущего sql-диалекта. Если аргумент — специальный объект null, то результатом будет строка NULL. Аналог Utils.safestr(connector, text, true). Примеры (для MySQL, в других СУБД результат может отличаться):
** <code>${"test"}</code> -> test
** <code>${"test"?str}</code> -> 'test'
** <code>${null?str}</code> -> NULL
** <code>${"test'quotes'"?str}</code> -> 'test<nowiki>''quotes'''</nowiki>
** <code>${concat('col1', ' - '?str, 'col2')}</code> -> CONCAT( col1, ' - ', col2 )
* '''?quote''' — обернёт в кавычки идентификатор, если это необходимо. Пример (для MySQL):
** <code>SELECT ${'___whoModified'?quote} FROM myTable</code> -> SELECT `___whoModified` FROM myTable

* '''?asVarchar''' — добавит преобразование SQL-числа к строке. Примеры (для MySQL):
** <code>${"ID"?asVarchar}</code> -> CAST( ID AS CHAR )
** <code>${concat('ID = '?str, 'ID'?asVarchar)}</code> -> CONCAT( 'ID = ', CAST (ID AS CHAR) )
* '''?asDate''' — добавит преобразование SQL-строки к дате.
* '''?asInt''' — добавит преобразование SQL-строки к числу.
* '''?asPK''' — добавит преобразование к типу Primary Key. Пример (для MySQL):
** <code>${'mycolumn'?asPK}</code> -> CAST( mycolumn AS BIGINT )
* '''?upper''' — добавит SQL для преобразования в верхний регистр
* '''?upperFirst''' — добавит SQL для преобразования первого символа в верхний регистр, а последующих — в нижний.
* '''?lower''' — добавит SQL для преобразования в нижний регистр
* '''?idCase''' — добавит SQL для преобразования в регистр идентификаторов базы данных (если требуется)
* '''?dateFormat''' — добавит SQL для форматирования даты в виде YYYY-MM-DD
* '''?dateFormatRus''' — добавит SQL для форматирования даты в виде DD.MM.YYYY
* '''?dateTimeFormat''' — добавит SQL для форматирования даты и времени в виде YYYY-MM-DD HH:MM:SS
* '''?year''' — создаёт SQL для извлечения года из даты
* '''?month''' — создаёт SQL для извлечения месяца из даты
* '''?day''' — создаёт SQL для извлечения дня месяца из даты
* '''?yearStart''' — создаёт SQL для получения первого дня года
* '''?monthStart''' — создаёт SQL для получения первого дня месяца
* '''?orEmpty''' — сокращённый вариант для coalesce(arg, <nowiki>''</nowiki>?str). Пример (для MySQL):
** <code>${concat('nameSpace'?orEmpty, 'name'?orEmpty</code><code>)}</code> -> CONCAT( COALESCE(nameSpace,<nowiki>''</nowiki>),COALESCE(name,<nowiki>''</nowiki>) )

* '''?roles''' — развернёт список ролей и групп ролей в просто список ролей через запятую без повторов. Пусть в проекте определены группы @Managers (Manager, Admin) и @Users (User, Manager). Тогда:
** <code>${'@Managers,@Users,Guest'?roles}</code> -> 'Admin,Guest,Manager,User'
'''Совет''': используйте скобки, если хотите применить суффикс к сложному выражению. Например, для запросов второго уровня:

<code>SELECT ${</code>'''<code>(</code>'''<code>'SELECT '+concat('name', ' = '?str, 'value') + ' FROM table1'</code>'''<code>)?str</code>'''<code>} AS "Data;<sql/>" FROM table2</code>

Альтернатива такому синтаксису: использовать предопределённый макрос <@str>:

<code>SELECT '''<@_str>'''SELECT ${concat</code><code>('name', ' = '?str, 'value')} FROM table1'''</@>'''</code><code> AS "Data;<sql/>" FROM table2</code>

Тут дело вкуса.

[[Категория:Freemarker]]

Создание своих макросов (BeanExplorer4)

2014-08-22T07:15:01Z

Lan:

Официальная документация по созданию макросов Freemarker [http://freemarker.org/docs/ref_directive_macro.html здесь].

Особенности при переходе с m4:
* Все параметры макроса обязательны кроме тех, которым дано значение по умолчанию. Если раньше у макроса второй параметр был необязателен и писали так:

<code>define(MY_MACRO, ... ifelse($2,,...))</code>

теперь можно писать так:

<#macro MY_MACRO requiredParameter optionalParameter=<nowiki>''</nowiki>>...
<#if optionalParameter==<nowiki>''</nowiki>>...<#else>...</#if>...
</#macro>

* При вызове макроса можно именовать параметры для наглядности:
<code><@MY_MACRO requiredParameter='val1' optionalParameter='val2'/></code>
* Чтобы передать результат выполнения макроса в функцию (например, concat), надо присвоить этот результат в переменную с помощью <[http://freemarker.org/docs/ref_directive_assign.html #assign]>. Раньше писали:
<code>_DBMS_CONCAT( MYMACRO1(arg1), MYMACRO2(arg2) )</code><br>
Теперь так:<br>
<#assign result1><@MYMACRO1 arg1/></#assign>
<#assign result2><@MYMACRO2 arg2/></#assign>
${concat(result1, result2)}
В некоторых случаях лучше определять не макрос, а функцию с помощью директивы <[http://freemarker.org/docs/ref_directive_function.html #function]>. Тогда функцию можно будет использовать:
<code>${concat( func1(arg1), func2(arg2) )</code>
* Аргументы макроса не могут быть напрямую результатом выполнения другого макроса за исключением <#nested>-аргумента. Если у макроса один из аргументов предположительно может быть большим и нетривиальным или макрос по своей семантике его оборачивает, пользуйтесь <#nested>. Так сделан, например, предопределённый макрос <@bold/>:
<#macro bold>
<#assign nested><#nested></#assign>
${concat('<nowiki><b>'?str, nested, '</b></nowiki>'?str)}
</#macro>
Пользоваться им в результате удобно и естественно:
<code><@bold><@italic>${concat('a', 'b')}</@></@></code>
* Если макрос не имеет параметров вообще, возможно, стоит присвоить его значение переменной. Так вместо<br>
<#macro USER_INFO>
User:
${concat('u.emailAddress', ' ('?str,
    'per.courtesy', ' '?str,
    'per.firstName', ' '?str,
    'per.lastName', ', #'?str,
    'per.ID'?asVarchar, ')'?str)}
</#macro>
Пишем:
<#assign USER_INFO>
User:
${concat('u.emailAddress', ' ('?str,
'per.courtesy', ' '?str,
'per.firstName', ' '?str,
'per.lastName', ', #'?str,
'per.ID'?asVarchar, ')'?str)}
</#assign>
Тогда обращаться к USER_INFO можно в любом контексте по имени.

[[Категория:Freemarker]]

Пользовательские макросы (BeanExplorer4)

2014-08-22T07:13:45Z

Lan:

В дереве проекта в application/Macros можно создавать *.ftl-файлы для подключения в других местах. В этих файлах можно разместить макросы, функции, присвоить переменные и т.д. По умолчанию подключается всегда файл common.ftl (если он есть). Внутри этого файла вы можете подключить другие файлы, используя директиву <code><#include></code>. Обратите внимание, что она работает в виртуальной (модельной) файловой системе проекта, поэтому подключать надо с учётом этого.

Макросы из доступных модулей по умолчанию не подключены, но вы также можете [[Подключение скриптов|подключить их]] с помощью <code>#include</code>. Например, в вашем приложении в common.ftl может быть написано

<code><#include "../../Modules/realty/Macros/common"/></code>

Тогда макросы и функции из модуля realty будут доступны во всех запросах.

[[Категория:Freemarker]]

Объекты (BeanExplorer4)

2014-08-22T07:13:00Z

Lan:

<div>Для удобства в контексте выполнения Freemarker всегда содержатся некоторые объекты. Внутри конструкций Freemarker (${}, <#> и <@>) ими можно пользоваться как обычными Java-объектами.

Эти объекты определены везде (в Custom scripts и при задании кода представлений):
* '''project''': объект com.beanexplorer.enterprise.metadata.model.Project; содержит всю иерархию проекта; можно достать любые данные. Примеры:
** <code>${project.getConnectionProfileName()} </code>— профиль соединения к базе данных.
** <code>${project.getEntity('myTable').getQueries().get('myQuery').getMenuName()} </code>— название пункта меню для представления myQuery в таблице myTable.
* '''dbPlatform''': строка, определяющая платформу СУБД. Сокращённый вариант для project.getDatabaseSystem().getName(). Пример использования:
** <code>SELECT <#if dbPlatform == 'sqlserver'>TOP 1</#if></code>
* '''currentDate''': SQL-выражение для текущей даты в текущей версии СУБД
* '''currentDateTime''': SQL-выражение для текущего времени в текущей версии СУБД
* '''fromFakeTable''': SQL-выражение для выборки из псевдо-таблицы (например "FROM DUAL") в зависимости от текущей версии СУБД
* '''null''': специальное значение для работы с NULL в SQL. При использовании <code>null?str</code> вы получите строку NULL. Объект null можно передавать в макросы и функции, которые применят <code>?str</code> к нему. Использование объекта null другими способами ведёт к неопределённому поведению.

Эти объекты могут быть определены при задании кода представлений или кастомизаций:

* '''module''': объект com.beanexplorer.enterprise.metadata.model.Module, представляющий текущий модуль
* '''entity''': объект com.beanexplorer.enterprise.metadata.model.Entity, представляющий текущую entity. Пример:
** <code>SELECT * FROM ${entity.getName()} </code>— выбрать все элементы из текущего entity (можно, к примеру, определить такой макрос и использовать его в разных entity).

* '''query''': объект com.beanexplorer.enterprise.metadata.model.Query, представляющий текущее представление.
* '''operation''': объект com.beanexplorer.enterprise.metadata.model.Operation, представляющий текущую операцию.
* '''customization''': объект com.beanexplorer.enterprise.metadata.model.PageCustomization, представляющий текущую кастомизацию.

[[Категория:Freemarker]]

Макросы (BeanExplorer4)

2014-08-22T07:11:43Z

Lan: /* Макросы для использования в запросах: */

Шаблонизатор Freemarker поддерживает [http://freemarker.org/docs/dgui_misc_userdefdir.html макросы] или пользовательские директивы. Вы можете создавать свои макросы как непосредственно в месте использования (custom step или в коде представления), так и в отдельном файле macro.ftl (тогда они будут видны во всём проекте).

Имеется также набор предопределённых макросов, которые позволяют выполнить стандартный функционал, полезный в разных проектах. Все эти макросы определены в файле be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl. Все предопределённые макросы начинаются с подчерка. Просьба не создавать макросы с подчерка в своих проектах.

=== Макросы для использования в запросах: ===
* '''<@_copyQuery name/>''': скопировать текст другого запроса из текущего entity.
* '''<@'''_'''copySelectionQuery/>''': скопировать текст запроса *** Selection view *** из текущего entity.
* '''<@'''_'''copyAllRecordsQuery/>''': скопировать текст запроса All records из текущего entity.
* '''<@'''_'''str>text</@'''_'''str>''': превратить текст в SQL-строку (альтернатива суффиксу ?str), удобно использовать для запросов второго уровня.
* '''<@'''_'''bold>SQL</@'''_'''bold>''': добавить SQL-код для выделения текста полужирным( '''НО правильнее это делать через CSS!''' ). Пример:
:* <code>SELECT <@</code><code>'''_'''bold>name</@</code><code>'''_'''bold> FROM myTable </code>-> (в MySQL) SELECT CONCAT( '<nowiki><b>',name,'</b></nowiki>' ) FROM myTable
* '''<@'''_'''italic>SQL</@'''_'''italic>''': добавить SQL-код для выделения текста курсивом( '''НО правильнее это делать через CSS!''' ).Пример:
:* <code>SELECT <@</code><code>'''_'''bold><@</code><code>'''_'''italic>name</@></@> FROM myTable </code>-> (в MySQL) SELECT CONCAT( '<nowiki><b>',CONCAT( '<i>',name,'</i>' ),'</b></nowiki>' ) FROM myTable
* '''<@_align 'side'>SQL</@_align>''': добавить SQL-код для выравнивания текста( '''НО правильнее это делать через CSS!''' ). Параметр 'side' принимает значения 'left', 'center', 'right', 'justify'
* '''<@_localize>SQL</@_localize>''': добавить SQL-код для локализации текста. Полезно при сочетании с другими макросами, например:
:* <code>SELECT <@_bold><@_localize>name</@></@> FROM myTable</code> (в этом случае внутри _localize должен быть самым внутренним макросом)
* '''<@_substring from [to]>SQL</@>''': аналог функции substring. Полезен, если в качестве входной строки подаётся сложное выражение: здесь входная строка задаётся вложенным элементом.
* '''<@_isInRole 'roles'/>''': добавляет условие для проверки обладает ли текущий пользователь хотя бы одной из указанных ролей. Параметры могут включать конкретные роли и группы ролей через запятую, например '''<@_isInRole '@AllRolesExceptGuest'/>'''
* '''<@_contains list column/>:''' создаёт IN-предложение для списка элементов list и заданной колонки (column IN ('val1', 'val2', ...)).
* '''<@_selectRow>SQL</@>:''' добавляет начало и конец SQL-запроса для выбора только одной строки (либо SELECT TOP 1 ..., либо SELECT ... LIMIT 1). Пример:
:* <code><@_selectRow> * FROM myTable</@></code>
* '''<@_staticList 'element1' 'element2' ... />''': создаёт SQL-предложение, выдающее одну колонку с заданными элементами. Удобно использовать для quick filter. Пример:
:* <code><@_staticList 'waiting' 'running' 'complete'/></code> -> (в Postgres):
SELECT 'waiting'
UNION
SELECT 'running'
UNION
SELECT 'complete'
* '''<@_enumList 'columnName'/>''': создаёт SQL-предложение, выдающее одну колонку со списком вариантов типа ENUM для колонки columnName, определённой в текущей таблице. Удобно использовать для quick filter.
* '''<@_sql>SQL</@>:''' форматирует данный SELECT-запрос с помощью движка [[BE-SQL]] в соответствии с текущим движком базы данных. В теле макроса должен присутствовать целый SQL-запрос. Пример: можно написать с помощью FTL-конструкций так:

SELECT c.ID AS "Code",
${concat('c.alphabeticCode', ' - '?str, 'CASE WHEN '+length('c.name')+' > 30 THEN '+concat(substring('c.name', 1, 30), '...'?str)+' ELSE c.name END')} AS "Name"
FROM currencies c

:А можно воспользоваться <@_sql>:

<@_sql>SELECT c.ID AS "Code",
c.alphabeticCode || ' - ' || CASE WHEN LENGTH(c.name) > 30 THEN SUBSTRING(c.name, 1, 30) || '...' ELSE c.name END AS "Name"
FROM currencies c</@>

'''Совет''': если макрос допускает вложенные элементы (например, <@'''_'''bold>), завершать его можно либо </@'''_'''bold>, либо просто </@>.

=== Макросы для использования в кастомизациях ===
* '''<@'''_'''onLoad 'functionName'/>''': .js-кастомизация, добавляющая вызов указанной JS-функции при загрузке страницы.
* '''<@_loadScript 'fileName.js'>code</@>''': загрузить на клиенте указанный js-файл и выполнить указанный код по завершении.

=== Макросы для использования в ftl-скриптах: ===
* '''<@'''_'''systemSetting category key value/>''': добавить системную настройку. Пример:
:* <code><@</code><code>'''_'''systemSetting 'system' 'FORCED_LOCALE' 'ru' /></code>
:* <code><@</code><code>'''_'''systemSetting category='system' key='FORCED_LOCALE' value='ru' /></code> — то же самое
* '''<@_jsHandler code name>JavaScript code</@>''': добавить в базу JavaScript-handler. Code — код (машинночитаемое имя), name — человекочитаемое имя, JavaScript code — исходник хэндлера
* '''<@_isInRole 'roles' 'column'/>''': добавляет условие для проверки,
входит ли значение в указанной колонке в заданный список ролей roles.
Пример:
:* <code>DELETE FROM queries_per_role WHERE </code><code><@_isInRole '@DisabledRoles,DbAdmin' 'role_name'/></code> -> DELETE FROM queries_per_role WHERE ( role_name IN ( 'DbAdmin', 'Dispatcher', 'Guest' )) (группа DisabledRoles содержала роли Dispatcher и Guest)

* '''<@_insertInto table [idCol]>columns</@>''': добавить начало предложения INSERT INTO для таблицы с автоинкрементной колонкой idCol (по умолчанию 'ID'). Columns — список колонок через запятую. Далее должно следовать <@_insertValues> или <@_insertSelect>
* '''<@_insertValues>values</@>''': продолжение INSERT INTO. Values — список значений через запятую (должно быть столько же, сколько колонок в _insertInto. Пример:
:* <code><@_insertInto myTable>col1, col2</@> <@_insertValues>'val1', 'val2'</@></code> — сгенерирует
<code>INSERT INTO myTable(col1, col2) VALUES ('val1', 'val2'); (в Oracle будет сложнее)</code>

* '''<@_insertSelect>statement</@>''': продолжение INSERT INTO. Statement — SQL-предложение SELECT (без самого слова SELECT). Пример:
:* <code><@_insertInto 'categories'>entity, name, parentID</@></code>
:* <code><@_insertSelect>'utilitySuppliers', 'Жилищные услуги', ID FROM tmp_cat_table</@></code>

* '''<@_noAutoIncrement>insert statements...</@>''': выполнить вставку записей в таблицу с явным заданием значения auto-increment. В некоторых СУБД может требоваться включить специальный режим для такой вставки, для чего и служит данный макрос.

=== Устаревшие макросы ===
Эти макросы использовались для массового назначения ролей. После появления [[MassChange]] их использовать нельзя и они могут исчезнуть.

* '''<@_operationRoles 'roles' [entities] [names]/>''': создаёт SQL для задания ролей операциям. Каждый параметр необязательный,
если отсутствует, означает, любое. Использовать только в Pre-meta для
некастомизированных операций! Примеры:
:* <code><@_operationRoles entities=['documents','addresses','socialEvents2documents'] names='Filter'/></code>
:* <code><@_operationRoles entities='CSPcalls' names=['Insert','Edit'] roles='Passport,ClearingHouse,Reception'/></code>

* '''<@_removeOperationRoles 'roles' [entities] [names]/>''': создаёт SQL для удаления заданных ролей из заданных операций. Каждый параметр необязательный, если отсутствует, означает, любое. Использовать только в Pre-meta для некастомизированных операций! Примеры:
:* <code><@_removeOperationRoles names=['Explain Plan', 'Parent Record']/></code>
:* <code><@_removeOperationRoles roles='Accountant' entities='utilityRates' names=['Insert', 'Edit']/></code>

* '''<@_queryRoles 'roles' [entities] [names]/>''': создаёт SQL для задания ролей представлениям. Каждый параметр необязательный,
если отсутствует, означает, любое. Использовать только в Pre-meta для
некастомизированных представлений! Примеры:
:* <code><@_queryRoles entities=['documents','addresses','socialEvents2documents'] names='All records'/></code>
* '''<@_removeQueryRoles 'roles' [entities] [names]/>''': создаёт SQL для удаления заданных ролей из заданных представлений. Каждый параметр необязательный, если отсутствует, означает, любое. Использовать только в Pre-meta для некастомизированных представлений! Примеры:
:* <code><@_removeQueryRoles entities='messages'/></code>
:* <code><@_removeQueryRoles entities='_system_' names=['MySQL Variables','MySQL Tables','MySQL Processes'] /></code>
:* <code><@_removeQueryRoles entities=['votes','problems','sharedDocuments'] </code><code>roles='Manager,Property Manager' /></code>

[[Категория:Freemarker]]

Встроенные функции (BeanExplorer4)

2014-08-22T07:09:37Z

Lan: /* Функции для DDL-манипуляций */

=== Основные функции ===
Для удобства работы предопределены некоторые функции:
* '''addDays''': создаёт SQL-предложение для получения даты, отличающейся от заданной на указанное количество дней. Требуется два параметра: дата и количество дней
* '''addMillis''': создаёт SQL-предложение для получения даты, отличающейся от заданной на указанное количество миллисекунд. Требуется два параметра: дата и количество миллисекунд.
* '''addMonths''': создаёт SQL-предложение для получения даты, отличающейся от заданной на указанное количество месяцев. Требуется два параметра: дата и количество месяцев.
* '''chr''': создаёт SQL-предложение для нахождения символа по коду (обычно пригождаться не должно, сейчас используется для идентичных метаданных со старым BE).
* '''coalesce''': создаёт SQL-предложение COALESCE.
* '''concat''': создаёт SQL-предложения для конкатенации переданных строк. Пример:
** <code>SELECT ${concat('name', ' = '?str, 'value')} FROM myDictionary</code> -> <br/> (в MySQL) <code>SELECT CONCAT( name, ' = ', value ) FROM myDictionary</code>
* '''genericRef''': создаётся generic-ссылка. Требуется два аргумента: entity и колонка-идентификатор.
* '''if''': создаёт SQL-предложение IF. Требуется три аргумента: условие, значение, если условие истинно, и значение, если условие ложно. Если третий опущен, предполагается пустая строка.
* '''indexOf''': создаёт SQL-предложение для поиска подстроки в строке. Требуется два аргумента: строка и подстрока.
* '''joinGenericRef''': создаёт JOIN-предложение для подключения таблицы через generic reference. Требудется три аргумента: целевая таблица, алиас для неё и колонка-идентификатор.
* '''length''': создаёт SQL-предложение для подсчёта количества символов в строке. Не путайте со стандартным Freemarker-суффиксом ?length, который вычислит длину поданной строки во время выполнения скрипта.
* '''limit''': создаёт SQL-предложение для ограничения числа строк в запросе (если это позволяет СУБД)
* '''lpad''': создаёт SQL-предложение LPAD. Требудется три аргумента: исходная строка, требуемая длина и строка-заполнитель, которая будет использована для удлиннения исходной строки слева в случае необходимости.
* '''replace''': создаёт SQL-предложение REPLACE. Требуется три аргумента: исходная строка, искомая подстрока, строка замены.
* '''substring''': создаёт SQL-предложение SUBSTRING. Требуется три аргумента: исходная строка, номер начального символа, количество символов.

=== Функции для DDL-манипуляций ===
Обычно таблицы задаются в BE4 в декларативном стиле в файлах [[entity|сущностей]], и новые таблицы добавляются автоматически при синхронизации. DDL-манипуляции из FTL-скриптов могут потребоваться для обновления таблиц, определённых в старых m4-модулях. В целом манипулировать схемой таблиц из FTL не рекомендуется.

* '''columnDef(columnName, columnDefinition)''': создаёт фрагмент SQL-предложения CREATE TABLE или ALTER TABLE для определения колонки. Первый параметр — имя колонки, второй — хэш с её свойствами. Свойства в точности такие же, как в structure.yaml. Пример:
** <code>ALTER TABLE test ADD COLUMN ${columnDef('myCol', {'type': 'BOOL', 'canBeNull': true})}</code> -> <br/> (в Postgres) <code>ALTER TABLE test ADD COLUMN mycol VARCHAR(3) CHECK(mycol IN ('no', 'yes') )</code>
* '''tableDef(tableName, columns[, indices])''': создаёт SQL-предложение для создания новой таблицы (если таблица уже существовала, старая удаляется). Первый параметр — имя таблицы, второй — хэш, где ключи — имена колонок, а значения — хэш со свойствами колонок (как в columnDef). Необязательный третий параметр: список индексов (ключи — имена индексов, значения — хэш, описывающий индекс так же, как в structure.yaml). Пример:
**
${tableDef('uiSocialBlocks', {
'CODE': {'type': 'VARCHAR(2)', 'primaryKey': true},
'name': {'type': 'VARCHAR(250)'},
'parentCode': {'type': 'VARCHAR(2)', 'canBeNull': true}
})}
*** Результат в '''Postgres''':
DROP TABLE IF EXISTS uisocialblocks;
CREATE TABLE uisocialblocks (
code VARCHAR(2) NOT NULL PRIMARY KEY,
name VARCHAR(250) NOT NULL,
parentcode VARCHAR(2));
*** Результат в '''Oracle''':
call drop_if_exists( 'uiSocialBlocks' );
CREATE TABLE UISOCIALBLOCKS (
CODE VARCHAR2(2 CHAR) NOT NULL PRIMARY KEY,
NAME VARCHAR2(250 CHAR) NOT NULL,
PARENTCODE VARCHAR2(2 CHAR));<br/>

[[Категория:Freemarker]]

Freemarker (BeanExplorer4)

2014-08-22T07:06:25Z

Lan:

В качестве движка шаблонизатора в BeanExplorer4 используется немного модифицированный [http://freemarker.org/ Freemarker]. Язык Freemarker также называется FTL.

Официальная документация по Freemarker [http://freemarker.org/docs/index.html здесь].

В данный момент Freemarker используется:
* В тексте запросов к базам данных
* В тексте кастомизаций страниц (page customizations)
* В custom scripts — *.ftl-файлы, выполняющие определённый SQL для задания вещей, которые BeanExplorer4 не поддерживает в рамках модели
* В [[Пользовательские макросы|macros]] — набор FTL-макросов, функций, объявлений, которые доступны в остальных местах в рамках проекта.

Для упрощения работы создан набор функций, макросов и built-ins, которые всегда доступны.
* [[Встроенные функции|Встроенные функции]] (например <code>${concat('col1', 'col2')</code>}
* Предопределённые [[Макросы|макросы]] (например <code><@_bold>value</@_bold></code>)
* Новые [[Built-ins|built-ins]] (например <code>${'qqq'?str}</code>)
* Контекстные [[Объекты|объекты]] (например <code>${project}</code>)

=== Смотрите также ===
* [[Создание своих макросов|Создание своих макросов]].
* [[Подключение скриптов|Подключение скриптов (#include)]].

[[Категория:Freemarker]]

BeanExplorer4 JavaScript Debugger

2014-08-22T07:04:13Z

Asko:

=== Launchers ===
BeanExplorer4 использует возможности Eclipse JavaScript Development Tools (JSDT). JSDT предоставляет два типа launcher'а, относящихся к Rhino: Rhino JavaScript и Remote JavaScript.

* Remote JavaScript - это способ подключения к удалённому запуску JavaScript - предполагается, что на каком-то компьютере запущен JavaScript с отладчиком, который открыл порт для подключения и ждёт, что к нему подключится удалённый отладчик.
* Rhino JavaScript же представляет одновременно запуск и самого скрипта, и удалённого отладчика к нему. Поскольку этот вид launcher'а запускает скрипт Rhino, но не позволяет при этом выбрать то, откуда брать Java классы, он нам бесполезен.

=== Подключение к удалённому JavaScript ===
Remote JavaScript launcher создаётся (как обычно) в "Debug Configurations...". При создании launcher'а необходимо выбрать Connector "Mozilla Rhino - Attaching Connector", ввести host, на котором запущен проект BeanExplorer, и порт 9000 (отладчик на сервере всегда открывает только 9000 порт). После этого можно будет подключиться к отлаживаемой операции, попытавшись открыть её в браузере и запустив ваш launch configuration для подключения.

Для того, чтобы BeanExplorer поднял серверную часть отладчика, необходимо, чтобы в таблице systemsettings были следующие строчки:
* JAVA_SCRIPT_DEBUG_MODE - включение режима отладки (значение TRUE),
* JAVA_SCRIPT_OPERATION_TO_DEBUG - имя отлаживаемой операции (например, просто "Test"),
* JAVA_SCRIPT_SOURCE_NAME - имя файла с отлаживаемой операцией, так, как оно отображается в Eclipse (например, "/condo_be4/src/js/operations/userRegistrations - Test.js").
* JAVA_SCRIPT_METHOD_TO_DEBUG - имя метода для отладки (остальные методы не будут отлаживаться), одно из:
        NOTHING,          // there is no methods to debug
        GET_PARAMETERS,   // getParameters
        INVOKE,           // invoke
        GET_REDIRECT_URL, // getRedirectURL
        CUSTOM_GENERIC,   // getCustomAction, getCustomEnctype, getCustomMethod
        CONTEXT,          // the script itself

Установка этих переменных возможна автоматически, посредством нажатия кнопки "Set Current Operation As Remotely Debugged" на основном тулбаре (при открытом редакторе JavaScript). Отключение режима отладки возможен посредством пункта "BeanExplorer"->"Turn Off Server JavaScript Debugging" основного меню.

==== Known issues ====
* Может некорректно реагировать на первый breakpoint: в таком случае для того, чтобы увидеть переменные в скрипте, надо поставить хотя бы два breakpoint'а и нажать resume при первой остановке отладчика.

Далее рассматриваются способы запуска JavaScript через BeanExplorer4. Кнопки запуска раположены на основном toolbar'е Eclipse при открытом редакторе JavaScript. Причём операции будут запускаться только при условии, если JavaScript редактор открыть из дерева проекта BE4.

=== Run JavaScript (Local) ===
Запуск JavaScript операции в Eclipse. По завершению операции открывается браузер с результатом выполнения операции. В качестве входных данных операции возможно передавать presetValues и выбранные строки с entity. Метод для запуска, как и параметры, выбирается во view "Operation Parameters".

==== Known issues ====
* Позволяет запускать только getParameters() и invoke(), но не getRedirectURL().

=== Debug JavaScript (Local) ===
Похоже на Run, но запускает скрипт в режиме отладки и пытается подсоединиться к запущенному скрипту удалённым отладчиком (при этом автоматически создаётся launch configuration с именем "BeanExplorer4", коннектором "Mozilla Rhino - Attaching Connector", хостом localhost и портом 9000).

==== Known issues ====
* Позволяет запускать только getParameters() и invoke(), но не getRedirectURL().

=== Debug JavaScript Query (Local) ===
Как и JavaScript операции, JavaScript запросы тоже возможно отлаживать. При открытом редакторе JavaScript запроса (это, конечно, будет JavaScript редактор) на основном тулбаре Eclipse будут кнопки "Run JavaScript Query (Local)", "Debug JavaScript Query (Local)" и "Set Current Query As Remotely Debugged".
* Нажатие на первую кнопку просто запускает запрос, результат которого будет отображён во вкладке "Query Executor" (в отличие от обычных, SQL запросов, вкладка "Raw SQL" не будет заполнена, посколько JavaScript запрос не генерирует SQL).
* Нажатие на вторую кнопку аналогично первой, но оно запускает запрос на отладку.
* Нажатие на третью кнопку заносит в настройки BeanExplorer4 проекта (в базу данных) информацию о том, что данный запрос должен является отлаживаемым, и при попытке открыть его через браузер, BE4 приложение записнет и будет ждать подключения отладчика. При этом заносятся следующие параметры в таблицу systemsettings:
** <code>JAVA_SCRIPT_QUERY_DEBUG_MODE</code> ("true" или "false")
** <code>JAVA_SCRIPT_QUERY_TO_DEBUG</code> (например, "Fast Input Data JS")
** <code>JAVA_SCRIPT_QUERY_SOURCE_NAME</code> (например, "/condo4/src/js/queries/Fast Input Data JS.js")

Project (BeanExplorer4)

2014-08-22T06:59:52Z

Lan: Пример, properties, scripts, includes, bugtrackers

{{ElementType|com.beanexplorer.enterprise.metadata.model.Project|да}}

Проект — это корневой элемент дерева BeanExplorer4. В основном этот элемент сериализуется в файл project.yaml.

Проект имеет следующие свойства (в скобках — имя соответствующего свойства в project.yaml, если применимо):
* Имя. Должно совпадать с именем Eclipse-проекта. Используется по умолчанию как имя для сборки war-файла. Если это проект-модуль, то совпадает с именем модуля
* Проект-модуль (moduleProject): если true, значит проект описывает be4-модуль (должен располагаться в каталоге be4/modules). Для обычных пользовательских приложений false
* Профиль соединения: используемый в данный момент профиль соединения
* Баг-трекеры (bugtrackers): список [[ConnectedBugtracker|подключенных баг-трекеров]].
* Фичи (features): список фич BeanExplorer, доступных в проекте
* Локализации (l10n): список языков локализации (двухсимвольные коды типа 'ru'), используемых в проекте
* Структура проекта (projectFileStructure): определяет размещение файлов проекта в поддиректориях.
* Свойства (properties): список пар ключ-значение, задающих предопределённые переменные проекта. Эти переменные добавляются в ant-свойства, в контекст [[Freemarker]] и доступны в [[extras]].

Дочерние элементы проекта:
* Connection profiles — коллекция с локальными и удалёнными [[BeConnectionProfile|профилями соединений]]
* Modules — коллекция, содержащая [[Module|модули]], используемые данным проектом
* Security — списки [[role|ролей]] и [[RoleGroup|групп ролей]] проекта
* application (или имя проекта-модуля) — основной модуль проекта (вынесен отдельно)

В файле project.yaml также присутствуют секции:
* scripts — список всех [[FreemarkerScript|FTL-скриптов]] проекта, которые непосредственно выполняются (может включать путь к скрипту)
* includes — список всех FTL-скриптов, которые используются для подключения к другим скриптам.

=== Пример файла project.yaml ===
myproject
features:
- columnSettings
- events
- interfaceComments
- logging
l10n: ru
bugtrackers:
bugzilla: MyHome/MyProject
projectFileStructure: {}
modules:
- attributes: {}
- beanexplorer:
entities:
- _system_
- users
- geo:
entities: territories
extras:
- kladr
- okato
- workflow: {}
- utils: {}
application:
- _welcome_
scripts:
- Post-meta
- data
- dictionaries
includes: common
properties:
- REGION: '54'

Компиляция и запуск BeanExplorer4

2014-08-22T06:46:23Z

Yagmik:

=== Простой запуск ===
Простой запуск:
# убедиться, что установлена Java 8 (JRE достаточно);
# поместить исходники be4 в C:\projects\java\be4;
# взять Eclipse IDE for Java EE Developers, Eclipse Luna SR2 из этой папки: \\logrus.dote.ru\pub2\be4;
# отсюда же устанавливаем наши плагины, для этого заходим в Help -> Install New Software..., Add... копируем file:////logrus.dote.ru/pub2/be4/com.beanexplorer.be4.site/ в Location, OK, снимаем галочку Group items by category (если список фич пуст), ставим галочку на BeanExplorer4, Next и т.д.

После перезагрузки Eclipse для работы с BE4 нужно будет выбрать перспективу BeanExplorer. При этом (или же при запуске Eclipse) Eclipse спросит, откуда взять исходники be4, если не догадается об их местоположении. В случае, если be4 находится в C:\projects\java\be4, то всё должно происходить само. Эти исходники нужны только для загрузки модулей.

Известный баг: если be4 помещён не в C:\projects\java\be4, то Eclipse каждый раз при запуске будет спрашивать местонахождение be4.

=== Запуск из-под Eclipse ===
Для компиляции необходимы
# '''Java 8''' [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html отсюда],
# '''Eclipse IDE for Java EE Developers''', Eclipse '''Luna SR2''' [http://www.eclipse.org/downloads/packages/release/luna/sr2 отсюда],
# '''Наша версия Freemarker IDE''' - обычно мы импортируем проекты org.freemarker.core и org.jboss.ide.eclipse.freemarker из публичного репозитория https://github.com/amaembo/jbosstools-freemarker.git (см. ниже),
# '''IvyDE''' - устанавливается из Eclipse MarketPlace,
# '''YEdit''' - устанавливается из Eclipse MarketPlace,
# Наш проект '''common''' - его необходимо импортировать в workspace.
# Наш проект '''beclipse''' - его необходимо также импортировать в workspace. Живёт в <каталог с проектами>/be4.
Необходимо создать API baseline. Для этого заходим в Window -> Preferences, Plug-in Development -> API Baselines, там вводим любое Name, нажимаем Reset, Finish, Apply, OK.

Необходимо создать конфигурацию запуска. Заходим в "Debug Configurations..." (можно нажать Ctrl+3 и начать печатать "Debug Configurations"), там кликаем два раза на Eclipse Application, открываем вкладку Plug-ins, выбираем "Launch with: all workspace and enabled target plug-ins", нажимаем Apply, Debug (потом при запуске просто будем нажимать F11 вместо входа сюда). Помимо этого см. настройки запуска ниже.

Для проверки того, что всё установлено и будет корректно работать, нужно зайти на вкладку Plug-ins конфигурации запуска и там нажать "Validate Plug-ins" чтобы убедиться, что все необходимые плагины имеются.
----

=== Варианты установки Freemarker IDE ===
==== Вариант 1 (запуск без исходного кода Freemarker IDE). ====
Установить содержимое \\files.dote.ru\pub2\_be4\Installation\freemarker.feature.zip
# Заходим в... Help->Install New Software. Add...->Archive... выбрать архив, OK.
# Снять галочку "Group items by category", если не видно пунктов для установки.

==== Вариант 2 (для разработчиков Freemarker IDE). ====
# Необходим репозиторий https://github.com/amaembo/jbosstools-freemarker.git
# После скачивания репозитория нужно импортировать два проекта:
#*- org.freemarker.core
#*- org.jboss.ide.eclipse.freemarker. Остальные проекты можно не импортировать или просто закрыть.
# Windows -> Preferences; Plug-In Development -> API Baselines; ввести произвольное имя, Reset, Finish, Apply, OK.

=== Настройки запуска: ===
# Run->Debug Configurations..., выбрать Eclipse Application, нажать New launch configuration.
# Выбрать каталог в Workspace data (лучше создать новый пустой, например, c:\projects\be4-workspace).
# Execution environment -> Java 1.8.
# Вкладка Arguments Скопировать это значение в поле VM Arguments: '''-Dosgi.requiredJavaVersion=1.8 -Xms256m -Xmx768m -ea'''
# Apply, Debug.

BeanExplorer4

2014-08-22T06:34:35Z

Lan:

== Как начать работу с BeanExplorer 4 ==
Для установки: смотрите «[[Установка BeanExplorer4]]».

Есть три способа начать работать с проектом BeanExplorer 4.
# Взять готовый проект. В таком случае просто откройте перспективу BeanExplorer, сделайте импорт проекта обычным способом, а затем кликните на проект или project.yaml правой кнопкой мыши (во view Project Explorer) и выберите "BeanExplorer -> Open BeanExplorer Project". Проект появится во view с названием Model.
# Преобразовать старый BeanExplorer-проект. Для этого выберите File->New->Project..., BeanExplorer->New BeanExplorer Project Using Database Connection (более короткий способ это сделать - это выбрать пункт меню BeanExplorer->Quick Load Using Database Connection, если уже есть профиль для подключения к базе данных). Если нет ни одного профиля для подключения к СУБД, его надо создать, нажав "Create a new connection profile" и введя всю необходимую информацию для подключения, а также выбрав JDBC драйвер. Пароль обязательно сохранить. Можно это [[BeanExplorer4#Как создать новый профиль подключения к БД|сделать до начала создания проекта, обычными средставми Eclipse DTP]]. После нажатия на кнопку "Finish" загруженный проект должен отобразиться во view "Model". Преобразование может быть неточным и придётся его доделывать вручную. Кроме того, не сохранятся никакие M4 макросы.
# Создать новый проект.
#* File -> New -> Project...
#* BeanExplorer -> BeanExplorer Project, Next
#* Ввести имя проекта, изначальный список ролей, допустимых в проекте, и набор поддерживаемых языков (роли и языки всегда можно будет добавить ещё).
#* Выбрать набор используемых модулей и фитч. Модули аналогичны самим BeanExplorer4 проектам. Модуль 'beanexplorer' всегда добавляется в проект безусловно, поэтому его нельзя выбрать самому.
#* Заполнить параметры подключения к базе данных. У нас в проектах всегда используются connection profiles и Eclipse DTP, поэтому для начала работы с BeanExplorer4 сначала необходимо создать базу данных и connection profile для её использования. Тестовый пользователь - одновременно и администратор базы данных и пользователь-администратор из создаваемого BeanExplorer4 приложения.
# Создать новый проект возможно и из консоли. Для этого запускается Ant target с именем 'wizard' (зайти в консоли в папку 'be4/src' и напечатать 'ant wizard', если у вас установлен Ant).

== Описание по каждому редактору и view ==
* Model (view). Дерево проекта.
* Properties (view). Свойства выделенного в дереве проекта элемента.
* Documentation (view). Документация к выделенному в дереве проекта элементу.
* Tasks (view). Отображает все маркеры @todo и @check, найденные в документации ко всем элементам проекта и при необходимости скачивает задачи с ERP или Bugzilla. Для того, чтобы связать открытый проект с ERP, необходимо в его свойствах (Properties view!) заполнить поле 'ERP project identifier'. Аналогично для связи с Bugzilla имеется поле 'Bugzilla product name'. Помимо этих полей потребуеются логин и пароль, которые возможно ввести на странице BeanExplorer в настройках (Window->Preferences) (если они не введены, при попытке подключиться к ERP или Bugzilla BeanExplorer4 предложит вам ввести их в диалоговом окошке). Для того, чтобы связать какое-нибудь задание из документации с багом в Bugzilla или ERP, в начале его текста нужно указать номер бага с префиксом 'bug' или 'erp' соответственно: например, в тексте документации будет "@todo bug12345 исправить систему подсчёта X".
* Security (view). Таблица с правами ролей для каждого запроса и каждой операции. Реагирует на то, какой редактор открыт или какой элемент в дереве проектов выбран, и в соответствии с последним выбранным элементов фильтрует таблицу. Если в дереве проектов выбран модуль, то будут отображаться только операции и запросы из этого модуля, если entity, то отображаются только те операции и запросы, что относятся к данной entity. Фильтр по ролям позволяет выбрать все операции и запросы, которые может выполнять выбранная роль.
* Diagram (editor). Редактор диаграмм. Позволяет открывать .dml файлы и редактировать несколько их видов. Диаграммы каждого вида возможно создать пустыми выбором соответствующего пункта в основном меню BeanExplorer (BeanExplorer->Create *** Diagram/Board). Поддерживаемые виды диаграмм:
** ER модели. Могут быть открыты посредством клика на модуль и выбора "Create Diagram From This Module".
** EPC (Event-Process Chain) диаграммы.
** CFF (Cross-Functional Flowchart) диаграммы.
** Planning boards - доски с задачами.
* Diagram Layout (view). Позволяет перераспределить элементы ER диаграмы. Всегда относится к диаграмме из редактора ER, которым пользовались последним.
* SQL Editor (editor). Позволяет редактировать SQL запросы - открывается при клике на запросы в дереве проекта. Почти то же самое, что и SQL редактор из Eclipse DTP. Позволяет запускать SQL запросы (правый щелчок мышью->Execute All). Отличается от оригинального тем, что, во-первых, не сохраняет изменения в файл (при попытке сохранить изменения окажутся в модели BeanExplorer 4), а, во-вторых, позволяет запускать SQL с учётом макропроцессора FreeMarker и [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer/beanexplorerdocrus плейсхолдеров BeanExplorer] (правый щелчок мышью->Run или "Run BeanExplorer SQL Query" на toolbar'е).
* Query Executor (view).
** Позволяет определить контекст выполнения SQL запроса - посредством выбора своих параметров запроса или сессии (при этом запрос пока выполняется только под администратором).
** Позволяет посмотреть результаты запуска SQL запроса. Автоматически активируется при SQL запросе. Позволяет посмотреть результаты запроса как в виде простой таблицы, так и в виде HTML после обработки в BeanExplorer, а также посмотреть обработанные представления запроса — после макропроцессора FreeMarker и в чистом SQL виде.
* JavaScript Editor (editor). Позволяет редактировать JavaScript скрипты - открывается при клике на JavaScript/server операции в дереве проекта. Почти то же самое, что и обычный JavaScript редактор из Eclipse JSDT. Отличается тем, что позволяет запускать Rhino JavaScript ("Run JavaScript" на toolbar'е или "Execute" в Operation Parameters view). Результат вызова операции открывается в браузере.
* Operation Parameters (view). Позволяет определить контекст выполнения JavaScript/server операции посредством задания параметров и выбранных строчек. Также позволяет выбрать метод для запуска: getParameters(), invoke() или getRedirectURL() (последний пока не поддерживается).
* Localization (view). [[Localizations|Локализация]], относящаяся к выделенному в дереве проектов элементу. Отображается при выборе entity, operation или query.

== Основная информация для понимания BeanExplorer 4 ==
# Основное представление проекта BeanExplorer 4 - это не база данных, не YAML проект, а дерево проекта в Model view. При открытии BeanExplorer 4 проекта, он оказывается в Model view. И только при сохранении он сериализуется в YAML
# Основные простейшие действия с проектом - создание/удаление сущностей (entities), операций (operation) и запросов (query) - делаются из контекстного меню (pop-up) в Model view.
# Если с каким-нибудь узлом дерева проекта может быть связан редактор, то при выделении этого узла открывается редактор. Например, для JavaScript/server операции открывается JavaScript редактор, для 1D запроса - SQL редактор, для custom step - текстовый редактор, для Java операции открывается Java редактор (если .java файл с соответствующим именем находится в рабочем пространстве Eclipse). Некоторые редакторы при сохранении никак не меняют файлы - файлы будут изменены только при сохранении проекта.
# У большинство элементов из дерева проекта есть свойства, которые возможно редактировать в Properties view.
# Для любого подключения к базе данных необходим connection profile ([http://help.eclipse.org/helios/index.jsp?topic=%2Forg.eclipse.datatools.connectivity.doc.user%2Fdoc%2Fhtml%2Fasc1229700343352.html в документации по Kepler]). При импорте готового проекта connection profile создаётся автоматически, однако вручную всё же необходимо выбрать к нему JDBC Connector (если СУБД для подключения используется впервые). Connection Profile необходим как для SQL запросов из обычного SQL редактора Eclipse DTP, так и для запросов BeanExplorer. Настройки connection profiles находятся в разделе проекта "Connection profiles", в "папочках" Local и Remote. Эти настройки сохраняются в XML при сохранении BeanExplorer 4 проекта, а при его открытии воссоздаются, и если Eclipse DTP не имеет connection profiles с соответствующими именами, то они будут созданы. Конкретнее - эти настройки хранятся в двух файлах: connectionProfiles.local.xml и connectionProfiles.remote.xml, причём предполагается, что .local вписан в .gitignore, а .remote - нет. Для возможности подключиться к базе данных всегда должен быть выбран в качестве текущего какой-нибудь connection profile. Выбирается он в свойствах проекта (Properties view, "Connection profile name") - в соответствующем combo box отображаются только те профили, которые есть в Local или Remote. Добавить новый connection profile в проект BeanExplorer 4 возможно через контекстное меню (для этого его сначала необходимо создать в Data Source Explorer view (из Eclipse DTP)).

== Работа с BeanExplorer 4 для аналитиков ==
Для некоторых типов элементов из дерева проектов возможно приписывать комментарии/документацию. На данный момент это следующие типы элементов:
* проект,
* модули (в т.ч. application),
* сущности (entities - всё, что находится внутри модуля в папках Collections, Dictionaries, Tables, Generic Collections, Metadata),
* операции,
* запросы.
Документация отображается в Documentation view. Если в документации элемента есть маркер @todo или @check, то строка с этим маркером окажется и в другом view: Tasks. При клике на какую-либо строчку из Tasks будет выделен соответствующий ей элемент в Model view.

[[Файл:Analyst1.png]]

=== Возможности назначения ролей ===
* Все роли перечислены в свойствах проекта. При клике на список ролей ("Project roles" в Properties view при выбранно проекте) появляется панель, позволяющая добавлять роли.
* Для операций и запросов роли назначаются во view Security.

[[Файл:Analyst2.png]]

== Usecases ==
Перенесены [[Usecases|сюда]].

== Компиляция и запуск Eclipse с плагином BeanExplorer4 ==
Здесь: [[Компиляция и запуск BeanExplorer4]] (инструкции для тех, кто запускает Eclipse BeanExplorer4 из под другого экземпляра Eclipse).

== Структура проекта BeanExplorer 4 ==
[[Структура проекта|Структура]] проекта BeanExplorer 4

== Процесс разработки ==
=== Использование Ant ===
[[Использование ant|Использование Ant]]

=== Использование шаблонов Freemarker ===
Использование шаблонов [[Freemarker|Freemarker]]

=== JavaScript Debugger ===
Текущее состояние [[JavaScript Debugger|JavaScript Debugger]]

=== Поддержка СУБД ===
Поддержка [[Поддержка СУБД|различных СУБД]]

== Полезная информация, которая может помочь при работе с BeanExplorer 4 ==
=== Как устанавливать плагины/фитчи из архива ===
# Заходим в... Help->Install New Software. Add...->Archive... выбрать архив, OK.
# Снять галочку "Group items by category", если не видно пунктов для установки. Это может занять продолжительное время, т.к. с основного репозитория Eclipse будут скачиваться недостающие плагины.

=== Где взять редактор YAML ===
Update site: <code>http://dadacoalition.org/yedit</code>

(Site: [https://code.google.com/p/yedit/ https://code.google.com/p/yedit/])

=== Где взять редактор FreeMarker ===
Update site: <code>http://download.jboss.org/jbosstools/updates/stable/kepler/</code>

Или:

Help->Eclipse Marketplace... ищем "JBoss Tools", жмём Install у JBoss Tools (Kepler), снимаем галочку со всего и выбираем JBoss Tools (Kepler)->FreeMarker IDE.

=== Как настроить Tomcat для возможности подгрузить изменения в class-файлах. ===
1. Add the following lines into /conf/tomcat-users.xml (inside the root element <tomcat-users>):
<role rolename="manager-script"/>
<user username="tomcat" password="tomcat" roles="manager-script"/>

2. Create /conf/Catalina/localhost/manager.xml with the following content:
<Context privileged="true" antiResourceLocking="false"
docBase="${catalina.home}/webapps/manager">
<Valve className="org.apache.catalina.valves.RemoteAddrValve"
allow="127\.0\.0\.1" />
</Context>

Подробнее [http://tomcat.apache.org/tomcat-7.0-doc/manager-howto.html здесь] и [http://www.mulesoft.com/tcat/tomcat-reload здесь].

3. You can change the username or the password, but you should ensure that your connection profile uses these username and password. Beside this you can change the URL that will be called to refresh Tomcat. Note that this action uses the Tomcat application name from the connection profile. Tomcat path should be set too.

=== Как создать новый профиль подключения к БД ===
* Переключиться в перспективу Database Development. (В Eclipse почти в правом верхнем углу нажать квадратную кнопку с плюсиком "Open Perspective" и выбрать там "Database Development").
* Во view Data Source Explorer кликнуть правой кнопкой мыши на Database Connections, New....
* Выбрать в диалоговом окне тип используемой БД (напр., PostgreSQL), ввести нормальное имя для подключения (например, "condo"), Next.
* Ввести параметры подключения, их можно узнать у администратора БД. При первом создании профиля подключения с данным типом СУБД необходимо выбрать драйвер СУБД (для этого нажать круглишок с плюсиком у combo "Driver", а в появившемся диалоге на второй вкладке обычно необходимо удалить выбранный драйвер и выбрать свой - мы для удобство поместили все драйвера в папку lib из be4).
* Next, Finish.
* Новый профиль появится в списке Database Connections во view Data Source Explorer.

= Для разработчиков =
[[Для разработчиков BE4|Сюда]]

Заглавная страница

2014-08-21T06:57:27Z

Uuinnk:

=== BeanExplorer4 ===
* [[BeanExplorer4]]
** [[Для разработчиков BE4]]
* [[Установка BeanExplorer4]] (для пользователей)
* [[Компиляция и запуск BeanExplorer4]] (для разработчиков)
* [[Сборка BE4 и BE-SQL]] (для разработчиков)
* [[Использование ant]]
* [[Поддержка СУБД]]
* [[Типы колонок]]
* [[Структура проекта]]
* [[Usecases|Usecases с картиночками]]
* [[JavaScript Debugger]]
* [[Extras]]
* [[Entity template|Шаблоны для сущностей]]

=== Freemarker ===
* [[Freemarker]]
* [[Встроенные функции]]
* [[Макросы]]
* [[Объекты]]
* [[Пользовательские макросы]]
* [[Создание своих макросов]]
* [[Built-ins]]

=== BeanExplorer5 ===
Новая версия переехала на [https://github.com/developmentontheedge https://github.com/developmentontheedge]

* [[BeanExplorer5|BeanExplorer5]]
* [[BeanExplorer5 API|BeanExplorer5 API]]
* [[BE-SQL|SQL-диалект BeanExplorer5]]
* [[Сборка BeanExplorer5 проекта|Сборка BE5 проекта]]

----

=== Внешние ссылки ===
* BeanExplorer4 на Edge Wiki [https://sites.google.com/a/developmentontheedge.com/wiki/home/proektnaadokumentacia/beanexplorer4]
----
Количество статей в вики: '''[[:Special:Statistics|{{NUMBEROFARTICLES}}]]'''.