Changeset 2088 for SRUClient/trunk/src/main/java/eu/clarin/sru/fcs/ClarinFederatedContentSearchRecordParser.java

Timestamp:

08/14/12 17:22:03 (12 years ago)

Author:

oschonef

Message:

• add JavaDocs? to public API
• fix wrong constructor visibility with *Request classes
• do a better job in hiding some non-public API

File:

• SRUClient/trunk/src/main/java/eu/clarin/sru/fcs/ClarinFederatedContentSearchRecordParser.java (modified) (5 diffs)

SRUClient/trunk/src/main/java/eu/clarin/sru/fcs/ClarinFederatedContentSearchRecordParser.java

@@ +1 @@
+/**
+ * This software is copyright (c) 2011 by
+ *  - Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
+ * This is free software. You can redistribute it
+ * and/or modify it under the terms described in
+ * the GNU General Public License v3 of which you
+ * should have received a copy. Otherwise you can download
+ * it from
+ *
+ *   http://www.gnu.org/licenses/gpl-3.0.txt
+ *
+ * @copyright Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
+ *
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt
+ *  GNU General Public License v3
+ */
 package eu.clarin.sru.fcs;
 
@@ -12 +28 @@
 import eu.clarin.sru.client.XmlStreamReaderUtils;
 
+
+/**
+ * A record for CLARIN FCS.
+ */
 public class ClarinFederatedContentSearchRecordParser implements
         SRURecordDataParser {
@@ -21 +41 @@
     private static final String DATAVIEW_KWIC = "kwic";
 
-    
+
     @Override
     public String getRecordSchema() {
@@ -27 +47 @@
     }
 
-    
+
     @Override
     public SRURecordData parse(XMLStreamReader reader)
             throws XMLStreamException, SRUClientException {
         XmlStreamReaderUtils.readStart(reader, FCS_NS, "Resource", true, true);
-        String pid = XmlStreamReaderUtils.readAttributeValue(reader, null, "pid");
+        String pid = XmlStreamReaderUtils.readAttributeValue(reader, null,
+                "pid");
         XmlStreamReaderUtils.consumeStart(reader);
-        
-        String left    = null;
+
+        String left = null;
         String keyword = null;
-        String right   = null;
+        String right = null;
 
         boolean first = true;
         boolean kwic = false;
-        
-        while (XmlStreamReaderUtils.readStart(reader, FCS_NS, "DataView", first, true)) {
+
+        while (XmlStreamReaderUtils.readStart(reader, FCS_NS, "DataView",
+                first, true)) {
             first = false;
-            String type = XmlStreamReaderUtils.readAttributeValue(reader, null, "type");
+            String type = XmlStreamReaderUtils.readAttributeValue(reader, null,
+                    "type");
             XmlStreamReaderUtils.consumeStart(reader);
             if ((type == null) || type.isEmpty()) {
@@ -53 +76 @@
             if (DATAVIEW_KWIC.equals(type)) {
                 if (kwic) {
-                    throw new SRUClientException("only one KWIC dataview is allowed");
+                    throw new SRUClientException(
+                            "only one KWIC dataview is allowed");
                 }
-                XmlStreamReaderUtils.readStart(reader, FCS_KWIC_NS, "kwic", true);
-                if (XmlStreamReaderUtils.readStart(reader, FCS_KWIC_NS, "c", false)) {
+                XmlStreamReaderUtils.readStart(reader, FCS_KWIC_NS, "kwic",
+                        true);
+                if (XmlStreamReaderUtils.readStart(reader, FCS_KWIC_NS, "c",
+                        false)) {
                     left = XmlStreamReaderUtils.readString(reader, false);
                     XmlStreamReaderUtils.readEnd(reader, FCS_KWIC_NS, "c");
                 }
-                keyword = XmlStreamReaderUtils.readContent(reader, FCS_KWIC_NS, "kw", true);
-                if (XmlStreamReaderUtils.readStart(reader, FCS_KWIC_NS, "c", false)) {
+                keyword = XmlStreamReaderUtils.readContent(reader, FCS_KWIC_NS,
+                        "kw", true);
+                if (XmlStreamReaderUtils.readStart(reader, FCS_KWIC_NS, "c",
+                        false)) {
                     right = XmlStreamReaderUtils.readString(reader, false);
                     XmlStreamReaderUtils.readEnd(reader, FCS_KWIC_NS, "c");