Changeset 6903 for SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUSearchRetrieveRequest.java

Timestamp:

01/12/16 21:03:47 (8 years ago)

Author:

Oliver Schonefeld

Message:

• some steps towards SRU 2.0

File:

• SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUSearchRetrieveRequest.java (modified) (8 diffs)

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

@@ -43 +43 @@
             "x-malformed-maximumRecords";
     /** for end-point conformance testing only. never use in production. */
-    public static final String X_MALFORMED_RECORD_PACKING =
+    public static final String X_MALFORMED_RECORD_XML_ESCAPING =
             "x-malformed-recordPacking";
+    private String queryType;
     private String query;
     private int startRecord = -1;
     private int maximumRecords = -1;
+    private SRURecordXmlEscaping recordXmlEscaping;
     private SRURecordPacking recordPacking;
     private String recordSchema;
@@ -72 +74 @@
     public SRUSearchRetrieveRequest(String baseURI) {
         super(baseURI);
+    }
+
+
+    /**
+     * (SRU 2.0) Get the value of the <em>queryType</em> argument for this
+     * request.
+     *
+     * @return the value for the <em>queryType</em> argument or
+     *         <code>null</code> of none was set
+     */
+    public String getQueryType() {
+        return queryType;
+    }
+
+
+    /**
+     * (SRU 2.0) Set the value of the <em>queryType</em> argument for this
+     * request.
+     *
+     * @param queryType
+     *            the value for the <em>queryType</em> argument
+     * @throws NullPointerException
+     *             if any required argument is <code>null</code>
+     * @throws IllegalArgumentException
+     *             if any argument is invalid
+     */
+    public void setQueryType(String queryType) {
+        if (queryType == null) {
+            throw new NullPointerException("queryType == null");
+        }
+        if (queryType.isEmpty()) {
+            throw new IllegalArgumentException("queryType is an empty string");
+        }
+        for (int i = 0; i < queryType.length(); i++) {
+            final char ch = queryType.charAt(i);
+            if (!((ch >= 'a' && ch <= 'z') ||
+                    (ch >= 'A' && ch <= 'Z') ||
+                    (ch >= '0' && ch <= '9') ||
+                    ((i > 0) && ((ch == '-') || ch == '_')))) {
+                throw new IllegalArgumentException(
+                        "queryType contains illegal characters");
+            }
+        }
+        this.queryType = queryType;
     }
 
@@ -188 +234 @@
 
     /**
-     * Get the value of the <em>recordSchema</em> argument for this request.
-     *
-     * @return the value for the <em>recordSchema</em> argument or
-     *         <code>null</code> of none was set
+     * Get the <em>recordXmlEscpaing</em> (SRU 2.0) or <em>recordPacking</em>
+     * (SRU 1.1 and SRU 1.2) parameter of this request.
+     *
+     * @return the requested record XML escaping
+     * @see SRURecordXmlEscaping
+     */
+    public SRURecordXmlEscaping getRecordXmlEscaping() {
+        return recordXmlEscaping;
+    }
+
+
+    /**
+     * Set the <em>recordXmlEscpaing</em> (SRU 2.0) or <em>recordPacking</em>
+     * (SRU 1.1 and SRU 1.2) parameter of this request.
+     *
+     * @param recordXmlEscaping
+     *            the requested record XML escaping
+     * @see SRURecordXmlEscaping
+     */
+    public void setRecordXmlEscaping(SRURecordXmlEscaping recordXmlEscaping) {
+        if (recordXmlEscaping == null) {
+            throw new NullPointerException("recordXmlEscaping == null");
+        }
+        this.recordXmlEscaping = recordXmlEscaping;
+    }
+
+
+    /**
+     * Get the <em>recordPacking</em> (SRU 2.0) parameter of this request.
+     *
+     * @return the requested record packing
+     * @see SRURecordPacking
      */
     public SRURecordPacking getRecordPacking() {
@@ -199 +273 @@
 
     /**
-     * Set the value of the <em>recordPacking</em> argument for this request.
-     *
-     * @param recordPacking
-     *            the value for the <em>recordPacking</em> argument
-     * @throws NullPointerException
-     *             if any required argument is <code>null</code>
+     * Set the <em>recordPacking</em> (SRU 2.0) parameter of this request.
+     *
+     * @param getRecordXmlEscaping
+     *            the requested record XML escaping
+     * @see SRURecordXmlEscaping
      */
     public void setRecordPacking(SRURecordPacking recordPacking) {
@@ -245 +318 @@
 
     @Override
-    void addParametersToURI(URIHelper uriHelper) throws SRUClientException {
+    void addParametersToURI(URIHelper uriHelper, SRUVersion version)
+            throws SRUClientException {
         /*
          * append query argument (mandatory)
@@ -268 +342 @@
 
         /*
+         * append queryType parameter (SRU 2.0, optional)
+         */
+        if ((version == SRUVersion.VERSION_2_0) && (queryType != null)) {
+            if (!SRUClientConstants.QUERY_TYPE_CQL.equals(queryType)) {
+                uriHelper.append(PARAM_QUERY_TYPE, queryType);
+            }
+        }
+
+        /*
          * append startRecord argument (optional)
          *
@@ -309 +392 @@
 
         /*
-         * append recordPacking argument (optional)
+         * append record XML escaping argument (optional)
          *
          * NB: Setting "x-malformed-recordPacking" as an extra request
@@ -316 +399 @@
          * (i.e. provoke an error) and SHOULD NEVER be used in production!
          */
-        final String malformedRecordPacking =
-                getExtraRequestData(X_MALFORMED_RECORD_PACKING);
-        if (malformedRecordPacking == null) {
-            if (recordPacking != null) {
-                switch (recordPacking) {
+        final String malformedRecordXmlEscaping =
+                getExtraRequestData(X_MALFORMED_RECORD_XML_ESCAPING);
+        if (malformedRecordXmlEscaping == null) {
+            if (recordXmlEscaping != null) {
+                switch (recordXmlEscaping) {
                 case XML:
-                    uriHelper.append(PARAM_RECORD_PACKING, RECORD_PACKING_XML);
+                    if (version == SRUVersion.VERSION_2_0) {
+                        uriHelper.append(PARAM_RECORD_XML_ESCAPING,
+                                RECORD_XML_ESCAPING_XML);
+                    } else {
+                        uriHelper.append(PARAM_RECORD_PACKING,
+                                RECORD_XML_ESCAPING_XML);
+                    }
                     break;
                 case STRING:
-                    uriHelper.append(PARAM_RECORD_PACKING,
-                            RECORD_PACKING_STRING);
+                    if (version == SRUVersion.VERSION_2_0) {
+                        uriHelper.append(PARAM_RECORD_XML_ESCAPING,
+                                RECORD_XML_ESCPAING_STRING);
+                    } else {
+                        uriHelper.append(PARAM_RECORD_PACKING,
+                                RECORD_XML_ESCPAING_STRING);
+                    }
                     break;
                 default:
                     throw new SRUClientException(
-                            "unsupported record packing: " + recordPacking);
+                            "unsupported record XML escpaing: " + recordXmlEscaping);
                 } // switch
             }
         } else {
-            if (!malformedRecordPacking.equalsIgnoreCase(MALFORMED_OMIT)) {
-                uriHelper.append(PARAM_RECORD_PACKING, malformedRecordPacking);
-            }
+            if (!malformedRecordXmlEscaping.equalsIgnoreCase(MALFORMED_OMIT)) {
+                if (version == SRUVersion.VERSION_2_0) {
+                    uriHelper.append(PARAM_RECORD_XML_ESCAPING,
+                            malformedRecordXmlEscaping);
+                } else {
+                    uriHelper.append(PARAM_RECORD_PACKING,
+                            malformedRecordXmlEscaping);
+                }
+            }
+        }
+
+        /*
+         * (SRU 2.0) append recordPacking argument (optional)
+         */
+        if ((version == SRUVersion.VERSION_2_0) && (recordPacking != null)) {
+            String s = null;
+            switch (recordPacking) {
+            case PACKED:
+                s = "packed";
+                break;
+            case UNPACKED:
+                s = "unpacked";
+                break;
+            }
+            uriHelper.append(PARAM_RECORD_PACKING, s);
         }