RESTWS-959: Support localization of Concepts via standard "ui.i18n.Co… (#633)

Author: mogoodrich

omod-1.8/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_8/ConceptResource1_8.java

@@ -462,9 +462,18 @@ public static List<ConceptMap> getMappings(Concept instance) {
 	 * @param instance the delegate instance to get the display name off
 	 */
 	@PropertyGetter("display")
-	public String getDisplayName(Concept instance) {
-		ConceptName cn = instance.getName();
-		return cn == null ? null : cn.getName();
+	public String getDisplayString(Concept instance) {
+		String localization = getLocalization("Concept", instance.getUuid());
+		if (StringUtils.isNotBlank(localization)) {
+			return localization;
+		} else {
+			ConceptName cn = instance.getName();
+			if (cn != null) {
+				return cn.getName();
+			} else {
+				return instance.toString();
+			}
+		}
 	}
 
 	/**

omod-1.8/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_8/RelationShipTypeResource1_8.java

@@ -220,7 +220,7 @@ public String getDisplayBIsToAe(RelationshipType delegate) {
 		}
 	}
 
-	private String getLocalization(String uuid, String type) {
+	protected String getLocalization(String uuid, String type) {
 		String code = "ui.i18n.RelationshipType" + "." + type + "." + uuid;
 		String localization = Context.getMessageSourceService().getMessage(code);
 		if (localization == null || localization.equals(code)) {

omod-1.9/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_9/ConceptResource1_9Test.java

@@ -12,6 +12,8 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -23,6 +25,8 @@
 import org.openmrs.ConceptName;
 import org.openmrs.api.ConceptNameType;
 import org.openmrs.api.context.Context;
+import org.openmrs.api.context.ServiceContext;
+import org.openmrs.messagesource.MessageSourceService;
 import org.openmrs.module.webservices.rest.SimpleObject;
 import org.openmrs.module.webservices.rest.web.RestTestConstants1_8;
 import org.openmrs.module.webservices.rest.web.representation.NamedRepresentation;
@@ -141,4 +145,50 @@ public void testGetNamedRepresentation() throws Exception {
 			Assert.assertFalse(e.getCause().getCause().getMessage().contains("Cycles in children are not supported."));
 		}
 	}
+
+	@Test
+	public void testGetDisplayName() throws Exception {
+		Concept concept = new Concept();
+		ConceptName fullySpecifiedName = new ConceptName("some name", new Locale("en", "US"));
+		fullySpecifiedName.setConceptNameId(1);
+		fullySpecifiedName.setConceptNameType(ConceptNameType.FULLY_SPECIFIED);
+		fullySpecifiedName.setLocalePreferred(false);
+		concept.addName(fullySpecifiedName);
+
+		ConceptResource1_9 resource = new ConceptResource1_9();
+		String result = resource.getDisplayString(concept);
+
+		Assert.assertEquals("some name", result);
+	}
+
+	@Test
+	public void testGetDisplayNameForConceptWithNoName() throws Exception {
+		Concept concept = new Concept(1);
+		ConceptResource1_9 resource = new ConceptResource1_9();
+		String result = resource.getDisplayString(concept);
+		Assert.assertEquals("1", result);  // this will need to updated to "Concept #1" when we start building against more recent versions of OpenMRS Core
+	}
+
+	@Test
+	public void testGetDisplayNameWithLocalizationOverride() throws Exception {
+
+		String UUID = "f0c5b621-3e5e-4f0d-8b9e-1d3e2b2c1b2d";
+
+		Concept concept = new Concept();
+		concept.setUuid(UUID);
+		MessageSourceService messageSourceService = mock(MessageSourceService.class);
+		when(messageSourceService.getMessage("ui.i18n.Concept.name." + UUID)).thenReturn("Overridden by message source");
+		ServiceContext.getInstance().setMessageSourceService(messageSourceService);
+
+		ConceptName fullySpecifiedName = new ConceptName("some name", new Locale("en", "US"));
+		fullySpecifiedName.setConceptNameId(1);
+		fullySpecifiedName.setConceptNameType(ConceptNameType.FULLY_SPECIFIED);
+		fullySpecifiedName.setLocalePreferred(false);
+		concept.addName(fullySpecifiedName);
+
+		ConceptResource1_9 resource = new ConceptResource1_9();
+		String result = resource.getDisplayString(concept);
+
+		Assert.assertEquals("Overridden by message source", result);
+	}
 }

omod-common/src/main/java/org/openmrs/module/webservices/rest/web/resource/impl/DelegatingCrudResource.java

@@ -14,6 +14,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.openmrs.api.context.Context;
 import org.openmrs.module.webservices.rest.SimpleObject;
 import org.openmrs.module.webservices.rest.web.ConversionUtil;
 import org.openmrs.module.webservices.rest.web.RequestContext;
@@ -292,4 +293,29 @@ public boolean isRetirable() {
 	public boolean isVoidable() {
 		return false;
 	}
+
+	/**
+	 * This code is largely copied from the UI Framework:
+	 * org.openmrs.ui.framework.FormatterImpl#format(org.openmrs.OpenmrsMetadata, java.util.Locale)
+	 *
+	 * @param shortClassName
+	 * @param uuid
+	 * @return localization for the given metadata, from message source, in the authenticated locale
+	 */
+    protected String getLocalization(String shortClassName, String uuid) {
+		// in case this is a hibernate proxy, strip off anything after an underscore
+		// ie: EncounterType_$$_javassist_26 needs to be converted to EncounterType
+		int underscoreIndex = shortClassName.indexOf("_$");
+		if (underscoreIndex > 0) {
+			shortClassName = shortClassName.substring(0, underscoreIndex);
+		}
+
+		String code = "ui.i18n." + shortClassName + ".name." + uuid;
+		String localization = Context.getMessageSourceService().getMessage(code);
+		if (localization == null || localization.equals(code)) {
+			return null;
+		} else {
+			return localization;
+		}
+	}
 }

omod-common/src/main/java/org/openmrs/module/webservices/rest/web/resource/impl/MetadataDelegatingCrudResource.java

@@ -175,31 +175,6 @@ public String getDisplayString(T delegate) {
 		}
 	}
 
-	/**
-	 * This code is largely copied from the UI Framework:
-	 * org.openmrs.ui.framework.FormatterImpl#format(org.openmrs.OpenmrsMetadata, java.util.Locale)
-	 * 
-	 * @param shortClassName
-	 * @param uuid
-	 * @return localization for the given metadata, from message source, in the authenticated locale
-	 */
-	private String getLocalization(String shortClassName, String uuid) {
-		// in case this is a hibernate proxy, strip off anything after an underscore
-		// ie: EncounterType_$$_javassist_26 needs to be converted to EncounterType
-		int underscoreIndex = shortClassName.indexOf("_$");
-		if (underscoreIndex > 0) {
-			shortClassName = shortClassName.substring(0, underscoreIndex);
-		}
-		
-		String code = "ui.i18n." + shortClassName + ".name." + uuid;
-		String localization = Context.getMessageSourceService().getMessage(code);
-		if (localization == null || localization.equals(code)) {
-			return null;
-		} else {
-			return localization;
-		}
-	}
-	
 	/**
 	 * @see org.openmrs.module.webservices.rest.web.resource.impl.BaseDelegatingResource#getCreatableProperties()
 	 */