ST6RI-682 Added javadoc, minor fixes and refactor

Author: TheKorpos

org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java

@@ -482,7 +482,7 @@ public String download(String publication, List<String> help) {
 			addResourceToIndex(xmiResource);
 		});
 
-		return "Loaded project: " + project.getProjectName();
+		return "Project loaded: " + project.getProjectName() + ", " + project.getProjectId().toString();
 	}
 
 	protected String download(String name) {

org.omg.sysml.xtext/src/org/omg/sysml/xtext/util/SysMLRepositoryLoadUtil.java

@@ -34,7 +34,6 @@
 import org.eclipse.emf.common.util.URI;
 import org.eclipse.emf.ecore.resource.ResourceSet;
 import org.omg.kerml.xtext.KerMLStandaloneSetup;
-import org.omg.sysml.util.ElementUtil;
 import org.omg.sysml.util.SysMLUtil;
 import org.omg.sysml.util.repository.EObjectUUIDTracker;
 import org.omg.sysml.util.repository.ProjectDelta;
@@ -99,24 +98,33 @@ public SysMLRepositoryLoadUtil(String repositoryURL, String projectName, String
 	}
 
 	public void load() {
-		System.out.println("Reading library");
+		ProjectRepository projectRepository = new ProjectRepository(repositoryURL);
+		RepositoryProject repositoryProject = projectRepository.getProjectByName(projectName);
+		
+		if (repositoryProject == null) {
+			System.err.println("Project does not exist.");
+			return;
+		}
+		
+		System.out.println("Reading library...");
 
 		readAll(localLibraryPath, false);
 
 		//collect ids from library
+		System.out.println("Tracking library UUIDs...");
 		EObjectUUIDTracker tracker = new EObjectUUIDTracker();
 		tracker.trackLibraryUUIDs(getLibraryResources());
 
-		ProjectRepository projectRepository = new ProjectRepository(repositoryURL);
-		//TODO change to name
-		RepositoryProject repositoryProject = projectRepository.getProjectById(projectName);
+		
 		RepositoryContentFetcher repositoryFetcher = new RepositoryContentFetcher(repositoryProject, tracker);
+		System.out.println("Fetching project...");
 		ProjectDelta delta = repositoryFetcher.fetch();
-		
 		ResourceSet resourceSet = getResourceSet();
-
+		
 		try {
-			delta.save(resourceSet, URI.createFileURI(projectName));
+			System.out.println("Saving resources...");
+			delta.save(resourceSet, URI.createFileURI(targetLocation));
+			System.out.println("Done.");
 		} catch (IOException e) {
 			e.printStackTrace();
 		}

org.omg.sysml/src/org/omg/sysml/util/repository/EObjectUUIDTracker.java

@@ -24,6 +24,7 @@
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.UUID;
 import java.util.function.BiConsumer;
 import java.util.function.Function;
 
@@ -35,19 +36,34 @@
 import org.omg.sysml.util.traversal.Traversal;
 import org.omg.sysml.util.traversal.facade.impl.ElementIdProcessingFacade;
 
+/**
+ * Class to track UUIDs while fetching from the repository. The tracker can be
+ * pre-populated by locally existing UUID. The standard library UUIDs are tracked separately
+ * and they shadow user UUIDs (non-standard library UUIDs).
+ */
 public class EObjectUUIDTracker {
-	private Map<Object, EObject> uuidToLibraryElement = new HashMap<>();
-	private Map<Object, EObject> uuidToUserElement = new HashMap<>();
+	private Map<UUID, EObject> uuidToLibraryElement = new HashMap<>();
+	private Map<UUID, EObject> uuidToUserElement = new HashMap<>();
 
+	/**
+	 * Collects UUIDs from the given library resources
+	 * 
+	 * @param libraryResources resources containing standard library models
+	 */
 	public void trackLibraryUUIDs(Collection<Resource> libraryResources) {
 		trackUUIDSFromResources(libraryResources, uuidToLibraryElement);
 	}
 
+	/**
+	 * Collects UUIDs from non-standard library models.
+	 * 
+	 * @param userResources resources containing user models
+	 */
 	public void trackUserUUIDs(Collection<Resource> userResources) {
 		trackUUIDSFromResources(userResources, uuidToUserElement);
 	}
 
-	private void trackUUIDSFromResources(Collection<Resource> resources,  Map<Object, EObject> uuidToElementMap) {
+	private void trackUUIDSFromResources(Collection<Resource> resources,  Map<UUID, EObject> uuidToElementMap) {
 		//avoid concurrent modification exception in the traversal by transforming the library
 		for (Resource resource: resources) {
 			if (resource instanceof XtextResource) {
@@ -65,30 +81,61 @@ private void trackUUIDSFromResources(Collection<Resource> resources,  Map<Object
 		});
 	}
 
+	/**
+	 * Checks if the tracker contains an index for the library
+	 * 
+	 * @return true if the library has been tracked
+	 */
 	public boolean isLibraryTracked() {
 		return !uuidToLibraryElement.isEmpty();
 	}
 
-	public void trackUserElement(Object uuid, EObject element) {
+	/**
+	 * Used to track a user element by its UUID
+	 *
+	 * @param uuid UUID to track
+	 * @param element element identified by the UUID
+	 */
+	public void trackUserElement(UUID uuid, EObject element) {
 		uuidToUserElement.put(uuid, element);
 	}
 
-	public EObject createIfMissingAndTrack(Object uuid, Function<? super Object, ? extends EObject> compute) {
+	/**
+	 * Returns the element if it has been tracked by its UUID
+	 * otherwise creates the element using the provided compute and tracks it.
+	 * 
+	 * @param uuid UUID of the element
+	 * @param compute Function to compute the Element in case it's not tracked
+	 */
+	public EObject createIfMissingAndTrack(UUID uuid, Function<? super UUID, ? extends EObject> compute) {
 		return uuidToUserElement.computeIfAbsent(uuid, compute);
 	}
 
-	public EObject get(Object uuid) {
+	/**
+	 * Returns the element identified by a UUID. Library UUIDs are checked first.
+	 * 
+	 * @return element identified by the provided UUID or null if UUID is not tracked
+	 */
+	public EObject get(UUID uuid) {
 		if (uuidToLibraryElement.containsKey(uuid)) {
 			return uuidToLibraryElement.get(uuid);
 		} else {
 			return uuidToUserElement.get(uuid);
 		}
 	}
 
-	public void forEachTrackedUserElement(BiConsumer<? super Object, ? super EObject> consumer) {
+	/**
+	 * Iterates user elements passing them to the provided consumer
+	 * 
+	 * @param consumer logic to execute on each element
+	 */
+	public void forEachTrackedUserElement(BiConsumer<? super UUID, ? super EObject> consumer) {
 		uuidToUserElement.forEach(consumer);
 	}
 
+	/**
+	 * Removes all user element from the tracker
+	 */
 	public void clearTrackedUserElements() {
 		uuidToUserElement.clear();
 	}

org.omg.sysml/src/org/omg/sysml/util/repository/ProjectDelta.java

@@ -49,8 +49,6 @@ public Map<EObject, Element> getProjectRoots() {
 	}
 
 	public void save(ResourceSet resourceSet, URI baseUri) throws IOException {
-		
-		
 		for (var root : projectRoots.keySet()) {
 			var dto = projectRoots.get(root);
 			Object object = dto.get("@id");