Changeset 2997 for SRUClient

Timestamp:

06/05/13 15:00:13 (11 years ago)

Author:

oschonef

Message:

• add proper interface for enabling or disabling parsing of the explain record data (aka ZeeRex? record)

Location:

SRUClient/trunk/src

Files:

• main/java/eu/clarin/sru/client/SRUExplainRequest.java (modified) (2 diffs)
• main/java/eu/clarin/sru/client/SRUSimpleClient.java (modified) (2 diffs)
• test/java/eu/clarin/sru/client/TestUtils.java (modified) (3 diffs)

SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUExplainRequest.java

@@ -27 +27 @@
 public class SRUExplainRequest extends SRUAbstractRequest {
     private SRURecordPacking recordPacking;
-
+    private boolean parseRecordDataEnabled = false;
 
     /**
@@ -77 +77 @@
 
 
+    /**
+     * Enable or disable parsing of explain record data (ZeeRex record) of the
+     * explain response.
+     * 
+     * @param enabled
+     *            <code>true</code> enabled parsing, <code>false</code> disables
+     *            parsing
+     */
+    public void setParseRecordDataEnabled(boolean enabled) {
+        this.parseRecordDataEnabled = enabled;
+    }
+    
+
+    /**
+     * Check, whether the record data of a explain response (ZeeRex record)
+     * shall be parsed or not.
+     * 
+     * @return <code>true</code> if parsing is enabled, <code>false</code>
+     *         otherwise
+     */
+    public boolean isParseRecordDataEnabled() {
+        return parseRecordDataEnabled;
+    }
+
+
     @Override
     SRUOperation getOperation() {

SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUSimpleClient.java

@@ -85 +85 @@
     private final SRUExplainRecordDataParser explainRecordParser =
             new SRUExplainRecordDataParser();
-    // FIXME: temporary hack
-    public static final String X_PARSE_ZEEREX_RECORD_DATA =
-            "x-parse-zeerex-record-data";
 
     /**
@@ -497 +494 @@
         logger.debug("parsing 'explain' response (mode = {})",
                 (request.isStrictMode() ? "strict" : "non-strict"));
-
-        // FIXME: temporary hack
-        boolean parseRecordData =
-                (request.getExtraRequestData(X_PARSE_ZEEREX_RECORD_DATA) != null);
-        doParseExplainResponse(reader, request, handler, parseRecordData);
+        /*
+         * Eventually, SRUClient should always parse explain record data.
+         * However, for now, make caller explicitly ask for it.
+         */
+        final boolean parse = request.isParseRecordDataEnabled();
+        if (!parse) {
+            logger.debug("parsing of explain record data skipped");
+        }
+        doParseExplainResponse(reader, request, handler, parse);
     }
 

SRUClient/trunk/src/test/java/eu/clarin/sru/client/TestUtils.java

@@ -40 +40 @@
         SRUExplainRequest request = new SRUExplainRequest(baseURI);
         request.setExtraRequestData("x-indent-response", "4");
-        request.setExtraRequestData(SRUSimpleClient.X_PARSE_ZEEREX_RECORD_DATA, "true");
+        request.setParseRecordDataEnabled(true);
         return request;
     }
@@ -49 +49 @@
         request.setScanClause("fcs.resource = root");
         request.setExtraRequestData("x-clarin-resource-info", "true");
+        request.setExtraRequestData("x-indent-response", "4");
         return request;
     }
@@ -62 +63 @@
         request.setMaximumRecords(5);
         request.setRecordPacking(SRURecordPacking.XML);
-//        request.setExtraRequestData("x-indent-response", "4");
+        request.setExtraRequestData("x-indent-response", "4");
         return request;
     }