WebSVN – DevTools – Diff – /EA_DocGen/trunk/EA_DocGen/EA_Utilities.cs

       public virtual void processPackage( EA.Package thePackage )
+      {
+      }
+   }
 	/// <summary>
 	/// Class containing functions that implement the EA_DocGen menu items.
 	/// </summary>
 	public class EA_Utilities
+	{
          guid_clipboard = new GUID_Clipboard(this);
          options = new EA_DocGenOptions(this);
          EA_Finder = new EA_Finders();
          EA_RelMatrix = new EA_RelationshipMatrix(this);
+		}
       public void accept_EA_RepositoryRef(EA.Repository EA_RepositoryRef)
+      {
          EA_Repository = EA_RepositoryRef;
          EA_Finder.accept_EA_RepositoryRef(EA_RepositoryRef);
+      }
+      public void modifyOptions()
+      {
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         if (objType == EA.ObjectType.otElement)
+         {
+            EA.Element ele = (EA.Element)obj;
+            if (0 == ele.Name.CompareTo(EA_Constants.EA_DocGenBaseName))
+            {
+               if (true == options.lookForAndProcess_EA_DocGen_Element( ele ))
+               {
+                  EA_DocGenOptionsForm dlg = new EA_DocGenOptionsForm();
+                  dlg.populate(EA_Repository, options);
+                  DialogResult dlgRes = dlg.ShowDialog();
+                  if (dlgRes == DialogResult.OK)
+                  {
+                     dlg.read(EA_Repository, options);
+                     options.updateEA_DocGen(ele);
+                  }
+               }
+            }
+         }
+      }
       /// <summary>
       /// Begins the document generation process, opening the dialog to capture input/output
       /// files. the createWordDoc dialog class does most of the work ofcoarse.
       /// </summary>
          if (objType == EA.ObjectType.otPackage)
+         {
             // Make sure this package has an EA_DocGen element
             if (true == options.lookForAndProcess_EA_DocGen_Element( ((EA.Package)obj) ))
+            {
                // bring up the dialog for doc generation
                createWordDoc dialog = new createWordDoc(EA_Repository, ((EA.Package)obj), this);
                dialog.Text = "Generate Document From Model Layout";
-               dialog.ShowDialog();                  }
+               dialog.ShowDialog();
+            }
             else
+            {
                MessageBox.Show("EA_DocGen document model packages must contain an EA_DocGen element");
+            }
+         }
          else
+         {
             MessageBox.Show("You must select a package whose content is to be formed into a document");
          }
+      }
       /// <summary>
       /// Creates a package under the specified parent package. the package is given a tree position
       /// as specified in order for it to be ordered in the model as the caller requires.
       /// </summary>
       /// <param name="parentPackage"></param>
          EA.Package newobj = (EA.Package)parentPackage.Packages.AddNew(name, "Package");
          newobj.TreePos = treePos;
          newobj.Update();
          return newobj;
+      }
       /// <summary>
       /// Generate a package hierarchy that reflects the document layout of BMS-00289, the
       /// ERG Product Software Design Document.
       /// </summary>
          object obj;
          objType = EA_Repository.GetTreeSelectedItem( out obj );
          if (objType == EA.ObjectType.otPackage)
+         {
             if (  ((EA.Package)obj).Packages.Count == 0
                && ((EA.Package)obj).Elements.Count == 0
                && ((EA.Package)obj).Diagrams.Count == 0 )
+            {
                EA.Package parentPackage = ((EA.Package)obj);
                newobj = createPackage(parentPackage, "Requirements Traceability", 7);
                // create an EA_DocGen element
                EA.Element newElement = (EA.Element)parentPackage.Elements.AddNew( "EA_DocGen", "InformationItem" );
+               newElement.Notes = "[ElementTypes]\r\nRequirement\r\nClass\r\nComponent\r\n";
+               newElement.Update();
+               parentPackage.Packages.Refresh();
+               // refresh project browser view
+               EA_Repository.RefreshModelView(parentPackage.PackageID);
+            }
+            else
+            {
+               MessageBox.Show("Can only insert layout into an empty package");
+            }
+         }
+         else
+         {
+            MessageBox.Show("You must select a package into which the layout will be inserted");
+         }
+      }
+      /// <summary>
+      /// Generate a package hierarchy that reflects a basic document layout.
+      /// </summary>
+      public void create_basic_Layout()
+      {
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         if (objType == EA.ObjectType.otPackage)
+         {
+            if (  ((EA.Package)obj).Packages.Count == 0
+               && ((EA.Package)obj).Elements.Count == 0
+               && ((EA.Package)obj).Diagrams.Count == 0 )
+            {
+               EA.Package parentPackage = ((EA.Package)obj);
+               EA.Package newobj = null;
+               EA.Package newobj2 = null;
+               //EA.Package newobj3 = null;
+               //EA.Package newobj4 = null;
+               //EA.Package newobj5 = null;
+               newobj  = createPackage(parentPackage, "Introduction", 1);
+               newobj2 = createPackage(newobj, "Purpose", 1);
+               newobj2 = createPackage(newobj, "Scope", 2);
+               newobj2 = createPackage(newobj, "Terminology", 3);
+               newobj2 = createPackage(newobj, "References", 4);
+               newobj  = createPackage(parentPackage, "Section 2 (rename me as required)", 2);
+               newobj  = createPackage(parentPackage, "Section 3 (rename me as required)", 3);
+               // create an EA_DocGen element
+               EA.Element newElement = (EA.Element)parentPackage.Elements.AddNew( EA_Constants.EA_DocGenBaseName,
+                                                                                  EA_Constants.EA_DocGenElementType );
+               newElement.Notes = "[ElementTypes]\r\nRequirement\r\nClass\r\nComponent\r\n";
                newElement.Update();
                parentPackage.Packages.Refresh();
                // refresh project browser view
             MessageBox.Show("You must select a package into which the layout will be inserted");
+         }
+      }
       /// <summary>
       /// This function works its way up the parental hierarchy to the root model, collecting the
       /// strings names of each package and prepending them to a string accumulator with a view to
       /// obtaing the full path of an element,diagram, or package.
       /// </summary>
       /// <param name="parentId"></param>
       /// <param name="instr"></param>
       /// <returns></returns>
             pkg = EA_Repository.GetPackageByID( parentId );
             if (pkg != null)
+            {
                instr = pkg.Name + "/" + instr;
                instr = GetPackagePath(pkg.ParentID, instr);
             }
+         }
          return instr;
+      }
       private void copy_GUID_to_clipboard(object obj, EA.ObjectType objType, bool confirm)
+      {
          guid_clipboard.copy(obj, objType, confirm);
+      }
       /// <summary>
       /// For the selected item, copy its GUID to the internal add-in GUID clipboard and the
       /// global external clipboard. Also copy to the internal add-in GUID clipboard, the name of
       /// the element and its type. This will support the AddLinkElement() method.
       /// </summary>
       public void copy_GUID_to_clipboard()
+      {
          objType = EA_Repository.GetTreeSelectedItem( out obj );
          guid_clipboard.copy(obj, objType, true);
+      }
+      public void AddTestTraceabilityElement()
+      {
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         AddTestTraceabilityElement(obj, objType);
+      }
+      public void AddTestTraceabilityElement(object obj, EA.ObjectType objType)
+      {
+         if (objType == EA.ObjectType.otPackage)
+         {
+            object newobj = null;
+            newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTestTraceability, EA_Constants.EA_DocGenElementType);
+            if (newobj != null)
+            {
+               ((EA.Element)newobj).Update();
+            }
+         }
+         else
+         {
+            MessageBox.Show("You must select a package into which the element will be inserted");
+         }
+      }
+      /// <summary>
+      /// Using the internal add-in GUID clipboard, paste a test link element into the selected
+      /// package.
+      /// </summary>
+      public void AddTestLinkElement()
+      {
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         AddTestLinkElement(obj, objType);
+      }
+      private void AddTestLinkElement(object obj, EA.ObjectType objType)
+      {
+         if (objType == EA.ObjectType.otPackage)
+         {
+            object newobj = null;
+            if (   guid_clipboard.objType == EA.ObjectType.otElement
+                || guid_clipboard.objType == EA.ObjectType.otPackage)
+            {
+               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTestLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);
+               if (newobj != null)
+               {
+                  ((EA.Element)newobj).Notes = guid_clipboard.name + "\r\n" + guid_clipboard.guid;
+                  ((EA.Element)newobj).Update();
+               }
+            }
+            else
+            {
+               MessageBox.Show("The GUID clipboard must first contain the GUID of an element (normally, a class), or a package");
+            }
+         }
+         else
+         {
+            MessageBox.Show("You must select a package into which the test link will be inserted");
+         }
+      }
+      /// <summary>
+      /// Using the internal add-in GUID clipboard, paste a link element into the selected
+      /// package.
+      /// </summary>
+      public void AddLinkElement()
+      {
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         AddLinkElement(obj, objType);
+      }
       private void AddLinkElement(object obj, EA.ObjectType objType)
+      {
          if (objType == EA.ObjectType.otPackage)
+         {
             object newobj = null;
             if (guid_clipboard.objType == EA.ObjectType.otPackage)
+            {
-               newobj = ((EA.Package)obj).Elements.AddNew("EA_DocGenPackageLink - " + guid_clipboard.name, "InformationItem");
+               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenPackageLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);
+            }
             else if (guid_clipboard.objType == EA.ObjectType.otDiagram)
+            {
-               newobj = ((EA.Package)obj).Elements.AddNew("EA_DocGenDiagramLink - " + guid_clipboard.name, "InformationItem");
+               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenDiagramLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);
+            }
             else if (guid_clipboard.objType == EA.ObjectType.otElement)
+            {
-               newobj = ((EA.Package)obj).Elements.AddNew("EA_DocGenElementLink - " + guid_clipboard.name, "InformationItem");
+               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenElementLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);
+            }
             else if (guid_clipboard.objType == EA.ObjectType.otAttribute)
+            {
                MessageBox.Show("Attribute links are not currently supported");
+            }
+            }
+         }
          else
+         {
             MessageBox.Show("You must select a package into which the link will be inserted");
          }
+      }
-      /// <summary>
-      /// Using the internal add-in GUID clipboard, paste a link element into the selected
-      /// package.
-      /// </summary>
-      public void AddLinkElement()
+      public void AddTableElement()
+      {
          EA.ObjectType objType;
          object obj;
          objType = EA_Repository.GetTreeSelectedItem( out obj );
+         if (objType == EA.ObjectType.otPackage)
+         {
+            object newobj = null;
+            newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTable, EA_Constants.EA_DocGenElementType);
+            if (newobj != null)
+            {
+               ((EA.Element)newobj).Notes = "title=insertYourTitleHere\r\n"
+                                          + "columns=2\r\n"
+                                          + "seperator=,\r\n"
+                                          + "column1Title,column2Title\r\n"
+                                          + "cellcontent,cellcontent\r\n"
+                                          + "etc,etc";
+               ((EA.Element)newobj).Update();
+            }
+         }
+         else
+         {
+            MessageBox.Show("You must select a package into which the Table Element will be inserted");
+         }
+      }
+      public void AddTextElement()
+      {
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         if (objType == EA.ObjectType.otPackage)
+         {
+            object newobj = null;
+            newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenText, EA_Constants.EA_DocGenElementType);
+            if (newobj != null)
+            {
+               ((EA.Element)newobj).Notes = "Add your text here.";
+               ((EA.Element)newobj).Update();
+            }
+         }
+         else
+         {
+            MessageBox.Show("You must select a package into which the Text Element will be inserted");
+         }
+      }
+      public void AddRelationshipMatrixElement()
+      {
-         AddLinkElement(obj, objType);
+         EA.ObjectType objType;
+         object obj;
+         objType = EA_Repository.GetTreeSelectedItem( out obj );
+         if (objType == EA.ObjectType.otPackage)
+         {
+            object newobj = null;
+            newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenRelationshipMatrix, EA_Constants.EA_DocGenElementType);
+            if (newobj != null)
+            {
+               ((EA.Element)newobj).Notes  = EA_RelMatrix.optionTemplateForRelationshipMatrix();
+               ((EA.Element)newobj).Update();
+            }
+         }
+         else
+         {
+            MessageBox.Show("You must select a package into which the RelationshipMatrix Element will be inserted");
+         }
+      }
       public void GeneratePackagesFromElementList()
+      {
                EA.Package theFoundPackage = EA_Finder.findPackageInRepositoryByGUID(guid_clipboard.guid);
                if (theFoundPackage != null)
+               {
                   EA.Package srcPackage = theFoundPackage;
                   EA.Package destPackage = ((EA.Package)obj);
                   foreach( EA.Element srcElement in srcPackage.Elements)
+                  {
                      if (false == EA_Finder.elementNameExistsInPackage(destPackage, srcElement.Name.ToString()))
+                     {
                         createPackage(destPackage, srcElement.Name.ToString(), 1);
+                     }
+                  }
                }
+            }
             else
+            {
                MessageBox.Show("You must first copy a Source Package GUID to the clipboard");
+            }
                EA.Package theFoundPackage = EA_Finder.findPackageInRepositoryByGUID(guid_clipboard.guid);
                if (theFoundPackage != null)
+               {
                   EA.Package srcPackage = theFoundPackage;
                   EA.Package destPackage = ((EA.Package)obj);
                   foreach( EA.Package subPackage in srcPackage.Packages)
+                  {
                      copy_GUID_to_clipboard( (object)subPackage, EA.ObjectType.otPackage, false);
                      AddLinkElement( (object)destPackage, EA.ObjectType.otPackage);
+                  }
                }
+            }
             else
+            {
                MessageBox.Show("You must first copy a Source Package GUID to the clipboard");
+            }
                EA.Package theFoundPackage = EA_Finder.findPackageInRepositoryByGUID(guid_clipboard.guid);
                if (theFoundPackage != null)
+               {
                   EA.Package srcPackage = theFoundPackage;
                   EA.Package destPackage = ((EA.Package)obj);
                   foreach( EA.Element subElement in srcPackage.Elements)
+                  {
                      copy_GUID_to_clipboard( (object)subElement, EA.ObjectType.otElement, false);
                      AddLinkElement( (object)destPackage, EA.ObjectType.otPackage);
+                  }
                }
+            }
             else
+            {
                MessageBox.Show("You must first copy a Source Package GUID to the clipboard");
+            }
+         }
          else
+         {
             MessageBox.Show("You must select a Destination Package into which the Element Links will be inserted");
          }
+      }
+      /// <summary>
+      /// This function is designed to parse EA models/packages in a predefined way, whilst allowing
+      /// a user to specify what processing is to be done upon or with each element found.
+      /// </summary>
+      /// <param name="thePackage"></param>
+      /// <param name="worker"></param>
-      public void AddTableElement()
+      /// <param name="recurse"></param>
+      public void findAndProcessPackageElements( EA.Package thePackage, EA_UtilitiesRecursionWorker worker, bool recurse)
+      {
-         EA.ObjectType objType;
+         worker.processPackage( thePackage );
-         object obj;
-         objType = EA_Repository.GetTreeSelectedItem( out obj );
-         if (objType == EA.ObjectType.otPackage)
+         foreach (EA.Element theElement in thePackage.Elements)
+         {
-            object newobj = null;
+            worker.processElement( theElement );
+         }
-            newobj = ((EA.Package)obj).Elements.AddNew("EA_DocGenTable", "InformationItem");
-            if (newobj != null)
+         if (recurse == true)
+         {
+            foreach (EA.Package subPackage in thePackage.Packages)
+            {
-               ((EA.Element)newobj).Notes = "title=insertYourTitleHere\r\n"
-                                          + "columns=2\r\n"
-                                          + "seperator=,\r\n"
-                                          + "column1Title,column2Title\r\n"
-                                          + "cellcontent,cellcontent\r\n"
-                                          + "etc,etc";
+               // RECURSION
-               ((EA.Element)newobj).Update();
+               findAndProcessPackageElements( subPackage, worker, true);
+            }
+         }
-         else
-         {
-            MessageBox.Show("You must select a package into which the Table Element will be inserted");
-         }
+      }
-      public void AddTextElement()
+      public void addDocumentReference()
+      {
          EA.ObjectType objType;
          object obj;
          objType = EA_Repository.GetTreeSelectedItem( out obj );
          if (objType == EA.ObjectType.otPackage)
+         {
-            object newobj = null;
+            DocReferenceForm dlg = new DocReferenceForm();
-            newobj = ((EA.Package)obj).Elements.AddNew("EA_DocGenText", "InformationItem");
+            DialogResult dlgRes = dlg.ShowDialog();
-            if (newobj != null)
+            if (dlgRes == DialogResult.OK)
+            {
+               object newobj = null;
+               newobj = ((EA.Package)obj).Elements.AddNew(dlg.textBox_DocNumber.Text, EA_Constants.EA_DocGenElementType);
+               if (newobj != null)
+               {
-               ((EA.Element)newobj).Notes = "Add your text here.";
+                  ((EA.Element)newobj).Notes = dlg.textBox_DocName.Text;
-               ((EA.Element)newobj).Update();
+                  ((EA.Element)newobj).Update();
+               }
+            }
+         }
-         else
-         {
-            MessageBox.Show("You must select a package into which the Text Element will be inserted");
-         }
+      }
-      public void AddRelationshipMatrixElement()
+      public void addTerminology()
+      {
          EA.ObjectType objType;
          object obj;
          objType = EA_Repository.GetTreeSelectedItem( out obj );
          if (objType == EA.ObjectType.otPackage)
+         {
-            object newobj = null;
+            TerminologyForm dlg = new TerminologyForm();
-            newobj = ((EA.Package)obj).Elements.AddNew("EA_DocGenRelationshipMatrix", "InformationItem");
+            DialogResult dlgRes = dlg.ShowDialog();
-            if (newobj != null)
+            if (dlgRes == DialogResult.OK)
+            {
-               ((EA.Element)newobj).Notes  = EA_RelMatrix.optionTemplateForRelationshipMatrix();
-               ((EA.Element)newobj).Update();
+               object newobj = null;
-            }
-         }
-         else
-         {
-            MessageBox.Show("You must select a package into which the RelationshipMatrix Element will be inserted");
-         }
-      }
-      /// <summary>
-      /// This function is designed to parse EA models/packages in a predefined way, whilst allowing
-      /// a user to specify what processing is to be done upon or with each element found.
-      /// </summary>
-      /// <param name="thePackage"></param>
-      /// <param name="worker"></param>
-      /// <param name="recurse"></param>
-      public void findAndProcessPackageElements( EA.Package thePackage, EA_UtilitiesRecursionWorker worker, bool recurse)
-      {
-         worker.processPackage( thePackage );
-         foreach (EA.Element theElement in thePackage.Elements)
+               newobj = ((EA.Package)obj).Elements.AddNew(dlg.textBox_Term.Text, EA_Constants.EA_DocGenElementType);
-         {
-            worker.processElement( theElement );
+               if (newobj != null)
-         }
+               {
-         if (recurse == true)
+                  ((EA.Element)newobj).Notes = dlg.textBox_TermExpansion.Text;
-         {
-            foreach (EA.Package subPackage in thePackage.Packages)
+                  ((EA.Element)newobj).Update();
-            {
+               }
-               // RECURSION
-               findAndProcessPackageElements( subPackage, worker, true);
             }
+         }
+      }
       #region Temporary or experimental code
       /// <summary>
+            }
+          }
          else
+         {
             MessageBox.Show("You must select a package");
          }
+      }
       #endregion
+	}

Subversion Repositories DevTools

(root)/EA_DocGen/trunk/EA_DocGen/EA_Utilities.cs – Rev 2088 → 2094