ST6RI-830 Revised QualifiedNameUtil to abstract global scoping impl.

Author: seidewitz

org.omg.kerml.xtext/src/org/omg/kerml/xtext/naming/KerMLQualifiedNameConverter.xtend

@@ -43,13 +43,12 @@ class KerMLQualifiedNameConverter implements IQualifiedNameConverter {
 		Preconditions.checkArgument(!qualifiedNameAsText.empty, "Qualified name cannot be empty")
 
 		val segments = ElementUtil.parseQualifiedName(qualifiedNameAsText)		
-		QualifiedName.create(segments)
+		QualifiedNameUtil.createQualifiedName(segments)
 	}
 
 	override toString(QualifiedName name) {
-		Preconditions.checkArgument(name !== null, "Qualified name cannot be null")
-			
-		ElementUtil.toQualifiedNameString(name.segments)
+		Preconditions.checkArgument(name !== null, "Qualified name cannot be null")			
+		QualifiedNameUtil.toQualifiedNameString(name)
 	}
 
 }

org.omg.kerml.xtext/src/org/omg/kerml/xtext/naming/QualifiedNameUtil.java

@@ -23,15 +23,34 @@
  */
 package org.omg.kerml.xtext.naming;
 
+import java.util.List;
+
 import org.eclipse.xtext.naming.QualifiedName;
 import org.omg.sysml.util.ElementUtil;
 
+/**
+ * This class provides utility methods for qualified names that abstracts the representation of
+ * globally scoped qualified names. The current implementation presumes that globally scoped
+ * qualified names are represented as Xtext QualifiedNames whose first symbol is specific
+ * String identified by ElementUtil.isGlobalScopeSymbol.
+ */
 public class QualifiedNameUtil {
 
-	public static boolean isGlobalNameQualification(QualifiedName qualifiedName) {
+	public static QualifiedName createQualifiedName(List<String> segments) {
+		return QualifiedName.create(segments);
+	}
+	
+	public static boolean isGlobalScopeQualification(QualifiedName qualifiedName) {
 		return qualifiedName != null &&
 				qualifiedName.getSegmentCount() > 0 &&
 				ElementUtil.isGlobalScopeSymbol(qualifiedName.getFirstSegment()); 
 	}
 
+	public static QualifiedName getNonGlobalQualifiedName(QualifiedName qualifiedName) {
+		return isGlobalScopeQualification(qualifiedName)? qualifiedName.skipFirst(1): qualifiedName;
+	}
+	
+	public static String toQualifiedNameString(QualifiedName qualifiedName) {
+		return ElementUtil.toQualifiedNameString(qualifiedName.getSegments());
+	}
 }

org.omg.kerml.xtext/src/org/omg/kerml/xtext/scoping/KerMLGlobalScope.xtend

@@ -79,13 +79,11 @@ class KerMLGlobalScope extends AbstractScope {
 	}
 
 	override getSingleElement(QualifiedName name) {
-		val isGlobalQualification = QualifiedNameUtil.isGlobalNameQualification(name)
-		val qualifiedName = isGlobalQualification? name.skipFirst(1) : name
-			
+		val qualifiedName = QualifiedNameUtil.getNonGlobalQualifiedName(name)							
 		var IEObjectDescription result = null
 
 		if (qualifiedName.segmentCount > 0) {
-			if (isGlobalQualification) {
+			if (QualifiedNameUtil.isGlobalScopeQualification(name)) {
 				//search the context resource first
 				val rootNS = resource.contents.head as Namespace
 				result = scopeFor(rootNS).getSingleElement(qualifiedName)

org.omg.kerml.xtext/src/org/omg/kerml/xtext/scoping/KerMLScope.xtend

@@ -168,7 +168,7 @@ class KerMLScope extends AbstractScope implements ISysMLScope {
 	}
 
 	override getSingleElement(QualifiedName name) {
-		if (QualifiedNameUtil.isGlobalNameQualification(name)){
+		if (QualifiedNameUtil.isGlobalScopeQualification(name)){
 			parent.getSingleElement(name)
 		} else {
 			val result = resolveInScope(name, true);

org.omg.sysml/src/org/omg/sysml/util/ElementUtil.java

@@ -96,7 +96,7 @@ public static String unescapeString(String literal) {
 	}
 
 	/**
-	 * Return a string that is the same as the input string,  but with escapable characters
+	 * Return a string that is the same as the input string, but with escapable characters
 	 * replaced by appropriate escape sequences.
 	 */
 	public static String escapeString(String str) {
@@ -114,15 +114,19 @@ public static String escapeString(String str) {
 	}
 
 	public static String escapeName(String name) {
-		return (name == null || name.isEmpty() || isIdentifier(name))? name:
+		return (name == null || name.isEmpty() || isIdentifier(name) || isGlobalScopeSymbol(name))? name:
 			   "'" + escapeString(name) + "'";	
 	}
 
 	public static boolean isIdentifier(String name) {
 		return name.matches("[a-zA-Z_]\\w*");
 	}
 
-	// Specific string used to identify a segment as a global scope qualifier
+	// Qualified Names
+	
+	/**
+	 * Specific string used to identify a segment as a global scope qualifier
+	 */
 	public static final String GLOBAL_SCOPE_SYMBOL = "$";
 
 	public static boolean isGlobalScopeSymbol(String segment) {
@@ -184,17 +188,9 @@ public static String toQualifiedNameString(List<String> segments) {
 			return builder.toString();
 		}
 	}
-
-	/**
-	 * Get documentation text for this element, as given by the body of the first documentation comment
-	 * annotating the element (if any).
-	 */
-	public static String getDocumentationTextFor(Element element) {
-		return element.getDocumentation().stream().
-				map(Comment::getBody).
-				findFirst().orElse(null);
-	}
 
+	// Library Elements
+
 	public static boolean isStandardLibraryElement(Element element) {
 		Namespace libraryNamespace = element.libraryNamespace();
 		return libraryNamespace instanceof LibraryPackage && 
@@ -251,6 +247,16 @@ public static List<MetadataFeature> getAllMetadataFeaturesOf(Element element) {
 		return metadataFeatures;
 	}
 
+	/**
+	 * Get documentation text for this element, as given by the body of the first documentation comment
+	 * annotating the element (if any).
+	 */
+	public static String getDocumentationTextFor(Element element) {
+		return element.getDocumentation().stream().
+				map(Comment::getBody).
+				findFirst().orElse(null);
+	}
+	
 	public static String processCommentBody(String body) {
 		if (body != null) {
 			body = body.replaceFirst("/\\*", "").replaceFirst("^\\s*", "");