Changeset 5797 for SRUClient

Timestamp:

11/12/14 00:05:24 (10 years ago)

Author:

Oliver Schonefeld

Message:

• add support for parsing extra response data

Location:

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

Files:

• SRUAbstractResponse.java (modified) (5 diffs)
• SRUClient.java (modified) (10 diffs)
• SRUClientConfig.java (modified) (8 diffs)
• SRUExplainResponse.java (modified) (2 diffs)
• SRUExtraResponseData.java (added)
• SRUExtraResponseDataParser.java (added)
• SRUGenericExtraResponseData.java (added)
• SRURecordData.java (modified) (1 diff)
• SRUScanResponse.java (modified) (2 diffs)
• SRUSearchRetrieveResponse.java (modified) (2 diffs)

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

@@ -20 +20 @@
 import java.util.List;
 
-import org.w3c.dom.DocumentFragment;
-
 
 
@@ -34 +32 @@
     private final T request;
     private final List<SRUDiagnostic> diagnostics;
-    private final DocumentFragment extraResponseData;
+    private final List<SRUExtraResponseData> extraResponseData;
     private final int totalBytesTransferred;
     private final long timeTotal;
@@ -68 +66 @@
     protected SRUAbstractResponse(T request,
             List<SRUDiagnostic> diagnostics,
-            DocumentFragment extraResponseData,
+            List<SRUExtraResponseData> extraResponseData,
             int totalBytesTransferred,
             long timeTotal,
@@ -78 +76 @@
                 ? Collections.unmodifiableList(diagnostics)
                 : null;
-        this.extraResponseData     = extraResponseData;
+        this.extraResponseData = ((extraResponseData != null) &&
+                                                !extraResponseData.isEmpty())
+                ? Collections.unmodifiableList(extraResponseData)
+                : null;
         this.totalBytesTransferred = totalBytesTransferred;
         this.timeTotal             = timeTotal;
@@ -125 +126 @@
      * Get the extra response data for this result.
      *
-     * @return get an instance of {@link DocumentFragment} containing the XML
-     *         fragment for the extra response data from the SRU response or
-     *         <code>null</code> if none are available
-     */
-    public DocumentFragment getExtraResponseData() {
+     * @return get a list of {@link SRUExtraResponseData} instances for the
+     *         extra response data from the SRU response or <code>null</code> if
+     *         none are available
+     */
+    public List<SRUExtraResponseData> getExtraResponseData() {
         return extraResponseData;
     }

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

@@ -18 +18 @@
 
 import java.util.ArrayDeque;
+import java.util.ArrayList;
 import java.util.Deque;
 import java.util.LinkedList;
@@ -24 +25 @@
 
 import javax.xml.XMLConstants;
+import javax.xml.namespace.QName;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
@@ -31 +33 @@
 import javax.xml.stream.XMLStreamReader;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.w3c.dom.Attr;
 import org.w3c.dom.DOMException;
@@ -49 +53 @@
  */
 public class SRUClient {
+    private static final Logger logger = LoggerFactory.getLogger(SRUClient.class);
     private final SRUSimpleClient client;
     private final Handler handler;
     /* common */
     private List<SRUDiagnostic> diagnostics;
-    private DocumentFragment extraResponseData;
+    private List<SRUExtraResponseData> extraResponseData;
     /* scan */
     private List<SRUTerm> terms;
@@ -116 +121 @@
         }
         this.client = new SRUSimpleClient(config);
-        this.handler = new Handler();
+        this.handler = new Handler(config);
         try {
             synchronized (documentBuilderFactory) {
@@ -282 +287 @@
 
 
+
     private class Handler extends SRUDefaultHandlerAdapter {
+        private final List<SRUExtraResponseDataParser> parsers;
+
+
+        private Handler(SRUClientConfig config) {
+            this.parsers = config.getExtraResponseDataParsers();
+        }
+
+
         @Override
         public void onDiagnostics(List<SRUDiagnostic> diagnostics)
@@ -293 +307 @@
         public void onExtraResponseData(XMLStreamReader reader)
                 throws XMLStreamException, SRUClientException {
-            SRUClient.this.extraResponseData =
-                    copyStaxToDocumentFragment(documentBuilder, stack, reader);
+            if (reader.getEventType() == XMLStreamConstants.START_DOCUMENT) {
+                reader.next();
+            }
+
+            while (reader.hasNext()) {
+                SRUExtraResponseData data = null;
+
+                XmlStreamReaderUtils.consumeWhitespace(reader);
+                switch (reader.getEventType()) {
+                case XMLStreamConstants.START_ELEMENT:
+                    final QName root = reader.getName();
+                    logger.debug("@start: {}", root);
+
+                    /*
+                     * The content model of "extraResponseData" is a sequence
+                     * of elements. Parse each child element into a separate
+                     * entity, i.e. if a parse is available for handling the
+                     * element use it, otherwise parse into a document fragment.
+                     */
+                    if ((parsers != null) && !parsers.isEmpty()) {
+                        for (SRUExtraResponseDataParser parser: parsers) {
+                            if (parser.supports(root)) {
+                                logger.debug("parsing extra response data with parser '{}'",
+                                        parser.getClass().getName());
+                                data = parser.parse(reader);
+                                break;
+                            }
+                        }
+                    }
+                    if (data == null) {
+                        logger.debug("parsing of extra response data (generic)");
+                        data = parseExtraResponseAsDocumentFragment(
+                                root, documentBuilder, stack, reader);
+                    }
+                    break;
+                case XMLStreamConstants.END_DOCUMENT:
+                    break;
+                default:
+                  throw new SRUClientException("expected a start element at " +
+                          "this location (event code = " +
+                          reader.getEventType() + ")");
+                }
+
+                if (data != null) {
+                    if (SRUClient.this.extraResponseData == null) {
+                        SRUClient.this.extraResponseData =
+                                new ArrayList<SRUExtraResponseData>();
+                    }
+                    SRUClient.this.extraResponseData.add(data);
+                }
+            } // while
+
         }
 
@@ -391 +455 @@
 
 
+    private static SRUExtraResponseData parseExtraResponseAsDocumentFragment(
+            QName name, DocumentBuilder builder, Deque<Node> stack, XMLStreamReader reader)
+            throws XMLStreamException {
+        return new SRUGenericExtraResponseData(name,
+                copyStaxToDocumentFragment(builder, stack, reader));
+    }
+
+
     private static DocumentFragment copyStaxToDocumentFragment(
             DocumentBuilder builder, Deque<Node> stack, XMLStreamReader reader)
@@ -398 +470 @@
             stack.push(doc.createDocumentFragment());
 
-            while (reader.hasNext()) {
+            boolean stop = false;
+            while (!stop && reader.hasNext()) {
                 final Node parent = stack.peek();
                 switch (reader.getEventType()) {
@@ -406 +479 @@
                 case XMLStreamConstants.END_ELEMENT:
                     stack.pop();
+                    if (stack.size() == 1) {
+                        stop = true;
+                    }
                     break;
                 case XMLStreamConstants.CHARACTERS:

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

@@ -35 +35 @@
     private final int socketTimeout;
     private final int threadCount;
-    private final List<SRURecordDataParser> parsers;
+    private final List<SRURecordDataParser> recordParsers;
+    private final List<SRUExtraResponseDataParser> extraDataParsers;
 
 
@@ -85 +86 @@
      */
     public List<SRURecordDataParser> getRecordDataParsers() {
-        return parsers;
+        return recordParsers;
+    }
+
+
+    /**
+     * Get the list of extra response data parsers to be used.
+     *
+     * @return the list of extra response data parsers.
+     */
+    public List<SRUExtraResponseDataParser> getExtraResponseDataParsers() {
+        return extraDataParsers;
     }
 
@@ -93 +104 @@
             throw new NullPointerException("builder == null");
         }
-        this.defaultVersion = builder.getDefaultVersion();
-        this.connectTimeout = builder.getConnectTimeout();
-        this.socketTimeout  = builder.getSocketTimeout();
-        this.parsers        = builder.getRecordDataParsers();
-        this.threadCount    = builder.getThreadCount();
+        this.defaultVersion   = builder.getDefaultVersion();
+        this.connectTimeout   = builder.getConnectTimeout();
+        this.socketTimeout    = builder.getSocketTimeout();
+        this.threadCount      = builder.getThreadCount();
+        this.recordParsers    = builder.getRecordDataParsers();
+        this.extraDataParsers = builder.getExtraResponseDataParsers();
     }
 
@@ -113 +125 @@
         private int threadCount           =
                 Runtime.getRuntime().availableProcessors() * 2;
-        private List<SRURecordDataParser> parsers =
+        private List<SRURecordDataParser> recordParsers =
                 new ArrayList<SRURecordDataParser>();
+        private List<SRUExtraResponseDataParser> extraDataParsers = null;
 
 
@@ -250 +263 @@
          */
         public List<SRURecordDataParser> getRecordDataParsers() {
-            return Collections.unmodifiableList(parsers);
+            return Collections.unmodifiableList(recordParsers);
+        }
+
+
+        /**
+         * Get the list of extra response data parsers.
+         *
+         * @return the list of extra response data parsers
+         * @see SRUExtraResponseDataParser
+         */
+        public List<SRUExtraResponseDataParser> getExtraResponseDataParsers() {
+            if (extraDataParsers != null) {
+                return Collections.unmodifiableList(extraDataParsers);
+            } else {
+                return null;
+            }
         }
 
@@ -261 +289 @@
          * @return this {@link Builder} instance
          * @throws IllegalArgumentException
-         *             if registering the parser fails
+         *             if registering of the parser fails
+         * @see SRURecordDataParser
          */
         public Builder addRecordDataParser(SRURecordDataParser parser) {
@@ -277 +306 @@
             }
 
-            for (SRURecordDataParser p : parsers) {
+            for (SRURecordDataParser p : recordParsers) {
                 if (p.getRecordSchema().equals(recordSchema)) {
                     throw new IllegalArgumentException(
@@ -284 +313 @@
                 }
             }
-            parsers.add(parser);
+            recordParsers.add(parser);
+            return this;
+        }
+
+
+        /**
+         * Add an extra response data parser instance to the list of extra
+         * response data parsers
+         *
+         * @param parser
+         *            the extra response data parser to be added
+         * @return this {@link Builder} instance
+         * @throws IllegalArgumentException
+         *             if registering of the parser fails
+         * @see SRUExtraResponseDataParser
+         */
+        public Builder addExtraResponseDataParser(SRUExtraResponseDataParser parser) {
+            if (parser == null) {
+                throw new NullPointerException("parser == null");
+            }
+            if (extraDataParsers == null) {
+                extraDataParsers = new ArrayList<SRUExtraResponseDataParser>();
+            }
+            extraDataParsers.add(parser);
             return this;
         }

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

@@ -19 +19 @@
 import java.util.List;
 
-import org.w3c.dom.DocumentFragment;
-
 
 
@@ -33 +31 @@
     SRUExplainResponse(SRUExplainRequest request,
             List<SRUDiagnostic> diagnostics,
-            DocumentFragment extraResponseData,
+            List<SRUExtraResponseData> extraResponseData,
             int totalBytesTransferred,
             long timeTotal,

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

@@ -18 +18 @@
 
 /**
- * Interface for parsed record data.
+ * Interface for parsed record data objects.
  *
  */

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

@@ -20 +20 @@
 import java.util.List;
 
-import org.w3c.dom.DocumentFragment;
-
 
 
@@ -33 +31 @@
     SRUScanResponse(SRUScanRequest request,
             List<SRUDiagnostic> diagnostics,
-            DocumentFragment extraResponseData,
+            List<SRUExtraResponseData> extraResponseData,
             int totalBytesTransferred,
             long timeTotal,

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

@@ -20 +20 @@
 import java.util.List;
 
-import org.w3c.dom.DocumentFragment;
-
 
 
@@ -38 +36 @@
     SRUSearchRetrieveResponse(SRUSearchRetrieveRequest request,
             List<SRUDiagnostic> diagnostics,
-            DocumentFragment extraResponseData,
+            List<SRUExtraResponseData> extraResponseData,
             int totalBytesTransferred,
             long timeTotal,