git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   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:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  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.
  23  */
  24 package org.collectionspace.services.vocabulary;
  25
  26 import org.collectionspace.services.client.PoxPayloadIn;
  27 import org.collectionspace.services.client.PoxPayloadOut;
  28 import org.collectionspace.services.client.VocabularyClient;
  29 import org.collectionspace.services.common.context.ServiceBindingUtils;
  30 import org.collectionspace.services.common.context.ServiceContext;
  31 //import org.collectionspace.services.common.vocabulary.AuthorityItemJAXBSchema;
  32 import org.collectionspace.services.common.vocabulary.AuthorityResource;
  33 //import org.collectionspace.services.nuxeo.util.NuxeoUtils;
  34 import org.collectionspace.services.vocabulary.nuxeo.VocabularyItemDocumentModelHandler;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 import javax.ws.rs.Path;
  39
  40 @Path("/" + VocabularyClient.SERVICE_PATH_COMPONENT)
  41 public class VocabularyResource extends
  42         AuthorityResource<VocabulariesCommon, VocabularyItemDocumentModelHandler> {
  43
  44     private final static String vocabularyServiceName = VocabularyClient.SERVICE_PATH_COMPONENT;
  45
  46         private final static String VOCABULARIES_COMMON = "vocabularies_common";
  47
  48     private final static String vocabularyItemServiceName = "vocabularyitems";
  49         private final static String VOCABULARYITEMS_COMMON = "vocabularyitems_common";
  50
  51     final Logger logger = LoggerFactory.getLogger(VocabularyResource.class);
  52
  53         public VocabularyResource() {
  54                 super(VocabulariesCommon.class, VocabularyResource.class,
  55                                 VOCABULARIES_COMMON, VOCABULARYITEMS_COMMON);
  56         }
  57
  58     @Override
  59     public String getServiceName() {
  60         return vocabularyServiceName;
  61     }
  62
  63     @Override
  64     public String getItemServiceName() {
  65         return vocabularyItemServiceName;
  66     }
  67
  68         @Override
  69         public Class<VocabulariesCommon> getCommonPartClass() {
  70                 return VocabulariesCommon.class;
  71         }
  72
  73     /**
  74      * @return the name of the property used to specify references for items in this type of
  75      * authority. For most authorities, it is ServiceBindingUtils.AUTH_REF_PROP ("authRef").
  76      * Some types (like Vocabulary) use a separate property.
  77      */
  78         @Override
  79     protected String getRefPropName() {
  80         return ServiceBindingUtils.TERM_REF_PROP;
  81     }
  82
  83         @Override
  84         protected String getOrderByField(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx) {
  85                 String result = null;
  86
  87                 result = authorityItemCommonSchemaName + ":" + VocabularyItemJAXBSchema.DISPLAY_NAME;
  88
  89                 return result;
  90         }
  91
  92         @Override
  93         protected String getPartialTermMatchField(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx) {
  94                 return getOrderByField(ctx);
  95         }
  96
  97         /*
  98          * The item schema for the Vocabulary service does not support a multi-valued term list.  Only authorities that support
  99          * term lists need to implement this method.
 100          */
 101         @Override
 102         public String getItemTermInfoGroupXPathBase() {
 103                 return null;
 104         }
 105 }