Для разработчиков BE4 - История изменений

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

2014-12-05T10:18:06Z

‎Автосериализация

Asko в 09:55, 5 декабря 2014

2014-12-05T09:55:24Z

Asko в 09:38, 5 декабря 2014

2014-12-05T09:38:55Z

Asko в 09:34, 5 декабря 2014

2014-12-05T09:34:34Z

Asko: /* MVVM и упрощение написания UI */

2014-12-05T09:01:40Z

‎MVVM и упрощение написания UI

Asko в 08:58, 5 декабря 2014

2014-12-05T08:58:46Z

Asko в 08:57, 5 декабря 2014

2014-12-05T08:57:58Z

Asko: /* UI */

2014-12-05T08:33:08Z

‎UI

Asko: /* Ядро */

2014-12-05T08:30:05Z

‎Ядро

Asko в 07:55, 5 декабря 2014

2014-12-05T07:55:41Z

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

@@ Строка 104: / Строка 104: @@
 См. BeanExplorerPreferencesPage.createFieldEditors и BeanExplorerPreferences из com.beanexplorer.enterprise.eclipse.preferences.BeanExplorerPreferencesPage.
 === Статьи по SWT ===
 [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.
 А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.

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

← Предыдущая		Версия 09:34, 5 декабря 2014
Строка 64:		Строка 64:

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

	=== Статьи по SWT ===		=== Статьи по SWT ===

@@ Строка 59: / Строка 59: @@
 Многие команды представляют собой одностраничные 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 с использованием шаблона проектирования 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 или его методов).

@@ Строка 56: / Строка 56: @@
 com.beanexplorer.enterprise.eclipse.dialogs.Dialogs - простые реализации диалоговых окошек, которых не хватает в org.eclipse.jface.dialogs.MessageDialog.
-==== MVVM и упрощение написания UI ====
+=== MVVM и упрощение написания UI ===
 Многие команды представляют собой одностраничные wizard'ы. Вместо того, чтобы писать с нуля, берём класс com.beanexplorer.enterprise.eclipse.handlers.templates.WizardCommandTemplateWizard, копируем в handlers, переименовываем (Alt+Shift+R) и заполняем всё что нужно.
@@ Строка 65: / Строка 65: @@
 Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).
-==== Статьи по SWT ====
+=== Статьи по SWT ===
 [http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.
 А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.

← Предыдущая		Версия 08:57, 5 декабря 2014
Строка 52:		Строка 52:
	* com.beanexplorer.enterprise.eclipse.views соответственно.		* com.beanexplorer.enterprise.eclipse.views соответственно.
	Аналогично командам, создаются через редактор, кликаем на com.beanexplorer.enterprise.eclipse.editors, New -> editor, заполняем необходимые поля. Аналогично со view. Замечу, что клик на метку "class" позволяет создать нужный класс (в случае со view это org.eclipse.ui.part.ViewPart, например).		Аналогично командам, создаются через редактор, кликаем на 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).
		+
		+	Класс com.beanexplorer.enterprise.eclipse.jface.Ui вообще содержит гибкую основу для реализации MVVM UI (примеры можно найти поискав использования класса Ui или его методов).
		+
		+	Класс com.beanexplorer.enterprise.eclipse.jface.JFace предоставляет методы для частовстречающихся сценариев (как правило создания виджетов внутри Composite с GridLayout из двух столбцов).
		+
		+	==== Статьи по SWT ====
		+	[http://www.vogella.com/tutorials/SWT/article.html Вот здесь] вводная статья по SWT - объясняются основные концепции, какие виджеты бывают и как используются layout.
		+
		+	А [http://www.vogella.com/tutorials/EclipseJFaceTable/article.html здесь] статья про JFace - библиотеку, упрощающую работу с таблицами и деревьями.

@@ Строка 45: / Строка 45: @@
 ==== Замечание ====
-Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт
+Для того, чтобы найти класс с реализацией пункта меню, можно найти соответствующий пункт меню в редакторе plugin.xml, в нём будет указана команда, копируем имя команды в строку поиска в редакторе и находим нужный handler.
 === Редакторы и view ===
@@ Строка 51: / Строка 51: @@
 * 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, например).

@@ Строка 2: / Строка 2: @@
 На высоком уровне BE4 состоит из нескольких частей:
-* '''com.beanexplorer.enterprise.metadata*''' - ядро
+* '''com.beanexplorer.enterprise.metadata*''' - ядро;
-* com.beanexplorer.enterprise.metadata.ant - реализация Ant задач, объявленных в be4/src/be4lib.xml, эти классы не должны использоваться во время исполнения BEclipse
+* 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.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.eclipse - UI BEclipse и необходимые для его модельные элементы и view model;
-* com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string))
+* com.beanexplorer.enterprise.api - заготовка фасада для использования простейшего API в тестах: загрузка проекта из папки (projectApi = Facade.load(path)), получение корректного DatabaseConnector (projectApi.getDatabaseConnector()) и запуск Freemarker скриптов (projectApi.runFreemarkerScript(string));
-* com.beanexplorer.enterprise.diagrams - здесь и модельные элементы, и UI для диаграмм; новые виды диаграм легче всего добавлять по аналогии со старыми, смотря на уже готовые классы
+* 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.planning - здесь [http://ru.wikipedia.org/wiki/Model-View-ViewModel и Model, и ViewModel, и View] для для [[BeanExplorer4#Описание по каждому редактору и view|TasksView]].
-=== Ядро ===
+== Ядро ==
-* '''com.beanexplorer.enterprise.metadata*''' - ядро
+* '''com.beanexplorer.enterprise.metadata*''' - ядро.
-** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions]
+** exception - все базовые исключения для BE4, мы используем [http://en.wikipedia.org/wiki/Exception_handling#Checked_exceptions checked exceptions].
-** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]]
+** '''model*''' - самое сердце BE4 - модельные объекты, которые представляют собой [[Структура проекта|дерево проекта]], начиная с класса [[Project]].
-** sql -
+** sql - скачивание legacy метаданных (дерева проекта) из BE3 базы данных, синхронизация с базой данных.
-** serialization -
+** serialization - сохранённый на жёстком диске BE4 проект представляется как набор YAML файлов; данном пакете реализованы сериализация и десериализация YAML.
-** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl
+** freemarker - расширение Freemarker, в частности [[Built-ins|Be4BuiltIns]] и [[Встроенные функции|DatabaseFunctions]], [[макросы]] находятся в be4/src/com/beanexplorer/enterprise/metadata/freemarker/macro/common.ftl.
-*** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor
+*** FreemarkerSqlHandler - получает на вход FreemarkerScript и запускает его как SQL, переадресуя сгенерированный текст в SqlExecutor.
-** util
+** util - базовые полезности; должны находиться в этом пакете, даже если используются только в UI
-=== UI ===
+== UI ==