]> git.aero2k.de Git - tmp/jakarta-migration.git/commitdiff
CSPACE-79: Experiments with draft template for Java class-level comments. Includes...
authorAron Roberts <aron@socrates.berkeley.edu>
Mon, 29 Jun 2009 22:36:29 +0000 (22:36 +0000)
committerAron Roberts <aron@socrates.berkeley.edu>
Mon, 29 Jun 2009 22:36:29 +0000 (22:36 +0000)
21 files changed:
services/id/jaxb/src/main/java/org/collectionspace/services/IDJAXBSchema.java
services/id/service/src/main/java/org/collectionspace/services/IDResource.java
services/id/service/src/main/java/org/collectionspace/services/IDService.java
services/id/service/src/main/java/org/collectionspace/services/IDServiceJdbcImpl.java
services/id/service/src/main/java/org/collectionspace/services/id/AlphabeticIDGenerator.java
services/id/service/src/main/java/org/collectionspace/services/id/AlphabeticIDPart.java
services/id/service/src/main/java/org/collectionspace/services/id/IDGenerator.java
services/id/service/src/main/java/org/collectionspace/services/id/IDPart.java
services/id/service/src/main/java/org/collectionspace/services/id/IDPattern.java
services/id/service/src/main/java/org/collectionspace/services/id/NumericIDGenerator.java
services/id/service/src/main/java/org/collectionspace/services/id/NumericIDPart.java
services/id/service/src/main/java/org/collectionspace/services/id/StringIDGenerator.java
services/id/service/src/main/java/org/collectionspace/services/id/StringIDPart.java
services/id/service/src/main/java/org/collectionspace/services/id/YearIDGenerator.java
services/id/service/src/main/java/org/collectionspace/services/id/YearIDPart.java
services/id/service/src/test/java/org/collectionspace/services/IDServiceTest.java
services/id/service/src/test/java/org/collectionspace/services/id/AlphabeticIDPartTest.java
services/id/service/src/test/java/org/collectionspace/services/id/IDPatternTest.java
services/id/service/src/test/java/org/collectionspace/services/id/NumericIDPartTest.java
services/id/service/src/test/java/org/collectionspace/services/id/StringIDPartTest.java
services/id/service/src/test/java/org/collectionspace/services/id/YearIDPartTest.java

index bb797fbb43fbf6c148b4c734fc26ddc9add61d50..a1d08d40702d8e79456a9fec9b98e38839bc86c3 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Schema for an identifier (ID).
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 package org.collectionspace.services;
index 82140940ba8459c9e2dcae569091682934e0731f..1d28e226c2e64853510ae6d9f04d4489651a4dbc 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Resource class to handle requests to the ID Service.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
  *
  * Based on work by Richard Millet and Sanjay Dalal.
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
- // @TODO: Add Javadoc comments.
- // @TODO: Remove unused import statements.
- // @TODO: Replace wildcarded import statement for
- // org.collectionspace.services.id.* with class-specific
- // import statements.
- package org.collectionspace.services;
+  
+package org.collectionspace.services;
 
-import java.util.Iterator;
-import java.util.List;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
-import javax.ws.rs.Produces;
-import javax.ws.rs.DELETE;
-import javax.ws.rs.POST;
-import javax.ws.rs.PUT;
 import javax.ws.rs.PathParam;
-import javax.ws.rs.WebApplicationException;
-import javax.ws.rs.core.Context;
+import javax.ws.rs.Produces;
 import javax.ws.rs.core.Response;
-import javax.ws.rs.core.UriBuilder;
-import javax.ws.rs.core.UriInfo;
 import javax.xml.bind.JAXBContext;
 import javax.xml.bind.Marshaller;
 
 import org.collectionspace.services.IDService;
-import org.collectionspace.services.id.*;
-// import org.collectionspace.services.id.IDPatternList.*;
-// import org.collectionspace.services.IDJAXBSchema;
+import org.collectionspace.services.id.IDPattern;
 
-import org.dom4j.Document;
-import org.dom4j.Element;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+// Set the base path component for URLs that access this service.
 @Path("/ids")
+// Identify the default MIME media types consumed and produced by this service.
 @Consumes("application/xml")
 @Produces("application/xml")
 public class IDResource {
@@ -68,15 +56,29 @@ public class IDResource {
        // Spring, Seam, or EJB3.
        final static IDService service = new IDServiceJdbcImpl();
 
+  //////////////////////////////////////////////////////////////////////
+       /* 
+        * Constructor (no argument).
+   */
        public IDResource() {
                // do nothing
        }
 
-  // Retrieve the next available ID associated with a specified pattern.
-  //
-  // @TODO: We're currently using simple integer IDs.  We'll need to
-  // handle both CSIDs, and URIs or another identifier type that we select,
-  // for uniquely identifying IDPatterns.
+  //////////////////////////////////////////////////////////////////////
+  /*
+   * Returns the next available ID associated with a specified ID pattern.
+   *
+   * @param  csid  An identifier for an ID pattern.
+   *
+   * @return  The next available ID associated with the specified ID pattern.
+   * 
+   * @TODO: We're currently using simple integer IDs to identify ID patterns
+   * in this initial iteration.
+   *
+   * To uniquely identify ID patterns in production, we'll need to handle
+   * both CollectionSpace IDs (csids) - a form of UUIDs/GUIDs - and some
+   * other form of identifier to be determined, such as URLs or URNs.
+   */
        @GET
        @Path("/next/patterns/{id}")
        // @TODO: Temporary during testing; to be changed to return XML
@@ -85,11 +87,12 @@ public class IDResource {
        
                Response response = null;
                String nextId = "";
-               String msg = "";
        
                try {
                
                        nextId = service.nextID(csid);
+
+               // @TODO: Return our XML-based error results format.
                
                // @TODO: An IllegalStateException often indicates an overflow
                // of an IDPart.  Consider whether returning a 400 Bad Request
@@ -112,213 +115,17 @@ public class IDResource {
     
   }
 
-/*
-       @GET
-       public CollectionObjectList getCollectionObjectList(@Context UriInfo ui) {
-               CollectionObjectList p = new CollectionObjectList();
-               try {
-                       Document document = service.getCollectionObjectList();
-                       Element root = document.getRootElement();
-
-                       // debug
-                       System.err.println(document.asXML());
-
-                       List<CollectionObjectList.CollectionObjectListItem> list = p
-                                       .getCollectionObjectListItem();
-                       for (Iterator i = root.elementIterator(); i.hasNext();) {
-                               Element element = (Element) i.next();
-                               // debug
-                               System.err.println();
-                               element.asXML();
-
-                               // set the CollectionObject list item entity elements
-                               CollectionObjectListItem pli = new CollectionObjectListItem();
-                               pli.setObjectNumber(element.attributeValue("title"));
-                               pli.setUri(element.attributeValue("url"));
-                               pli.setCsid(element.attributeValue("id"));
-                               list.add(pli);
-                       }
-
-               } catch (Exception e) {
-                       e.printStackTrace();
-               }
-
-               return p;
-       }
-
-       @POST
-       public Response createCollectionObject(CollectionObject co) {
-               
-               String csid = null;
-               try {
-
-                       Document document = service.postCollectionObject(co);
-                       Element root = document.getRootElement();
-                       for (Iterator i = root.elementIterator(); i.hasNext();) {
-                               Element element = (Element) i.next();
-                               if ("docRef".equals(element.getName())) {
-                                       csid = (String) element.getData();
-                                       co.setCsid(csid);
-                               }
-                       }
-               } catch (Exception e) {
-                       Response response = Response.status(Response.Status.NOT_FOUND)
-                                       .entity("Create failed").type("text/plain").build();
-                       throw new WebApplicationException(response);
-               }
-
-               verbose("createCollectionObject: ", co);
-               UriBuilder path = UriBuilder
-                               .fromResource(CollectionObjectResource.class);
-               path.path("" + csid);
-               Response response = Response.created(path.build()).build();
-
-               return response;
-       }
-
-       @GET
-       @Path("{csid}")
-       public CollectionObject getCollectionObject(@PathParam("csid") String csid) {
-
-               CollectionObject co = null;
-               try {
-                       Document document = service.getCollectionObject(csid);
-                       Element root = document.getRootElement();
-                       co = new CollectionObject();
-
-                       // TODO: recognize schema thru namespace uri
-                       // Namespace ns = new Namespace("collectionobject",
-                       // "http://collectionspace.org/collectionobject");
-
-                       Iterator<Element> siter = root.elementIterator("schema");
-                       while (siter.hasNext()) {
-
-                               Element schemaElement = siter.next();
-                               System.err
-                                               .println("CollectionObject.getCollectionObject() called.");
-
-                               // TODO: recognize schema thru namespace uri
-                               if (CollectionObjectService.CO_SCHEMA_NAME.equals(schemaElement.attribute("name")
-                                               .getValue())) {
-                                       Element ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.OBJECT_NUMBER);
-                                       if (ele != null) {
-                                               co.setObjectNumber((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.OTHER_NUMBER);
-                                       if (ele != null) {
-                                               co.setOtherNumber((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.BRIEF_DESCRIPTION);
-                                       if (ele != null) {
-                                               co.setBriefDescription((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.COMMENTS);
-                                       if (ele != null) {
-                                               co.setComments((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.DIST_FEATURES);
-                                       if (ele != null) {
-                                               co.setDistFeatures((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.OBJECT_NAME);
-                                       if (ele != null) {
-                                               co.setObjectName((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.RESPONSIBLE_DEPT);
-                                       if (ele != null) {
-                                               co.setResponsibleDept((String) ele.getData());
-                                       }
-                                       ele = schemaElement
-                                                       .element(CollectionObjectJAXBSchema.TITLE);
-                                       if (ele != null) {
-                                               co.setTitle((String) ele.getData());
-                                       }
-                               }
-                       }
-               } catch (Exception e) {
-                       e.printStackTrace();
-                       Response response = Response.status(
-                                       Response.Status.INTERNAL_SERVER_ERROR).entity("Get failed")
-                                       .type("text/plain").build();
-                       throw new WebApplicationException(response);
-               }
-               if (co == null) {
-                       Response response = Response.status(Response.Status.NOT_FOUND)
-                                       .entity(
-                                                       "Get failed, the requested CollectionObject CSID:"
-                                                                       + csid + ": was not found.").type(
-                                                       "text/plain").build();
-                       throw new WebApplicationException(response);
-               }
-               verbose("getCollectionObject: ", co);
-
-               return co;
-       }
-
-       @PUT
-       @Path("{csid}")
-       public CollectionObject updateCollectionObject(
-                       @PathParam("csid") String csid, CollectionObject theUpdate) {
-
-               verbose("updateCollectionObject with input: ", theUpdate);
-
-               String status = null;
-               try {
-
-                       Document document = service.putCollectionObject(csid, theUpdate);
-                       Element root = document.getRootElement();
-                       for (Iterator i = root.elementIterator(); i.hasNext();) {
-                               Element element = (Element) i.next();
-                               if ("docRef".equals(element.getName())) {
-                                       status = (String) element.getData();
-                                       verbose("updateCollectionObject response: " + status);
-                               }
-                       }
-               } catch (Exception e) {
-                       // FIXME: NOT_FOUND?
-                       Response response = Response.status(Response.Status.NOT_FOUND)
-                                       .entity("Update failed ").type("text/plain").build();
-                       throw new WebApplicationException(response);
-               }
-
-               return theUpdate;
-       }
-
-       @DELETE
-       @Path("{csid}")
-       public void deleteCollectionObject(@PathParam("csid") String csid) {
-
-               verbose("deleteCollectionObject with csid=" + csid);
-               try {
-                       
-                       Document document = service.deleteCollectionObject(csid);
-                       Element root = document.getRootElement();
-                       for (Iterator i = root.elementIterator(); i.hasNext();) {
-                               Element element = (Element) i.next();
-                               if ("docRef".equals(element.getName())) {
-                                       String status = (String) element.getData();
-                                       verbose("deleteCollectionObjectt response: " + status);
-                               }
-                       }
-               } catch (Exception e) {
-                       // FIXME: NOT_FOUND?
-                       Response response = Response.status(Response.Status.NOT_FOUND)
-                                       .entity("Delete failed ").type("text/plain").build();
-                       throw new WebApplicationException(response);
-               }
-
-       }
-
-*/
-
+  //////////////////////////////////////////////////////////////////////
+  /*
+   * Prints a serialized ID pattern to the console (stdout).
+   *
+   * @param    msg  A message.
+   *
+   * @param  idPattern  An ID Pattern.
+   *
+   */
        private void verbose(String msg, IDPattern idPattern) {
+       
                try {
                        verbose(msg);
                        JAXBContext jc = JAXBContext.newInstance(IDPattern.class);
@@ -328,8 +135,16 @@ public class IDResource {
                } catch (Exception e) {
                        e.printStackTrace();
                }
+               
        }
 
+  //////////////////////////////////////////////////////////////////////
+  /*
+   * Prints a message to the console (stdout).
+   *
+   * @param    msg  A message.
+   *
+   */
        private void verbose(String msg) {
                System.out.println("IDResource. " + msg);
        }
index 92aa6c13c535af244a2da97efefbe116c61795b7..91311175b75f08b0fefb61a12c0d525db7038a91 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Interface for the methods of the ID Service.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
  *
  * Based on work by Richard Millet and Sanjay Dalal.
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * @author $Author$
+ * @version $Revision$
+ * $Date$
  */
  
 package org.collectionspace.services;
 
-import org.collectionspace.services.id.*;
-
 public interface IDService {
 
-       // public final static String ID_SCHEMA_NAME = "id"; // Note to self: Where is this used?
-
        // ----------------------------------------
        // IDs
        // ----------------------------------------
@@ -33,6 +36,8 @@ public interface IDService {
        // Create
 
        // Read single object
+       //
+       // Returns the next available ID associated with a specified ID pattern.
        public String nextID(String csid) throws IllegalArgumentException, IllegalStateException;
        
        // Read a list of objects (aka read multiple)
index 8cf1bcd60a2a7a1fbc7ae4b176a3b50e8fd08b5d..ec9a9238054f7b84342d2a7c541742412f14e7a2 100644 (file)
@@ -4,7 +4,14 @@
  * Implementation of portions of the ID Service that use JDBC
  * for persistence of IDPatterns, IDParts, and ID values.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -14,9 +21,9 @@
  *
  * Based on work by Richard Millet and Sanjay Dalal.
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * @author $Author$
+ * @version $Revision$
+ * $Date$
  */
 
 // @TODO: Replace wildcarded import statement for
index 21f268cc784189db042a121b5f9652dbe1d1e4b5..3083800dd98508783f43e4af94154d3fcb22bfb7 100644 (file)
@@ -1,10 +1,17 @@
 /*     
  * AlphabeticIDGenerator
  *
- * <p>An identifier generator that generates an incrementing alphabetic ID
- * from any sequence of characters, as a String object.</p>
+ * Generates identifiers (IDs) that consist of incrementing alphabetic
+ * characters, from within a sequence of characters.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -12,9 +19,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
@@ -315,5 +322,6 @@ public class AlphabeticIDGenerator implements IDGenerator {
                  String.valueOf(this.startChar) + "-" + String.valueOf(this.endChar) +
                  "]+" + ")";
                return regex;
-       }       
+       }
+       
 }
index 61cd834bcbbb86722ffb620ff776c865598d9850..c90d86766ebdec2fbce6951dd52fd34808944e8c 100644 (file)
@@ -1,9 +1,17 @@
  /*    
  * AlphabeticIDPart
  *
- * Models a part of an identifier (ID) whose values are an alphabetic series.
+ * Models a part of an identifier (ID) whose values consist of incrementing
+ * alphabetic characters, from within a sequence of characters.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +19,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 0963894ee38eb54ef7b73a0764ff2dc0cf8ecb69..fa054a769c5918a839d3b44c5f5232256fcfa747 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Interface for a generator class that returns IDs.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
  
 // @TODO: Consider making this class, or a class that implements
index 7c24676face364469733c5acf4e9aa9b0cd6ce27..25d7265cf5c0309e78d950611bb6524a97b1af13 100644 (file)
  *   <li>Static separators</li>
  * </ul>
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -20,9 +27,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 291 $
- * $Date: 2009-06-24 11:48:28 -0700 (Wed, 24 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 7b848c1e7edd286d5279046d55f6f7f437ce11f3..f74f2e22c697f2339976cc1ef37eab3578304f5c 100644 (file)
@@ -1,9 +1,16 @@
  /*    
  * IDPattern
  *
- * <p>Models an identifier (ID), which consists of multiple IDParts.</p>
+ * Models an identifier (ID), which consists of multiple IDParts.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 4d4f7206b6a47fde94dcc43c497e0f1c726520cc..05ea816bf9736c47feb11c32cd5f08295928b1e1 100644 (file)
@@ -1,10 +1,17 @@
 /*     
  * NumericIDGenerator
  *
- * <p>An identifier generator that generates an incrementing ID as a
- * series of numeric values, beginning from an initial value.</p>
+ * Generates identifiers (IDs) that consist of a sequence of
+ * numeric values, beginning from an initial value.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -12,9 +19,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 78977e85fa76565682f3f52fcfebf7a34050eaa3..bb3e5b02ed6fd2e640fd6cdab40972fed5d27887 100644 (file)
@@ -1,11 +1,18 @@
  /*    
  * NumericIDPart
  *
- * Models a part of an identifier (ID) whose values come from an
+ * Models a part of an identifier (ID) whose values consist of an
  * incrementing numeric series, with those values represented as
  * String objects.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -13,9 +20,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index e2c2a391e720d64ed0f414bf010c88f4735b0f49..6ad0b94d5d693cfa162daa7ecaf2a0cb74443f92 100644 (file)
@@ -1,9 +1,16 @@
 /*     
  * StringIDGenerator
  *
- * <p>An identifier generator that stores and returns a static String.</p>
+ * Generates identifiers (IDs) that consist of a static String value.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 16ae1742009be25b0aa327f6a118a8f3b3ae41eb..7fd8981c1ec23e803002539eebe7da6c982434cf 100644 (file)
@@ -1,9 +1,16 @@
  /*    
- * StringIDGenerator
+ * StringIDPart
  *
- * Models a part of an identifier (ID) whose values are an alphabetic series.
+ * Models a part of an identifier (ID) that stores and returns a static String value.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 91578351169a5e1c436bcf1da33f2a4a37d717eb..b098dfdcec2b85fc3b992d79b9cdcc027451795d 100644 (file)
@@ -1,10 +1,17 @@
 /*     
  * YearIDGenerator
  *
- * <p>An identifier generator that stores and returns the current year
- * as a String object.</p>
+ * Generates identifiers (IDs) that store and returns the current year
+ * or a supplied year as a String object.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -12,9 +19,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index f0d7ede9d6958168bcf597590e6dd8e6624b1484..d66bfd901efe5754f1a1c77e4f2d4393e54aa28c 100644 (file)
@@ -4,7 +4,14 @@
  * Models a part of an identifier (ID) whose value is the current year
  * or a supplied year.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -12,9 +19,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Add Javadoc comments
index 20ddaf179557a45e4977079c9bca16295b4f60b1..7a154c48824aab884b695fb323c3a1e8d4317610 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Test class for the ID Service.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 // @TODO: Use a URL builder in core Java or the Restlet framework,
index 5b85ad55a51056e7665fa117391c8833d1ef82df..abde5674a14c92bd909ee5d0dc5cd5bc563cd928 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Test class for AlphabeticIDPart.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 package org.collectionspace.services.id;
index e89653522d80fa8c2623203c23c41201bd45bf84..9a1120b6a7cb1c09258e65036b157e6c081eef2d 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Test class for IDPattern.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 package org.collectionspace.services.id;
index 0708300bbc9d31fa576454df93f086d02d4b4a0e..a21cd88a2b4f49b059faef2363fff63214042cc2 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Test class for NumericIDPart.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 package org.collectionspace.services.id;
index dd3a7a928a0eef4a373247bb4e695d344eea8737..8a4b0ebfbc99655c82f55569284f4984c5e6d2fe 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Test class for StringIDPart.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastChangedDate$
  */
 
 package org.collectionspace.services.id;
index 12b5d85f3eb1fb3e28eb43babc32ab816b7ce2d0..4ce82a32089bb1eb80229b92199f23b82286bbaa 100644 (file)
@@ -3,7 +3,14 @@
  *
  * Test class for YearIDPart.
  *
- * Copyright 2009 Regents of the University of California
+ * This document is a part of the source code and related artifacts
+ * for CollectionSpace, an open source collections management system
+ * for museums and related institutions:
+ *
+ * http://www.collectionspace.org
+ * http://wiki.collectionspace.org
+ *
+ * Copyright © 2009 Regents of the University of California
  *
  * Licensed under the Educational Community License (ECL), Version 2.0.
  * You may not use this file except in compliance with this License.
@@ -11,9 +18,9 @@
  * You may obtain a copy of the ECL 2.0 License at
  * https://source.collectionspace.org/collection-space/LICENSE.txt
  *
- * @author $Author: aron $
- * @version $Revision: 267 $
- * $Date: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
+ * $LastChangedBy$
+ * $LastChangedRevision$
+ * $LastchangedDate: 2009-06-19 19:03:38 -0700 (Fri, 19 Jun 2009) $
  */
 
 package org.collectionspace.services.id;