Changeset 6912 for SRUClient

Timestamp:

01/18/16 15:11:20 (8 years ago)

Author:

Oliver Schonefeld

Message:

• change method setQuery in SRUSearchRetrieveRequest to require a queryType-
• fix some JavaDoc?

Location:

SRUClient/trunk/src

Files:

• main/java/eu/clarin/sru/client/SRUAbstractRequest.java (modified) (2 diffs)
• main/java/eu/clarin/sru/client/SRUClient.java (modified) (1 diff)
• main/java/eu/clarin/sru/client/SRUExtraResponseDataParser.java (modified) (1 diff)
• main/java/eu/clarin/sru/client/SRUSearchRetrieveRequest.java (modified) (7 diffs)
• main/java/eu/clarin/sru/client/SRUSimpleClient.java (modified) (1 diff)
• main/java/eu/clarin/sru/client/SRUThreadedClient.java (modified) (2 diffs)
• main/java/eu/clarin/sru/client/fcs/ClarinFCSClientBuilder.java (modified) (1 diff)
• test/java/eu/clarin/sru/client/TestUtils.java (modified) (1 diff)

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

@@ -417 +417 @@
                         break;
                     default:
-                        throw new SRUClientException("unsupported version: " +
-                                versionRequested);
+                        throw new SRUClientException("internal error: " +
+                                "unsupported value for version (" +
+                                versionRequested + ")");
                     } // switch
                 } else {
@@ -439 +440 @@
                 break;
             default:
-                throw new SRUClientException("unsupported version: " +
-                        versionRequested);
+                throw new SRUClientException("internal error: " +
+                        "unsupported value for version (" +
+                        versionRequested + ")");
             }
 

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

@@ -85 +85 @@
      *            the configuration to be used for this client.
      * @throws NullPointerException
-     *             if argument <code>config</code> is <node>null</code>
+     *             if argument <code>config</code> is <code>null</code>
      * @throws IllegalArgumentException
      *             if an error occurred while registering record data parsers

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

@@ -31 +31 @@
      * Check, if the current element can be handled by this parser.
      *
+     * @param name
+     *            the name of the element to be examined
+     * 
      * @return <code>true</code> if the element can be handled by this parser;
      *         <code>false</code> otherwise

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

@@ -20 +20 @@
 
 /**
- * An object for performing a <em>explain</em> operation.
+ * An object for performing a <em>searchRetrieve</em> operation.
  * <p>
  * The following argument arguments are mandatory:
@@ -26 +26 @@
  * <ul>
  * <li><em>query</em></li>
+ * <li><em>queryType</em>, if using query language other than CQL (only SRU 2.0)</li>
  * </ul>
  *
@@ -90 +91 @@
 
     /**
-     * (SRU 2.0) Set the value of the <em>queryType</em> argument for this
-     * request.
+     * Get the value of the <em>query</em> argument for this request.
+     *
+     * @return the value for the <em>query</em> argument or <code>null</code> of
+     *         none was set
+     */
+    public String getQuery() {
+        return query;
+    }
+
+
+    /**
+     * Set the value of the <em>queryType</em> (SRU 2.0) and the <em>query</em>
+     * argument for this request.
+     * <p>
+     * For SRU 1.1 and SRU 1.2 requests use the following:</p>
+     * <pre>
+     * {@code
+     * String cql_query = ...
+     * SRUSearchRetrieveRequest req =
+     *      new SRUSearchRetrieveRequest("http://endpoint.example.org");
+     * req.setQuery(SRUClientConstants.QUERY_TYPE_CQL, cql_query);
+     * }
+     * </pre>
      *
      * @param queryType
      *            the value for the <em>queryType</em> argument
+     * @param query
+     *            the value for the <em>query</em> argument
      * @throws NullPointerException
      *             if any required argument is <code>null</code>
      * @throws IllegalArgumentException
      *             if any argument is invalid
-     */
-    public void setQueryType(String queryType) {
+     * @see SRUClientConstants#QUERY_TYPE_CQL
+     */
+    public void setQuery(String queryType, String query) {
+        if (query == null) {
+            throw new NullPointerException("query == null");
+        }
+        if (query.isEmpty()) {
+            throw new IllegalArgumentException("query is an empty string");
+        }
         if (queryType == null) {
             throw new NullPointerException("queryType == null");
@@ -117 +148 @@
             }
         }
+
         this.queryType = queryType;
-    }
-
-
-    /**
-     * Get the value of the <em>query</em> argument for this request.
-     *
-     * @return the value for the <em>query</em> argument or <code>null</code> of
-     *         none was set
-     */
-    public String getQuery() {
-        return query;
-    }
-
-
-    /**
-     * Set the value of the <em>query</em> argument for this request.
-     *
-     * @param query
-     *            the value for the <em>query</em> argument
-     * @throws NullPointerException
-     *             if any required argument is <code>null</code>
-     * @throws IllegalArgumentException
-     *             if any argument is invalid
-     */
-    public void setQuery(String query) {
-        if (query == null) {
-            throw new NullPointerException("query == null");
-        }
-        if (query.isEmpty()) {
-            throw new IllegalArgumentException("query is an empty string");
-        }
         this.query = query;
     }
@@ -275 +276 @@
      * Set the <em>recordPacking</em> (SRU 2.0) parameter of this request.
      *
-     * @param getRecordXmlEscaping
-     *            the requested record XML escaping
+     * @param recordPacking
+     *            the requested recordPacking mode
      * @see SRURecordXmlEscaping
      */
@@ -423 +424 @@
                     break;
                 default:
-                    throw new SRUClientException(
-                            "unsupported record XML escpaing: " + recordXmlEscaping);
+                    throw new SRUClientException("internal error: invalid " +
+                            "recordXmlEscaping (" + recordXmlEscaping + ")");
                 } // switch
             }
@@ -443 +444 @@
          */
         if ((version == SRUVersion.VERSION_2_0) && (recordPacking != null)) {
-            String s = null;
             switch (recordPacking) {
             case PACKED:
-                s = "packed";
+                uriHelper.append(PARAM_RECORD_PACKING, RECORD_PACKING_PACKED);
                 break;
             case UNPACKED:
-                s = "unpacked";
+                uriHelper.append(PARAM_RECORD_PACKING, RECORD_PACKING_UNPACKED);
                 break;
-            }
-            uriHelper.append(PARAM_RECORD_PACKING, s);
+            default:
+                throw new SRUClientException("internal error: invalid value " +
+                        "for recordPacking (" + recordPacking + ")");
+            }
         }
 

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

@@ -98 +98 @@
      *            the configuration to be used for this client.
      * @throws NullPointerException
-     *             if argument <code>config</code> is <node>null</code>
+     *             if argument <code>config</code> is <code>null</code>
      * @throws IllegalArgumentException
      *             if an error occurred while registering record data parsers

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

@@ -34 +34 @@
  * <p>
  * This client is reusable and thread-safe: the application may reuse a
- * client object and may shared it between multiple threads. <br />
+ * client object and may shared it between multiple threads.
+ * </p>
+ * <p>
  * NB: The registered {@link SRURecordDataParser} need to be thread-safe
  * </p>
@@ -53 +55 @@
      *            the configuration to be used for this client.
      * @throws NullPointerException
-     *             if argument <code>config</code> is <node>null</code>
+     *             if argument <code>config</code> is <code>null</code>
      * @throws IllegalArgumentException
      *             if an error occurred while registering record data parsers

SRUClient/trunk/src/main/java/eu/clarin/sru/client/fcs/ClarinFCSClientBuilder.java

@@ -50 +50 @@
     /**
      * Constructor.
+     * 
+     * @param unknownAsDom
+     *            if <code>true</code> unknown data views are parsed into a DOM
+     * 
      */
     public ClarinFCSClientBuilder(boolean unknownAsDom) {

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

@@ -62 +62 @@
         }
         SRUSearchRetrieveRequest request = new SRUSearchRetrieveRequest(baseURI);
-        request.setQuery(query);
+        request.setQuery(SRUClientConstants.QUERY_TYPE_CQL, query);
 //        request.setRecordSchema(ClarinFCSRecordData.LEGACY_RECORD_SCHEMA);
         request.setMaximumRecords(5);