WebSVN – DevTools – Diff – /EA_ReqPro/trunk/EA_ReqPro/CopyReqProDatabase.cs

       /// <summary>
       /// Method to parse a ReqPro database and copy it into an EA database.
       /// </summary>
       /// <param name="ea_repository"></param>
       /// <returns></returns>
-      public override bool prompt_and_parse(ReqProDB_Artifact.MODE mode)
+      public override bool prompt_and_parse(ReqProDB_Artifact.MODE mode, out bool cancelled)
+      {
+         cancelled = false;
          try
+         {
             // use the base classes parser to read the ReqPro database content and allow the user to
             // filter it.
+            base.structure_only = false;
+            string importDateTime = System.DateTime.Now.ToString();
+            Main.WriteOutput("EA Requirement import at " + importDateTime, -1 );
+            Main.WriteOutput("",-1);
-            if (true == base.prompt_and_parse(mode))
+            if (true == base.prompt_and_parse(mode, out cancelled))
+            {
                if (Main.mustAbort)
                   return false;
                try
                   // if there are existing requirement elements or sub-packages...
                   if (reqElementsFound == true
                      || ea_rootPackage.Packages.Count > 0)
+                  {
+                     DialogResult dlgRes = MessageBoxEx.Show(
-                     DialogResult dlgRes = MessageBoxEx.Show("Package is not empty, delete existing content first?", "Confirm", MessageBoxButtons.YesNo);
+                        "ReqPro import package is not empty. Delete existing content\n" +
+                        "first?\n\nNOTE:\n" +
+                        "For DocModel imports, normally YES is the desired action here.\n" +
+                        "All sub-packages within the ReqPro import package will be\n" +
+                        "deleted along with any requirement elements found within the\n" +
+                        "package itself, so that the import will begin with a clean sheet.\n" +
+                        "If you have done any local modelling under the package, that work\n" +
+                        "will be lost. In future, do all such modelling elsewhere, and leave\n" +
+                        "the ReqPro import package alone to be updated solely by the\n" +
+                        "EA_ReqPro add-in's DocModel import operation.",
+                        "Confirm",
+                        MessageBoxButtons.YesNoCancel);
                      if (dlgRes == DialogResult.Yes)
+                     {
                         // Delete packages and requirement elements
                         short i;
                         for(i=0; i < ea_rootPackage.Packages.Count; i++)
+                        }
                         ea_rootPackage.Packages.Refresh();
                         // refresh project browser view
                         Main.EA_Repository.RefreshModelView(ea_rootPackage.PackageID);
+                     }
+                     else if (dlgRes == DialogResult.Cancel)
+                     {
+                        cancelled = true;
+                        return false;
+                     }
+                  }
+               }
                catch (Exception ex)
+               {
                   Main.MessageBoxException(ex, "Exception (CopyReqProDatabase)");
                if (Main.mustAbort)
                   return false;
                writeDelayedMessages();
-               Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "Import Completed", -1);
+               Main.WriteOutput("Import Completed", -1);
                MessageBoxEx.Show("Import Completed", "Progress");
                return true;
+            }
+         }
          catch (Exception ex)
+         {
             Main.MessageBoxException(ex, "Exception (parse)");
          }
          return false;
+      }
       /// gritty of it occurs in the other overloaded method.
       /// </summary>
       /// <param name="ea_repository"></param>
       private void write_ea_database()
+      {
-         Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "Copying ReqPro Database Content to EA", -1);
+         Main.WriteOutput("Copying ReqPro Database Content to EA", -1);
          foreach( ReqPro_object sub_obj in rq_root_package.ReqPro_objects )
+         {
             if (Main.mustAbort)
                break;
                if (ea_parent_package != null)
+               {
                   // create a representative package in EA
                   EA.Package new_ea_package = EA_Utilities.createPackage(ea_parent_package, rq_obj.name, rq_obj.treePos);
                   rq_obj.ea_element_ID = new_ea_package.PackageID;
-                  Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "Created Package : " + rq_obj.name, new_ea_package.PackageID );
+                  Main.WriteOutput("Created Package : " + rq_obj.name, new_ea_package.PackageID );
                   // Using recursion, scan this objects sub-objects
                   foreach( ReqPro_object sub_obj in rq_obj.ReqPro_objects )
+                  {
                      if (Main.mustAbort)
+                  }
+               }
                else
+               {
                   // should never get here - I have never seen it happen so far.
-                  Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "ERROR,write_ea_database, parent package was null", -1);
+                  Main.WriteOutput("ERROR,write_ea_database, parent package was null", -1);
+               }
+            }
             else if (base.allowPackageStructureFragments)
+            {
                // Using recursion, scan this objects sub-objects
+         {
             if ( ! (reqTypeIsFiltered(rq_obj) || reqStatusTypeIsFiltered(rq_obj)))
+            {
                string rq_obj_name = rq_obj.tag + " " + rq_obj.name;
+               EA.Element new_ea_element = null;
                // If needed, create the requirement element as a child of a parent element
                if (ea_parent_element != null)
+               {
-                  totalRequirements++;
                   // create a representative element in EA
-                  EA.Element new_ea_element = (EA.Element)ea_parent_element.Elements.AddNew(rq_obj_name, "Requirement");
+                  new_ea_element = (EA.Element)ea_parent_element.Elements.AddNew(rq_obj_name, "Requirement");
-                  rq_obj.ea_element_ID = new_ea_element.ElementID;
-                  Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "Created Element : " + rq_obj_name, new_ea_element.ElementID );
+                  Main.WriteOutput("Created Element : " + rq_obj_name, new_ea_element.ElementID );
                   // In ReqPro, a requirement can be related to another requirement in several ways:
                   // 1. By virtue of its position relative to another in the browser display. That is,
                   //    if you place a requirement beneath a parent requirement, you are establishing a
                   //    parent-child relationship.
-                  // 2. By virtue of a specific TraceTo relationship being made via the Traceability menu
+                  // 2. By virtue of a specific TraceTo/TraceFrom relationship being made via the Traceability menu
                   //    option.
                   // Interestingly, ReqPro prevents you creating a relationship of one of the above types,
                   // if a relationship of the other type already exists. This implies that the relationship
                   // between a parent and child requirement must be singular and is important regardless
                   // of the manner in which it was created or represented.
                   // relationships detected from ReqPro made using method 2 above. What we need to do here is
                   // take care of those apparent from the browser based hierarchical organisation (ie. made
                   // in ReqPro using method 1).
                   // All we need to do is grab the parent object (if any) and add the GUID of the child to
                   // its list of trace-to's. Later on, the write_traces() class method will turn these into
-                  // EA based connection objects that belong to the parent requirement elements.
+                  // EA based connection objects
                   if (rq_obj.parent != null)
+                  {
                      rq_obj.parent.ReqPro_traces.Add(rq_obj.guid);
+                  }
-                  // If the ReqPro requirements detailed text is more than what the name already contains (allowing for it
-                  // to have a stop character that the name may not have) then copy it over, otherwise ignore it. This
-                  // prevents the same text appearing twice in any generated document made using EA_DocGen.
-                  if (!rq_obj.text.StartsWith(rq_obj.name) || (rq_obj.text.Length > (rq_obj.name.Length + 1)))
-                     new_ea_element.Notes = rq_obj.text;
-                  new_ea_element.TreePos = rq_obj.treePos;
-                  new_ea_element.Status  = rq_obj.status;
-                  new_ea_element.Update();
-                  // Write EA tag information exactly as is done for the import for traceability use. This
-                  // opens up the possibility that a document model import could be converted into a traceability
-                  // use model in some future update to EA_ReqPro addin.
-                  EA_Utilities.WriteTag(new_ea_element, "GUID", rq_obj.guid);
-                  EA_Utilities.WriteTag(new_ea_element, "TAG", rq_obj.tag);
-                  if (rq_obj.source != null)
-                     EA_Utilities.WriteTag(new_ea_element,"SOURCE", rq_obj.source);
-                  if (rq_obj.sourceVersion != null)
-                     EA_Utilities.WriteTag(new_ea_element,"SOURCE_VERSION", rq_obj.sourceVersion);
-                  if (rq_obj.sourceSection != null)
-                     EA_Utilities.WriteTag(new_ea_element,"SOURCE_SECTION", rq_obj.sourceSection);
-                  // Using recursion, scan this objects sub-objects
-                  foreach( ReqPro_object sub_obj in rq_obj.ReqPro_objects )
-                  {
-                     if (Main.mustAbort)
-                        break;
-                     write_ea_database(null, new_ea_element, sub_obj);  // recurse
-                  }
+               }
                // else create the requirement element as a child of a parent package
                else if (ea_parent_package != null)
+               {
+                  // create a representative element in EA
+                  new_ea_element = (EA.Element)ea_parent_package.Elements.AddNew(rq_obj_name, "Requirement");
+                  Main.WriteOutput("Created Element : " + rq_obj_name, new_ea_element.ElementID );
+               }
+               else
+               {
+                  // should never get here - I have never seen it happen so far.
+                  Main.WriteOutput("ERROR, write_ea_database, parent package was null", -1);
+               }
+               if (new_ea_element != null)
+               {
                   totalRequirements++;
-                  // create a representative element in EA
-                  EA.Element new_ea_element = (EA.Element)ea_parent_package.Elements.AddNew(rq_obj_name, "Requirement");
                   rq_obj.ea_element_ID = new_ea_element.ElementID;
-                  Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "Created Element : " + rq_obj_name, new_ea_element.ElementID );
-                  // If the ReqPro requirements detailed text is more than what the name already contains (allowing for it
-                  // to have a stop character that the name may not have) then copy it over, otherwise ignore it. This
-                  // prevents the same text appearing twice in any generated document made using EA_DocGen.
-                  if (!rq_obj.text.StartsWith(rq_obj.name) || (rq_obj.text.Length > (rq_obj.name.Length + 1)))
+                  new_ea_element.TreePos = rq_obj.treePos; // deliberately dont do TreePos in copyReq()
-                     new_ea_element.Notes = rq_obj.text;
-                  new_ea_element.TreePos = rq_obj.treePos;
-                  new_ea_element.Status  = rq_obj.status;
-                  new_ea_element.Update();
+                  copyReq(new_ea_element, rq_obj);
-                  // Write EA tag information exactly as is done for the import for traceability use. This
-                  // opens up the possibility that a document model import could be converted into a traceability
-                  // use model in some future update to EA_ReqPro addin.
-                  EA_Utilities.WriteTag(new_ea_element, "GUID", rq_obj.guid);
-                  EA_Utilities.WriteTag(new_ea_element, "TAG", rq_obj.tag);
-                  if (rq_obj.source != null)
+                  new_ea_element.Update();
-                     EA_Utilities.WriteTag(new_ea_element,"SOURCE", rq_obj.source);
-                  if (rq_obj.sourceVersion != null)
-                     EA_Utilities.WriteTag(new_ea_element,"SOURCE_VERSION", rq_obj.sourceVersion);
-                  if (rq_obj.sourceSection != null)
-                     EA_Utilities.WriteTag(new_ea_element,"SOURCE_SECTION", rq_obj.sourceSection);
                   // Using recursion, scan this objects sub-objects
                   foreach( ReqPro_object sub_obj in rq_obj.ReqPro_objects )
+                  {
                      if (Main.mustAbort)
                         break;
                      write_ea_database(null, new_ea_element, sub_obj);  // recurse
+                  }
+               }
-               else
-               {
-                  // should never get here - I have never seen it happen so far.
-                  Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "ERROR,write_ea_database, parent package was null", -1);
-               }
+            }
+         }
+      }
+      public static void copyReq(EA.Element new_ea_element, ReqPro_object rq_obj)
+      {
+         // If the ReqPro requirements detailed text is more than what the name already contains (allowing for it
+         // to have a stop character that the name may not have) then copy it over, otherwise ignore it. This
+         // prevents the same text appearing twice in any generated document made using EA_DocGen.
+         if (!rq_obj.text.StartsWith(rq_obj.name) || (rq_obj.text.Length > (rq_obj.name.Length + 1)))
+            new_ea_element.Notes = rq_obj.text;
+         new_ea_element.Status     = rq_obj.status;
+         new_ea_element.Difficulty = rq_obj.difficulty;
+         new_ea_element.Priority   = rq_obj.priority;
+         new_ea_element.Version    = rq_obj.version;
+         // Write EA tag information exactly as is done for the import for traceability use. This
+         // opens up the possibility that a document model import could be converted into a traceability
+         // use model in some future update to EA_ReqPro addin.
+         EA_TaggedValues.Write(new_ea_element, Constants.TAG_GUID, rq_obj.guid);
+         EA_TaggedValues.Write(new_ea_element, Constants.TAG_TAG, rq_obj.tag);
+         if (rq_obj.source != null && rq_obj.source.Length > 0)
+            EA_TaggedValues.Write(new_ea_element,Constants.TAG_SOURCE, rq_obj.source);
+         if (rq_obj.sourceVersion != null && rq_obj.sourceVersion.Length > 0)
+            EA_TaggedValues.Write(new_ea_element,Constants.TAG_SOURCE_VERSION, rq_obj.sourceVersion);
+         if (rq_obj.sourceSection != null && rq_obj.sourceSection.Length > 0)
+            EA_TaggedValues.Write(new_ea_element,Constants.TAG_SOURCE_SECTION, rq_obj.sourceSection);
+         if (rq_obj.subsystem != null && rq_obj.subsystem.Length > 0)
+            EA_TaggedValues.Write(new_ea_element,Constants.TAG_SUBSYSTEM, rq_obj.subsystem);
+         if (rq_obj.stability != null && rq_obj.stability.Length > 0)
+            EA_TaggedValues.Write(new_ea_element,Constants.TAG_STABILITY, rq_obj.stability);
+         if (0 > new_ea_element.StereotypeEx.IndexOf(rq_obj.type))
+         {
+            if (new_ea_element.StereotypeEx.Length > 0)
+               new_ea_element.StereotypeEx = rq_obj.type + "," + new_ea_element.StereotypeEx;
+            else
+               new_ea_element.StereotypeEx = rq_obj.type;
+         }
+         if (new_ea_element.Stereotype.Length == 0)
+         {
+            new_ea_element.Stereotype = new_ea_element.StereotypeEx.Split(",".ToCharArray())[0];
+         }
+      }
+	}

Subversion Repositories DevTools

(root)/EA_ReqPro/trunk/EA_ReqPro/CopyReqProDatabase.cs – Rev 2153 → 2155