Changeset 2866

Timestamp:

05/06/13 18:35:04 (11 years ago)

Author:

oschonef

Message:

• deprecate getRecordSchemaName() method of SRURequest

HEADS UP: method will be removed in next version. Adjust you source and use use getRecordSchemaIdentifier() instead.

Location:

SRUServer/trunk/src/main/java/eu/clarin/sru/server

Files:

• SRURequest.java (modified) (2 diffs)
• SRURequestImpl.java (modified) (6 diffs)
• SRUServer.java (modified) (1 diff)

SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRURequest.java

@@ -126 +126 @@
      * @return the record schema name or <code>null</code> if no value was
      *         supplied for this request
-     * @see #getRecordSchemaIdentifier()
-     */
+     * @deprecated use {@link #getRecordSchemaIdentifier()}
+     */
+    @Deprecated
     public String getRecordSchemaName();
 
@@ -134 +135 @@
      * Get the record schema identifier derived from the <em>recordSchema</em>
      * parameter of this request. Only available for <em>searchRetrieve</em>
-     * requests.
+     * requests. If the request was send with the short record schema name,
+     * it will automatically expanded to the record schema identifier.
      *
      * @return the record schema identifier or <code>null</code> if no
      *         <em>recordSchema</em> parameter was supplied for this request
-     * @see #getRecordSchemaName()
      */
     public String getRecordSchemaIdentifier();

SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRURequestImpl.java

@@ -68 +68 @@
     private int startRecord = DEFAULT_START_RECORD;
     private int maximumRecords = -1;
-    private String recordSchemaName;
     private String recordSchemaIdentifier;
+    private String rawRecordSchemaIdentifier;
     private String stylesheet;
     private String recordXPath;
@@ -309 +309 @@
                         if (value != null) {
                             /*
-                             * If the recordSchema is supplied, check if it is
-                             * supported by this endpoint. If not, raise
-                             * an error. recoedSchema may contain either
-                             * schema identifier or the short name.
+                             * The parameter recordSchema may contain either
+                             * schema identifier or the short name. If
+                             * available, set to appropriate schema identifier
+                             * in the request object.
                              */
                             SRUServerConfig.SchemaInfo schemaInfo =
@@ -319 +319 @@
                                 recordSchemaIdentifier =
                                         schemaInfo.getIdentifier();
-                                recordSchemaName =
-                                        schemaInfo.getName();
                             } else {
+                                /*
+                                 * SRU servers are supposed to raise a
+                                 * non-surrogate (fatal) diagnostic in case the
+                                 * record schema is not known to the server.
+                                 */
                                 addDiagnostic(
                                         SRUConstants.SRU_UNKNOWN_SCHEMA_FOR_RETRIEVAL,
-                                        value,
-                                        "Record schema \"" + value +
-                                        "\" is not supported for retrieval.");
+                                        value, "Record schema \"" + value +
+                                        "\" is not supported  for retrieval.");
                             }
+
+                            // always save submitted parameter
+                            rawRecordSchemaIdentifier = value;
                         }
                         break;
@@ -386 +391 @@
         }
 
-        // diagnostics != null -> consider as sucesss
+        // diagnostics != null -> consider as success
         return (diagnostics == null);
     }
@@ -403 +408 @@
     SRURecordPacking getRawRecordPacking() {
         return recordPacking;
+    }
+
+
+    String getRawRecordSchemaIdentifier() {
+        return rawRecordSchemaIdentifier;
     }
 
@@ -516 +526 @@
 
     @Override
+    @Deprecated
     public String getRecordSchemaName() {
-        return recordSchemaName;
+        return getRawRecordSchemaIdentifier();
     }
 

SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUServer.java

@@ -967 +967 @@
 
         // echoedSearchRetrieveRequest/recordSchema
-        if (request.getRecordSchemaName() != null) {
+        if (request.getRawRecordSchemaIdentifier() != null) {
             out.writeStartElement(SRU_NS, "recordSchema");
-            out.writeCharacters(request.getRecordSchemaName());
+            out.writeCharacters(request.getRawRecordSchemaIdentifier());
             out.writeEndElement(); // "recordSchema" element
         }