2 * This document is a part of the source code and related artifacts
3 * for CollectionSpace, an open source collections management system
4 * for museums and related institutions:
6 * http://www.collectionspace.org
7 * http://wiki.collectionspace.org
9 * Copyright 2009 University of California at Berkeley
11 * Licensed under the Educational Community License (ECL), Version 2.0.
12 * You may not use this file except in compliance with this License.
14 * You may obtain a copy of the ECL 2.0 License at
16 * https://source.collectionspace.org/collection-space/LICENSE.txt
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS,
20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
24 package org.collectionspace.services.person.nuxeo;
26 import java.util.Iterator;
27 import java.util.ArrayList;
28 import java.util.Arrays;
29 import java.util.List;
31 import org.collectionspace.services.PersonJAXBSchema;
32 import org.collectionspace.services.common.document.DocumentFilter;
33 import org.collectionspace.services.common.document.DocumentWrapper;
34 import org.collectionspace.services.nuxeo.client.java.RemoteDocumentModelHandlerImpl;
35 import org.collectionspace.services.nuxeo.util.NuxeoUtils;
36 import org.collectionspace.services.person.PersonsCommon;
37 import org.collectionspace.services.person.PersonsCommonList;
38 import org.collectionspace.services.person.PersonsCommonList.PersonListItem;
39 import org.nuxeo.ecm.core.api.DocumentModel;
40 import org.nuxeo.ecm.core.api.DocumentModelList;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * PersonDocumentModelHandler
47 * $LastChangedRevision: $
54 public class PersonDocumentModelHandler
55 extends RemoteDocumentModelHandlerImpl<PersonsCommon, PersonsCommonList> {
57 private final Logger logger = LoggerFactory.getLogger(PersonDocumentModelHandler.class);
59 * person is used to stash JAXB object to use when handle is called
60 * for Action.CREATE, Action.UPDATE or Action.GET
62 private PersonsCommon person;
64 * personList is stashed when handle is called
67 private PersonsCommonList personList;
70 * inAuthority is the parent OrgAuthority for this context
72 private String inAuthority;
74 public String getInAuthority() {
78 public void setInAuthority(String inAuthority) {
79 this.inAuthority = inAuthority;
84 public void handleCreate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
85 // first fill all the parts of the document
86 super.handleCreate(wrapDoc);
87 handleDisplayName(wrapDoc.getWrappedObject());
91 public void handleUpdate(DocumentWrapper<DocumentModel> wrapDoc) throws Exception {
92 super.handleUpdate(wrapDoc);
93 handleDisplayName(wrapDoc.getWrappedObject());
96 private void handleDisplayName(DocumentModel docModel) throws Exception {
97 String commonPartLabel = getServiceContext().getCommonPartLabel("persons");
98 Boolean displayNameComputed = (Boolean) docModel.getProperty(commonPartLabel,
99 PersonJAXBSchema.DISPLAY_NAME_COMPUTED);
100 if (displayNameComputed) {
101 String displayName = prepareDefaultDisplayName(
102 (String)docModel.getProperty(commonPartLabel, PersonJAXBSchema.FORE_NAME ),
103 (String)docModel.getProperty(commonPartLabel, PersonJAXBSchema.MIDDLE_NAME ),
104 (String)docModel.getProperty(commonPartLabel, PersonJAXBSchema.SUR_NAME ),
105 (String)docModel.getProperty(commonPartLabel, PersonJAXBSchema.BIRTH_DATE ),
106 (String)docModel.getProperty(commonPartLabel, PersonJAXBSchema.DEATH_DATE )
108 docModel.setProperty(commonPartLabel, PersonJAXBSchema.DISPLAY_NAME,
114 * Produces a default displayName from the basic name and dates fields.
115 * @see PersonAuthorityClientUtils.prepareDefaultDisplayName() which
116 * duplicates this logic, until we define a service-general utils package
117 * that is neither client nor service specific.
126 private static String prepareDefaultDisplayName(
127 String foreName, String middleName, String surName,
128 String birthDate, String deathDate ) throws Exception {
129 StringBuilder newStr = new StringBuilder();
130 final String sep = " ";
131 final String dateSep = "-";
132 List<String> nameStrings =
133 Arrays.asList(foreName, middleName, surName);
134 boolean firstAdded = false;
135 for(String partStr : nameStrings ){
136 if(null != partStr ) {
140 newStr.append(partStr);
144 // Now we add the dates. In theory could have dates with no name, but that is their problem.
145 boolean foundBirth = false;
146 if(null != birthDate) {
150 newStr.append(birthDate);
151 newStr.append(dateSep); // Put this in whether there is a death date or not
154 if(null != deathDate) {
159 newStr.append(dateSep);
161 newStr.append(deathDate);
163 return newStr.toString();
167 * getCommonPart get associated person
171 public PersonsCommon getCommonPart() {
176 * setCommonPart set associated person
180 public void setCommonPart(PersonsCommon person) {
181 this.person = person;
185 * getCommonPartList get associated person (for index/GET_ALL)
189 public PersonsCommonList getCommonPartList() {
194 public void setCommonPartList(PersonsCommonList personList) {
195 this.personList = personList;
199 public PersonsCommon extractCommonPart(DocumentWrapper wrapDoc)
201 throw new UnsupportedOperationException();
205 public void fillCommonPart(PersonsCommon personObject, DocumentWrapper wrapDoc) throws Exception {
206 throw new UnsupportedOperationException();
210 public PersonsCommonList extractCommonPartList(DocumentWrapper wrapDoc)
212 PersonsCommonList coList = new PersonsCommonList();
214 DocumentModelList docList = (DocumentModelList) wrapDoc.getWrappedObject();
216 List<PersonsCommonList.PersonListItem> list =
217 coList.getPersonListItem();
219 DocumentFilter filter = getDocumentFilter();
220 long pageNum, pageSize;
225 pageSize = filter.getPageSize();
226 pageNum = filter.getOffset()/pageSize;
228 coList.setPageNum(pageNum);
229 coList.setPageSize(pageSize);
230 coList.setTotalItems(docList.totalSize());
231 //FIXME: iterating over a long list of documents is not a long term
232 //strategy...need to change to more efficient iterating in future
233 Iterator<DocumentModel> iter = docList.iterator();
234 String commonPartLabel = getServiceContext().getCommonPartLabel("persons");
235 while(iter.hasNext()){
236 DocumentModel docModel = iter.next();
237 PersonListItem ilistItem = new PersonListItem();
238 ilistItem.setDisplayName((String)
239 docModel.getProperty(commonPartLabel, PersonJAXBSchema.DISPLAY_NAME));
240 ilistItem.setRefName((String)
241 docModel.getProperty(commonPartLabel, PersonJAXBSchema.REF_NAME));
242 String id = NuxeoUtils.extractId(docModel.getPathAsString());
243 ilistItem.setUri("/personauthorities/"+inAuthority+"/items/" + id);
244 ilistItem.setCsid(id);
248 if(logger.isDebugEnabled()){
249 logger.debug("Caught exception in extractCommonPartList", e);
257 * getQProperty converts the given property to qualified schema property
262 public String getQProperty(String prop) {
263 return PersonConstants.NUXEO_SCHEMA_NAME + ":" + prop;