Skip to content

Commit 56ab2ff

Browse files
authored
Add support for authority display names (#325)
* Add display name support for Authorities in order to provide a standard name to the services layer * Update authorities to include a display name * Update authority vocab titles to match cspace-ui.js or the respective profile plugin
1 parent fb5a2d2 commit 56ab2ff

30 files changed

+98
-81
lines changed

cspi-installation/src/main/java/org/collectionspace/chain/installation/ServiceBindingsGeneration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,6 @@ private void doRefnameDisplayNameField(Record record, Element ele, Namespace thi
716716
* @param thisns
717717
* @param isAuthority
718718
*/
719-
720719
private void doDocHandlerParams(Record r, Element el, Namespace nsservices2, Boolean isAuthority) {
721720
//<service:DocHandlerParams>
722721
Element dhele = el.addElement(new QName("DocHandlerParams", nsservices2));
@@ -902,6 +901,7 @@ private void addAuthorities(Record r, Element el, String serviceBindingVersion)
902901
bindingsForAuthority.addAttribute("id", r.getServicesTenantAuthPl());
903902
bindingsForAuthority.addAttribute("type", RECORD_TYPE_UTILITY);
904903
bindingsForAuthority.addAttribute("version", serviceBindingVersion);
904+
bindingsForAuthority.addAttribute("displayName", r.getServicesTenantAuthDisplayName());
905905
bindingsForAuthority.addAttribute(Record.SUPPORTS_REPLICATING, Boolean.toString(r.supportsReplicating()));
906906
bindingsForAuthority.addAttribute(Record.REQUIRES_UNIQUE_SHORTID, Boolean.TRUE.toString());
907907
String remoteClientConfigName = r.getRemoteClientConfigName();
@@ -952,7 +952,7 @@ private void addServiceBinding(Record r, Element el, Namespace nameSpace, Boolea
952952
doDocHandlerParams(r, el, this.nsservices, isAuthority);
953953

954954
//<service:AuthorityInstanceList>
955-
if (isAuthority == true || r.isType(RECORD_TYPE_VOCABULARY) == true) {
955+
if (isAuthority || r.isType(RECORD_TYPE_VOCABULARY)) {
956956
doAuthorityInstanceList(r, el, this.nsservices);
957957
}
958958

cspi-schema/src/main/java/org/collectionspace/chain/csp/schema/Record.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ public class Record implements FieldParent {
3838
private static final String TYPE_AUTHORITY = "Authority";
3939
private static final String TYPE_AUTHORITY_LOWERCASE = TYPE_AUTHORITY.toLowerCase();
4040

41+
public static final String AUTH_DISPLAY_NAME = "services-tenant-auth-display-name";
42+
4143
public static final String ELASTICSEARCH_INDEXED = "elasticsearchIndexed";
4244
public static final String SUPPORTS_LOCKING = "supportslocking";
4345
public static final String SUPPORTS_REPLICATING = "supportsReplicating";
@@ -257,6 +259,7 @@ public void setLastAuthorityProxy(Record lastAuthoriyProxy) {
257259
utils.initStrings(section, "services-tenant-plural", utils.getString("services-tenant-singular") + "s");
258260
utils.initStrings(section, "services-tenant-auth-singular", utils.getString("services-url"));
259261
utils.initStrings(section, "services-tenant-auth-plural", utils.getString("services-tenant-singular") + "s");
262+
utils.initStrings(section, AUTH_DISPLAY_NAME, utils.getString("services-tenant-singular"));
260263

261264
utils.initStrings(section, "services-schema-location", "http://services.collectionspace.org");
262265

@@ -827,6 +830,10 @@ public String getServicesTenantAuthSg() {
827830
return utils.getString("services-tenant-auth-singular");
828831
}
829832

833+
public String getServicesTenantAuthDisplayName() {
834+
return utils.getString(AUTH_DISPLAY_NAME);
835+
}
836+
830837
/*
831838
* By convention, the value from getServicesTenantSg() is the Nuxeo doctype
832839
* name. However, if the record explicitly declares a doctype using the
@@ -1442,4 +1449,5 @@ public void setSortKey(String fieldId, String sortFieldId) {
14421449
public String getSortKey(String fieldId) {
14431450
return sortKeys.get(fieldId);
14441451
}
1452+
14451453
}

tomcat-main/src/main/resources/defaults/base-authority-chronology.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-plural>Chronologyauthorities</services-tenant-auth-plural>
66
<services-tenant-auth-singular>Chronologyauthority</services-tenant-auth-singular>
7+
<services-tenant-auth-display-name>Chronology</services-tenant-auth-display-name>
78
<services-tenant-singular>Chronology</services-tenant-singular>
89
<services-tenant-plural>Chronologies</services-tenant-plural>
910

@@ -31,12 +32,12 @@
3132
<instance id="chronology-era">
3233
<web-url>era</web-url>
3334
<title-ref>era</title-ref>
34-
<title>Era Chronologies</title>
35+
<title>Era</title>
3536
</instance>
3637
<instance id="chronology-event">
3738
<web-url>event</web-url>
3839
<title-ref>event</title-ref>
39-
<title>Event Chronologies</title>
40+
<title>Event</title>
4041
</instance>
4142
</instances>
4243

@@ -91,4 +92,4 @@
9192
<field id="proposed" mini="list" datatype="boolean" />
9293
<field id="deprecated" mini="list" datatype="boolean" />
9394
</section>
94-
</record>
95+
</record>

tomcat-main/src/main/resources/defaults/base-authority-citation.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
<services-tenant-auth-singular>Citationauthority</services-tenant-auth-singular>
77
<services-tenant-auth-plural>Citationauthorities</services-tenant-auth-plural>
8+
<services-tenant-auth-display-name>Citation</services-tenant-auth-display-name>
89
<services-tenant-singular>Citation</services-tenant-singular>
910

1011
<services-instances-path>citationauthorities_common:http://collectionspace.org/services/citation,abstract-common-list/list-item</services-instances-path>
@@ -30,12 +31,12 @@
3031
<instance id="citation-citation">
3132
<web-url>citation</web-url>
3233
<title-ref>citation</title-ref>
33-
<title>Local Citations</title>
34+
<title>Local</title>
3435
</instance>
3536
<instance id="citation-worldcat">
3637
<web-url>worldcat</web-url>
3738
<title-ref>worldcat</title-ref>
38-
<title>WorldCat Citations</title>
39+
<title>WorldCat</title>
3940
</instance>
4041
</instances>
4142

tomcat-main/src/main/resources/defaults/base-authority-concept.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-singular>Conceptauthority</services-tenant-auth-singular>
66
<services-tenant-auth-plural>Conceptauthorities</services-tenant-auth-plural>
7+
<services-tenant-auth-display-name>Concept</services-tenant-auth-display-name>
78
<services-tenant-singular>Concept</services-tenant-singular>
89
<services-tenant-doctype>Conceptitem</services-tenant-doctype>
910

@@ -33,17 +34,17 @@
3334
<instance id="concept-concept">
3435
<web-url>concept</web-url>
3536
<title-ref>concept</title-ref>
36-
<title>Associated Concepts</title>
37+
<title>Associated</title>
3738
</instance>
3839
<instance id="concept-material_ca">
3940
<web-url>material_ca</web-url>
4041
<title-ref>material_ca</title-ref>
41-
<title>Material Concepts</title>
42+
<title>Material</title>
4243
</instance>
4344
<instance id="concept-activity">
4445
<web-url>activity</web-url>
4546
<title-ref>activity</title-ref>
46-
<title>Activity Concepts</title>
47+
<title>Activity</title>
4748
</instance>
4849
<instance id="concept-nomenclature">
4950
<web-url>nomenclature</web-url>
@@ -65,18 +66,18 @@
6566
<instance id="concept-occasion">
6667
<web-url>occasion</web-url>
6768
<title-ref>occasion</title-ref>
68-
<title>Occasion Concepts</title>
69+
<title>Occasion</title>
6970
</instance>
7071
<!-- NAGPRA Culture fields -->
7172
<instance id="concept-ethculture">
7273
<web-url>ethculture</web-url>
7374
<title-ref>ethculture</title-ref>
74-
<title>Ethnographic Cultures</title>
75+
<title>Cultural Group</title>
7576
</instance>
7677
<instance id="concept-archculture">
7778
<web-url>archculture</web-url>
7879
<title-ref>archculture</title-ref>
79-
<title>Archaeological Cultures</title>
80+
<title>Archaeological Culture</title>
8081
</instance>
8182
</instances>
8283

tomcat-main/src/main/resources/defaults/base-authority-location.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-singular>Locationauthority</services-tenant-auth-singular>
66
<services-tenant-auth-plural>Locationauthorities</services-tenant-auth-plural>
7+
<services-tenant-auth-display-name>Storage Location</services-tenant-auth-display-name>
78
<services-tenant-singular>Location</services-tenant-singular>
89
<services-tenant-doctype>Locationitem</services-tenant-doctype>
910

@@ -30,12 +31,12 @@
3031
<instance id="location-location">
3132
<web-url>location</web-url>
3233
<title-ref>location</title-ref>
33-
<title>Local Storage Locations</title>
34+
<title>Local</title>
3435
</instance>
3536
<instance id="location-offsite_sla">
3637
<web-url>offsite_sla</web-url>
3738
<title-ref>offsite_sla</title-ref>
38-
<title>Offsite Storage Locations</title>
39+
<title>Offsite</title>
3940
</instance>
4041
</instances>
4142

tomcat-main/src/main/resources/defaults/base-authority-material.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-singular>Materialauthority</services-tenant-auth-singular>
66
<services-tenant-auth-plural>Materialauthorities</services-tenant-auth-plural>
7+
<services-tenant-auth-display-name>Material</services-tenant-auth-display-name>
78
<services-tenant-singular>Material</services-tenant-singular>
89
<services-tenant-doctype>Materialitem</services-tenant-doctype>
910

tomcat-main/src/main/resources/defaults/base-authority-organization.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-plural>Orgauthorities</services-tenant-auth-plural>
66
<services-tenant-auth-singular>Orgauthority</services-tenant-auth-singular>
7+
<services-tenant-auth-display-name>Organization</services-tenant-auth-display-name>
78
<services-tenant-singular>Organization</services-tenant-singular>
89

910
<services-instances-path>orgauthorities_common:http://collectionspace.org/services/organization,abstract-common-list/list-item</services-instances-path>
@@ -31,12 +32,12 @@
3132
<instance id="organization-organization">
3233
<web-url>organization</web-url>
3334
<title-ref>organization</title-ref>
34-
<title>Local Organizations</title>
35+
<title>Local</title>
3536
</instance>
3637
<instance id="organization-ulan_oa">
3738
<web-url>ulan_oa</web-url>
3839
<title-ref>ulan_oa</title-ref>
39-
<title>ULAN Organizations</title>
40+
<title>ULAN</title>
4041
</instance>
4142
</instances>
4243

tomcat-main/src/main/resources/defaults/base-authority-person.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-singular>Personauthority</services-tenant-auth-singular>
66
<services-tenant-auth-plural>Personauthorities</services-tenant-auth-plural>
7+
<services-tenant-auth-display-name>Person</services-tenant-auth-display-name>
78
<services-tenant-singular>Person</services-tenant-singular>
89

910
<services-instances-path>personauthorities_common:http://collectionspace.org/services/person,abstract-common-list/list-item</services-instances-path>
@@ -32,12 +33,12 @@
3233
<instance id="person-person">
3334
<web-url>person</web-url>
3435
<title-ref>person</title-ref>
35-
<title>Local Persons</title>
36+
<title>Local</title>
3637
</instance>
3738
<instance id="person-ulan_pa">
3839
<web-url>ulan_pa</web-url>
3940
<title-ref>ulan_pa</title-ref>
40-
<title>ULAN Persons</title>
41+
<title>ULAN</title>
4142
</instance>
4243
</instances>
4344

tomcat-main/src/main/resources/defaults/base-authority-place.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<services-tenant-auth-singular>Placeauthority</services-tenant-auth-singular>
66
<services-tenant-auth-plural>Placeauthorities</services-tenant-auth-plural>
7+
<services-tenant-auth-display-name>Place</services-tenant-auth-display-name>
78
<services-tenant-singular>Place</services-tenant-singular>
89
<services-tenant-doctype>Placeitem</services-tenant-doctype>
910

@@ -33,17 +34,17 @@
3334
<instance id="place-place">
3435
<web-url>place</web-url>
3536
<title-ref>place</title-ref>
36-
<title>Local Places</title>
37+
<title>Local</title>
3738
</instance>
3839
<instance id="place-tgn_place">
3940
<web-url>tgn_place</web-url>
4041
<title-ref>tgn_place</title-ref>
41-
<title>Thesaurus of Geographic Names</title>
42+
<title>TGN</title>
4243
</instance>
4344
<instance id="place-archaeological">
4445
<web-url>archaeological</web-url>
4546
<title-ref>archaeological</title-ref>
46-
<title>Archaeological Site</title>
47+
<title>Archaeological</title>
4748
</instance>
4849
</instances>
4950

0 commit comments

Comments
 (0)