Modelujte, nekreslete
Poměrně dlouho jsem sliboval rozšíření pro Sparx EA, které dokáže pracovat s Jira isues. Konečně je k dispozici „hmatatelný“ výsledek: Cheeky EA Connector for Jira®, který spojuje svět Atlassian Jira a modely v nástroji Sparx Enterprise Architect ve své vůbec první oficiální verzi. Číst více
Při programování rozšíření pro EA jsem narazil na další chybu. Funkce Repository.GetContextItemType() nevrací správnou hodnotu, pokud máte vybraný model v Project Browseru. Namísto hodnoty otModel dostanete otNone, což není úplně zdravé. Chybu jsem poslal do Sparxu, ale údajně o ní již dlouho vědí, ovšem do opravy se jim zřejmě nechce. Než se tak stane, můžete použít následující funkci, které problém řeší:
protected EA.ObjectType temporaryGetContextItemType(EA.Repository Repository) {
EA.ObjectType vOT = Repository.GetContextItemType();
if (vOT == EA.ObjectType.otNone)
//try it to retype to Package and check if it is a model...
//if anything gets wrong, forget it
try {
if (((EA.Package)(Repository.GetContextObject())).ParentID == 0)
return EA.ObjectType.otModel;
} catch { }
return vOT;
}
Funkce v případě, že GetContextItemType vrátí otNone, tak zkusí vybraný objekt přetypovat na balík a zjistit jeho ParentID. Pokud se to povede a hodnota je rovna nule, jde o model, jinak je to cokoliv jiného, chybné přetypování odchytím v sítu výjimek a navrátím původní hodnotu.
Pokud budete dále pracovat s balíkem, který je vlastně modelem, tak také dejte pozor na to, že jeho vlastnost Element je null (což se v dokumentaci nedozvíte). Není to od autorů hezké.
A drobnost na závěr: funkce očekává, že máte otevřený nějaký projekt. Že tomu tak opravdu je, byste si měli zajistit sami např. vhodným povolením či zakázáním jejího volání v EA_GetMenuState.
Vytvořit vlastní rozšíření (plug-in) pro Enterprise Architect je velmi snadné, rychlé a dokonce bez dalších nákladů na programovací nástroje. Jak tedy na to?
Předpokládám, že máte nainstalovaného Enterprise Architecta (pro uvedené pokusy stačí i dosud funkční trial verze). Dále budete potřebovat nějaký programovací nástroj. Jestliže nechcete do něj vkládat jakékoliv peníze, použijte Express edici Visual Studia od Microsoftu. Já sám používám VS Express 2013 for Desktop s jazykem C#. Pokud tedy i to máte, můžeme přikročit k vlastní tvorbě (ukázky budou právě v C#).
using System;
using System.Windows.Forms;
namespace OCUPBlokPlugin
{
public class MyFirstEAPlugin
{
///
/// Tuto metodu volá EA aby zjistil, jakého typu je náš plugin.
/// Můžeme buďto zvolit MDG, pokud tvoříme plugin tohoto typu, jinak
/// vrátíme prázdný řetězec, čímž říkáme, že jde o obecný plugin.
///
/// Budeme ignorovat.
/// Vrátíme prázdný řetězec.
public String EA_Connect(EA.Repository Repository)
{
return "";
}
///
/// Metoda je volána při ukončování EA. Takže po sobě zkusíme trošku uklidit.
///
public void EA_Disconnect()
{
GC.Collect();
GC.WaitForPendingFinalizers();
}
///
/// Definujeme si někteté položku v Menu
///
const string menuHeader = "-&OCUP blok plug-in";
const string menuItemAbout = "&About...";
///
/// Pokud EA potřebuje znát seznam položek menu, pak se zavolá tato metoda
///
/// Repository jako taková
/// Umístění menu
/// Název menu
///
public object EA_GetMenuItems(EA.Repository Repository, string Location, string MenuName)
{
switch (MenuName)
{
// Jde o hlavní položku, vrátíme náš název
case "":
return menuHeader;
// a zde vrátíme všechny naše položky mmenu
case menuHeader:
string[] subMenus = { menuItemAbout };
return subMenus;
}
return "";
}
///
/// Tady se nás EA ptá, zda má položku v menu povolit nebo zakázat.
/// Můžeme tak reagovat na různé stavy (např. zdali je otevřen nějaký projekt).
///
///
///
///
///
///
///
public void EA_GetMenuState(EA.Repository Repository, string Location, string MenuName, string ItemName, ref bool IsEnabled, ref bool IsChecked)
{
switch (ItemName)
{
case menuItemAbout:
IsEnabled = true;
break;
default:
IsEnabled = false;
break;
}
}
///
/// Konečně! Někdo zvolil některé z našeho menu, takže směle do toho.
///
///
///
///
///
public void EA_MenuClick(EA.Repository Repository, string Location, string MenuName, string ItemName)
{
switch (ItemName)
{
case menuItemAbout:
MessageBox.Show("OCUP blok plug-in. Hello, EA user!");
break;
default:
MessageBox.Show("Neobsloužená položka menu!");
break;
}
}
}
}Nyní máte sestavenou a zaregistrovanou knihovnu. Posledním krokem je říct EA, aby ji používal. K tomu stačí drobný zásah do registrů:
A je hotovo! Teď můžete svůj výtvor otestovat.
Pokud máte nějaký software na tvorbu instalačních souborů, tak máte vyhráno, zachovejte se podle jeho instrukcí. V opačném případě je třeba postupovat následovně:
%WINDIR%Microsoft.NETFrameworkv4.0.30319regasm OCUPBlokPlugin.dll /codebase
Teď už je to na vás. Podívejte se na uvedené metody začínající na EA_ a prostudujte si nápovědu, co vše lze tvořit. Možností je mnoho. Pro vaši potřebu si můžete stáhnout celé zdrojové kódy uvedeného příkladu zde.