Creating Items in Sparx EA via Java

-

Introduction


This short post provides guidance on how to create "things" in a Sparx EA model via the Java API.

Theory


Creating "things" in EA via Java is driven by the Add New method and the Collection class. The first example in the code is adding a "view" to an existing root node. The code below will retrieve the root GUID if the "i" variable is set to 0;


rootPackageID = rep.GetModels().GetAt(i).GetPackageGUID();

After obtaining the root GUID it is possible to create a view under the root node. Note the process of retrieving the packages under the root and placing them in a collection. The Add New process is driven from the Collection.

Importantly, for a view, the code needs to set a flag which indicates a particular icon. This process is only required for views.

org.sparx.Package root = rep.GetPackageByGuid(rootPackageID);  // get the root 

Collection<org.sparx.Package> subPackages = root.GetPackages(); // get the packages in the root

org.sparx.Package theView = subPackages.AddNew(viewName, ""); // create a view under the root 

theView.SetFlags("VICON=4;");   // This is a flag which indicates that the package is a view.
                                            // The different numbers indicate a specific icon.
                                            // The values are from 0 to 5.

theView.Update();  // update the packages

viewPackageGUID = theView.GetPackageGUID();   // store the GUID for the view, use it later

rep.GetModels().Refresh();  // refresh the repo

More Examples

You can find additional examples on GitHub. The code is commented which makes it easy to follow.




Comments

Post a Comment

Popular posts from this blog

Module Management - Part 1 - getModule() Pattern

-
As discussed in  Module Management - Analysis , EA does not provide support for the ubiquitous Module Pattern .  This becomes an issue with an increase in complexity of model addins.  In order to a) Minimise the management of dependencies, and b) Cater for the use of 3rd party modules, The  framework  provides an analogous pattern, which I'm calling the getModule() pattern, because I lack imagination. The premise is straight forward.  Rather than having an anonymous self executing function returning a module object, we instead have module class elements which have a method called "getModule()"  and this returns a module object when the method is called. The getModule() method would be declared (via the EA interface) on a class element, and then we would place all of the module's code in the body of the getModule() method/operation.  The method would return a module object to the caller. The sample contents of a typical getModule() operation might look like this.
Read more

Traversing a EA Model via Java

-
Traversing an Enterprise Architect model from Sparx Systems is relatively simple. This blog introduces the concept of model traversal via the Java API. For information on Java Set-Up see this blog entry . The first step is to obtain the repository object as it provides the anchor from which all other operations are derived. In the example below, a repository is held on the file system. The variable "repoLocation" holds the file system location of the "eap" file.   rep = new Repository();  // get a repository   rep.OpenFile(repoLocation);  //open the repository file At the top of a model is a root node and it is typically where you want to start when traversing a model. From the root node you can then obtain a collection of packages. At this point, it is easy to traverse the collection pulling in the packages via a loop and in this example printing out their names. To see the complete example, go to GitHub .   org.sparx.Package myMode
Read more