From: Aron Roberts Date: Fri, 6 May 2011 22:28:23 +0000 (+0000) Subject: CSPACE-3865: Consistent naming - for now - of 'taxonomy identification item' as ... X-Git-Url: https://git.aero2k.de/?a=commitdiff_plain;h=ad5d105892d558943e29cfcb1d2f0a348c4558ed;p=tmp%2Fjakarta-migration.git CSPACE-3865: Consistent naming - for now - of 'taxonomy identification item' as 'taxon' (the item equivalent to 'person' or 'location' for taxonomic identification). This can be changed later if desired. --- diff --git a/services/taxonomy/3rdparty/nuxeo-platform-cs-taxonomy/src/main/resources/schemas/taxonomy_common.xsd b/services/taxonomy/3rdparty/nuxeo-platform-cs-taxonomy/src/main/resources/schemas/taxon_common.xsd similarity index 84% rename from services/taxonomy/3rdparty/nuxeo-platform-cs-taxonomy/src/main/resources/schemas/taxonomy_common.xsd rename to services/taxonomy/3rdparty/nuxeo-platform-cs-taxonomy/src/main/resources/schemas/taxon_common.xsd index d4e124eda..b477c790a 100644 --- a/services/taxonomy/3rdparty/nuxeo-platform-cs-taxonomy/src/main/resources/schemas/taxonomy_common.xsd +++ b/services/taxonomy/3rdparty/nuxeo-platform-cs-taxonomy/src/main/resources/schemas/taxon_common.xsd @@ -1,26 +1,26 @@ - + diff --git a/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClient.java b/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClient.java index 9a31bdcdc..4915ca1c0 100644 --- a/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClient.java +++ b/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClient.java @@ -33,7 +33,7 @@ import javax.ws.rs.core.Response; import org.collectionspace.services.common.authorityref.AuthorityRefDocList; import org.collectionspace.services.contact.ContactsCommonList; import org.collectionspace.services.taxonomy.TaxonomyauthorityCommonList; -import org.collectionspace.services.taxonomy.TaxonomyCommonList; +import org.collectionspace.services.taxonomy.TaxonCommonList; import org.collectionspace.services.client.TaxonomyAuthorityProxy; import org.jboss.resteasy.client.ClientResponse; @@ -45,7 +45,7 @@ import org.jboss.resteasy.spi.ResteasyProviderFactory; /** * The Class TaxonomyAuthorityClient. */ -public class TaxonomyAuthorityClient extends AuthorityClientImpl { +public class TaxonomyAuthorityClient extends AuthorityClientImpl { public static final String SERVICE_NAME = "Taxonomyauthority"; public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME; public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT; diff --git a/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClientUtils.java b/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClientUtils.java index 9d04693d9..42063d35c 100644 --- a/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClientUtils.java +++ b/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityClientUtils.java @@ -13,7 +13,7 @@ import javax.ws.rs.core.Response; import org.apache.commons.io.FileUtils; import org.collectionspace.services.TaxonomyJAXBSchema; import org.collectionspace.services.client.test.ServiceRequestType; -import org.collectionspace.services.taxonomy.TaxonomyCommon; +import org.collectionspace.services.taxonomy.TaxonCommon; import org.collectionspace.services.taxonomy.TaxonomyauthorityCommon; import org.dom4j.DocumentException; import org.jboss.resteasy.client.ClientResponse; @@ -62,7 +62,7 @@ public class TaxonomyAuthorityClientUtils { public static PoxPayloadOut createTaxonomyInstance( String taxonomyAuthRefName, Map taxonomyInfo, String headerLabel){ - TaxonomyCommon taxonomy = new TaxonomyCommon(); + TaxonCommon taxonomy = new TaxonCommon(); String shortId = taxonomyInfo.get(TaxonomyJAXBSchema.SHORT_IDENTIFIER); String displayName = taxonomyInfo.get(TaxonomyJAXBSchema.DISPLAY_NAME); taxonomy.setShortIdentifier(shortId); @@ -85,7 +85,7 @@ public class TaxonomyAuthorityClientUtils { commonPart.setLabel(headerLabel); if(logger.isDebugEnabled()){ - logger.debug("to be created, taxonomy common ", taxonomy, TaxonomyCommon.class); + logger.debug("to be created, taxonomy common ", taxonomy, TaxonCommon.class); } return multipart; diff --git a/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityProxy.java b/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityProxy.java index 80fb93dd0..aa8aadc2a 100644 --- a/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityProxy.java +++ b/services/taxonomy/client/src/main/java/org/collectionspace/services/client/TaxonomyAuthorityProxy.java @@ -10,7 +10,7 @@ import javax.ws.rs.QueryParam; import org.collectionspace.services.client.workflow.WorkflowClient; import org.collectionspace.services.taxonomy.TaxonomyauthorityCommonList; -import org.collectionspace.services.taxonomy.TaxonomyCommonList; +import org.collectionspace.services.taxonomy.TaxonCommonList; /** * @version $Revision$ @@ -20,7 +20,7 @@ import org.collectionspace.services.taxonomy.TaxonomyCommonList; @Path(TaxonomyAuthorityClient.SERVICE_PATH + "/") @Produces("application/xml") @Consumes("application/xml") -public interface TaxonomyAuthorityProxy extends AuthorityProxy { +public interface TaxonomyAuthorityProxy extends AuthorityProxy { // List Taxonomyauthority @GET @@ -35,7 +35,7 @@ public interface TaxonomyAuthorityProxy extends AuthorityProxy readItemList( + ClientResponse readItemList( @PathParam("csid") String vcsid, @QueryParam (IQueryManager.SEARCH_TYPE_PARTIALTERM) String partialTerm, @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords, @@ -46,7 +46,7 @@ public interface TaxonomyAuthorityProxy extends AuthorityProxy readItemListForNamedAuthority( + ClientResponse readItemListForNamedAuthority( @PathParam("specifier") String specifier, @QueryParam (IQueryManager.SEARCH_TYPE_PARTIALTERM) String partialTerm, @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords, diff --git a/services/taxonomy/client/src/test/java/org/collectionspace/services/client/test/TaxonomyAuthorityServiceTest.java b/services/taxonomy/client/src/test/java/org/collectionspace/services/client/test/TaxonomyAuthorityServiceTest.java index 7a80e2242..2342112ec 100644 --- a/services/taxonomy/client/src/test/java/org/collectionspace/services/client/test/TaxonomyAuthorityServiceTest.java +++ b/services/taxonomy/client/src/test/java/org/collectionspace/services/client/test/TaxonomyAuthorityServiceTest.java @@ -42,8 +42,8 @@ import org.collectionspace.services.client.TaxonomyAuthorityClientUtils; import org.collectionspace.services.jaxb.AbstractCommonList; import org.collectionspace.services.taxonomy.TaxonomyauthorityCommon; import org.collectionspace.services.taxonomy.TaxonomyauthorityCommonList; -import org.collectionspace.services.taxonomy.TaxonomyCommon; -import org.collectionspace.services.taxonomy.TaxonomyCommonList; +import org.collectionspace.services.taxonomy.TaxonCommon; +import org.collectionspace.services.taxonomy.TaxonCommonList; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; @@ -135,7 +135,7 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI @Override protected AbstractCommonList getAbstractCommonList( ClientResponse response) { - return response.getEntity(TaxonomyCommonList.class); + return response.getEntity(TaxonCommonList.class); } @Override @@ -458,13 +458,13 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Check whether we've received a taxonomy. PoxPayloadIn input = new PoxPayloadIn(res.getEntity()); - TaxonomyCommon taxonomy = (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + TaxonCommon taxonomy = (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(taxonomy); boolean showFull = true; if(showFull && logger.isDebugEnabled()){ logger.debug(testName + ": returned payload:"); - logger.debug(objectAsXmlString(taxonomy, TaxonomyCommon.class)); + logger.debug(objectAsXmlString(taxonomy, TaxonCommon.class)); } Assert.assertEquals(taxonomy.getInAuthority(), knownResourceId); } finally { @@ -506,8 +506,8 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Check whether taxonomy has expected displayName. PoxPayloadIn input = new PoxPayloadIn(res.getEntity()); - TaxonomyCommon taxonomy = (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + TaxonCommon taxonomy = (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(taxonomy); String displayName = taxonomy.getDisplayName(); // Make sure displayName matches computed form @@ -540,9 +540,9 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Retrieve the updated resource and verify that its contents exist. input = new PoxPayloadIn(res.getEntity()); - TaxonomyCommon updatedTaxonomy = - (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + TaxonCommon updatedTaxonomy = + (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(updatedTaxonomy); // Verify that the updated resource received the correct data. @@ -576,8 +576,8 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Retrieve the updated resource and verify that its contents exist. input = new PoxPayloadIn(res.getEntity()); updatedTaxonomy = - (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(updatedTaxonomy); // Verify that the updated resource received the correct data. @@ -626,8 +626,8 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Check whether Taxonomy has expected displayName. PoxPayloadIn input = new PoxPayloadIn(res.getEntity()); - TaxonomyCommon taxonomy = (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + TaxonCommon taxonomy = (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(taxonomy); // Try to Update with computed false and no displayName taxonomy.setDisplayNameComputed(false); @@ -820,7 +820,7 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Submit the request to the service and store the response. TaxonomyAuthorityClient client = new TaxonomyAuthorityClient(); - ClientResponse res = null; + ClientResponse res = null; if(vcsid!= null) { res = client.readItemList(vcsid, null, null); } else if(shortId!= null) { @@ -829,7 +829,7 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI Assert.fail("readItemList passed null csid and name!"); } try { - TaxonomyCommonList list = res.getEntity(); + TaxonCommonList list = res.getEntity(); int statusCode = res.getStatus(); // Check the status code of the response: does it match @@ -841,8 +841,8 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI invalidStatusCodeMessage(REQUEST_TYPE, statusCode)); Assert.assertEquals(statusCode, EXPECTED_STATUS_CODE); - List items = - list.getTaxonomyListItem(); + List items = + list.getTaxonListItem(); int nItemsReturned = items.size(); // There will be one item created, associated with a // known parent resource, by the createItem test. @@ -858,7 +858,7 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI Assert.assertEquals(nItemsReturned, nExpectedItems); int i = 0; - for (TaxonomyCommonList.TaxonomyListItem item : items) { + for (TaxonCommonList.TaxonListItem item : items) { Assert.assertTrue((null != item.getRefName()), "Item refName is null!"); Assert.assertTrue((null != item.getDisplayName()), "Item displayName is null!"); // Optionally output additional data about list members for debugging. @@ -991,8 +991,8 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI " in TaxonomyAuthority: " + knownResourceId ); } PoxPayloadIn input = new PoxPayloadIn(res.getEntity()); - TaxonomyCommon taxonomy = (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + TaxonCommon taxonomy = (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(taxonomy); // Update the contents of this resource. @@ -1001,7 +1001,7 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI if(logger.isDebugEnabled()){ logger.debug("to be updated Taxonomy"); logger.debug(objectAsXmlString(taxonomy, - TaxonomyCommon.class)); + TaxonCommon.class)); } // Submit the updated resource to the service and store the response. @@ -1022,9 +1022,9 @@ public class TaxonomyAuthorityServiceTest extends AbstractServiceTestImpl { //FI // Retrieve the updated resource and verify that its contents exist. input = new PoxPayloadIn(res.getEntity()); - TaxonomyCommon updatedTaxonomy = - (TaxonomyCommon) extractPart(input, - client.getItemCommonPartName(), TaxonomyCommon.class); + TaxonCommon updatedTaxonomy = + (TaxonCommon) extractPart(input, + client.getItemCommonPartName(), TaxonCommon.class); Assert.assertNotNull(updatedTaxonomy); // Verify that the updated resource received the correct data. diff --git a/services/taxonomy/jaxb/src/main/resources/taxonomy_common.xsd b/services/taxonomy/jaxb/src/main/resources/taxon_common.xsd similarity index 94% rename from services/taxonomy/jaxb/src/main/resources/taxonomy_common.xsd rename to services/taxonomy/jaxb/src/main/resources/taxon_common.xsd index e9b27429b..a0dd18a24 100644 --- a/services/taxonomy/jaxb/src/main/resources/taxonomy_common.xsd +++ b/services/taxonomy/jaxb/src/main/resources/taxon_common.xsd @@ -9,12 +9,11 @@ version="0.1" > - - - + + @@ -75,19 +74,19 @@ - + - + - + { + TaxonCommon, TaxonomyDocumentModelHandler> { private final static String taxonomyAuthorityServiceName = "taxonomyauthorities"; private final static String LOCATIONAUTHORITIES_COMMON = "taxonomyauthority_common"; diff --git a/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyDocumentModelHandler.java b/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyDocumentModelHandler.java index d67d2f14d..f39cdab34 100644 --- a/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyDocumentModelHandler.java +++ b/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyDocumentModelHandler.java @@ -38,9 +38,9 @@ import org.collectionspace.services.common.vocabulary.nuxeo.AuthorityItemDocumen import org.collectionspace.services.nuxeo.client.java.RemoteDocumentModelHandlerImpl; import org.collectionspace.services.nuxeo.util.NuxeoUtils; import org.collectionspace.services.jaxb.AbstractCommonList; -import org.collectionspace.services.taxonomy.TaxonomyCommon; -import org.collectionspace.services.taxonomy.TaxonomyCommonList; -import org.collectionspace.services.taxonomy.TaxonomyCommonList.TaxonomyListItem; +import org.collectionspace.services.taxonomy.TaxonCommon; +import org.collectionspace.services.taxonomy.TaxonCommonList; +import org.collectionspace.services.taxonomy.TaxonCommonList.TaxonListItem; import org.nuxeo.ecm.core.api.DocumentModel; import org.nuxeo.ecm.core.api.DocumentModelList; import org.slf4j.Logger; @@ -57,7 +57,7 @@ import org.slf4j.LoggerFactory; * */ public class TaxonomyDocumentModelHandler - extends AuthorityItemDocumentModelHandler { + extends AuthorityItemDocumentModelHandler { /** The logger. */ private final Logger logger = LoggerFactory.getLogger(TaxonomyDocumentModelHandler.class); @@ -143,18 +143,18 @@ public class TaxonomyDocumentModelHandler * @see org.collectionspace.services.nuxeo.client.java.DocumentModelHandler#extractCommonPartList(org.collectionspace.services.common.document.DocumentWrapper) */ @Override - public TaxonomyCommonList extractCommonPartList( + public TaxonCommonList extractCommonPartList( DocumentWrapper wrapDoc) throws Exception { - TaxonomyCommonList coList = extractPagingInfo(new TaxonomyCommonList(), wrapDoc); + TaxonCommonList coList = extractPagingInfo(new TaxonCommonList(), wrapDoc); AbstractCommonList commonList = (AbstractCommonList) coList; commonList.setFieldsReturned("displayName|refName|shortIdentifier|uri|csid"); - List list = coList.getTaxonomyListItem(); + List list = coList.getTaxonListItem(); Iterator iter = wrapDoc.getWrappedObject().iterator(); String commonPartLabel = getServiceContext().getCommonPartLabel( "taxonomy"); while (iter.hasNext()) { DocumentModel docModel = iter.next(); - TaxonomyListItem ilistItem = new TaxonomyListItem(); + TaxonListItem ilistItem = new TaxonListItem(); ilistItem.setDisplayName((String) docModel.getProperty( commonPartLabel, AuthorityItemJAXBSchema.DISPLAY_NAME)); ilistItem.setShortIdentifier((String) docModel.getProperty(commonPartLabel, diff --git a/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyValidatorHandler.java b/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyValidatorHandler.java index f6c7355a7..8216ee411 100644 --- a/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyValidatorHandler.java +++ b/services/taxonomy/service/src/main/java/org/collectionspace/services/taxonomy/nuxeo/TaxonomyValidatorHandler.java @@ -23,7 +23,7 @@ */ package org.collectionspace.services.taxonomy.nuxeo; -import org.collectionspace.services.taxonomy.TaxonomyCommon; +import org.collectionspace.services.taxonomy.TaxonCommon; import org.collectionspace.services.common.context.MultipartServiceContext; import org.collectionspace.services.common.context.ServiceContext; import org.collectionspace.services.common.document.DocumentHandler.Action; @@ -48,8 +48,8 @@ public class TaxonomyValidatorHandler implements ValidatorHandler { } try { MultipartServiceContext mctx = (MultipartServiceContext) ctx; - TaxonomyCommon taxonomy = (TaxonomyCommon) mctx.getInputPart(mctx.getCommonPartLabel(), - TaxonomyCommon.class); + TaxonCommon taxonomy = (TaxonCommon) mctx.getInputPart(mctx.getCommonPartLabel(), + TaxonCommon.class); String msg = ""; boolean invalid = false; if(!taxonomy.isDisplayNameComputed() && (taxonomy.getDisplayName()==null)) {