svn commit: r14232 - trunk/src/model/src/org/argouml/model/XmiReader.java

Author: tfmorris
Date: 2008-03-27 08:54:29-0700
New Revision: 14232

Modified:
   trunk/src/model/src/org/argouml/model/XmiReader.java

Log:
Add documentation on UUID map (which are no longer UUIDs)

Modified: trunk/src/model/src/org/argouml/model/XmiReader.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/model/src/org/argouml/model/XmiReader.java?view=diff&rev=14232&p1=trunk/src/model/src/org/argouml/model/XmiReader.java&p2=trunk/src/model/src/org/argouml/model/XmiReader.java&r1=14231&r2=14232
==============================================================================
--- trunk/src/model/src/org/argouml/model/XmiReader.java	(original)
+++ trunk/src/model/src/org/argouml/model/XmiReader.java	2008-03-27 08:54:29-0700
@@ -1,5 +1,5 @@
 // $Id$
-// Copyright (c) 1996-2007 The Regents of the University of California. All
+// Copyright (c) 1996-2008 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
@@ -73,6 +73,13 @@
 
     
     /**
+     * Get the map of external IDs to UML elements. For earlier versions of
+     * ArgoUML, the id was the xmi.uuid, but currently it is the xmi.id. These
+     * are unique within a given XMI file, but no attempt is made to make them
+     * globally unique. They are, however, guaranteed to remain stable across
+     * load/save cycles, so they can be used for external cross-references (e.g.
+     * from the PGML diagram files).
+     * 
      * @return the map
      */
     Map<String, Object> getXMIUUIDToObjectMap();