Changeset 5670

Timestamp:

09/23/14 06:53:21 (10 years ago)

Author:

Oliver Schonefeld

Message:

• work-in-progress

Location:

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs

Files:

• DataView.java (modified) (4 diffs)
• SimpleEndpointSearchEngineBase.java (modified) (5 diffs)
• XMLStreamWriterHelper.java (modified) (3 diffs)
• utils/AbstractEndpointDescriptionBase.java (modified) (2 diffs)

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/DataView.java

@@ -59 +59 @@
 
 
+    /**
+     * Get the identifier of this data view.
+     * 
+     * @return the identifier of the data view
+     */
     public String getIdentifier() {
         return identifier;
@@ -64 +69 @@
 
 
+    /**
+     * Get the MIME type of this data view.
+     * 
+     * @return the MIME type of this data view
+     */
     public String getMimeType() {
         return mimeType;
@@ -69 +79 @@
 
 
+    /**
+     * Get the delivery policy for this data view.
+     * 
+     * @return the delivery policy of this data view
+     * @see DeliveryPolicy
+     */
     public DeliveryPolicy getDeliveryPolicy() {
         return deliveryPolicy;
@@ -84 +100 @@
         return sb.toString();
     }
+
 } // class DataView

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/SimpleEndpointSearchEngineBase.java

@@ -37 +37 @@
 public abstract class SimpleEndpointSearchEngineBase extends
         SRUSearchEngineBase {
+    private static final String FCS_DISABLE_LEGECY_MODE =
+            "eu.clarin.sru.server.fcs.disableLegacyMode";
     private static final String X_FCS_ENDPOINT_DESCRIPTION = "x-fcs-endpoint-description";
     private static final String X_CMD_RESOURCE_INFO = "x-cmd-resource-info";
@@ -51 +53 @@
             LoggerFactory.getLogger(SimpleEndpointSearchEngineBase.class);
     protected EndpointDescription endpointDescription;
+    private boolean disableLegecyMode;
 
 
@@ -78 +81 @@
                     "returned no valid implementation of an EndpointDescription");
         }
+
+        if (params.containsKey(FCS_DISABLE_LEGECY_MODE)) {
+            logger.info("disabling FCS legacy mode");
+            this.disableLegecyMode = false;
+        } else {
+            this.disableLegecyMode = true;
+        }
     }
 
@@ -138 +148 @@
             SRURequest request, SRUDiagnosticList diagnostics)
             throws SRUException {
-        /*
-         * Check if we got a scan on fcs.resource. If yes, handle it
-         * accordingly, otherwise delegate to user-provided implementation.
-         */
-        final List<ResourceInfo> result =
-                translateFcsScanResource(request.getScanClause());
-        if (result != null) {
+
+        if (isLegacyMode()) {
             /*
-             * Make sure, we honor the maximumTerms limit, of the client
-             * requests it ...
+             * Check if we got a scan on fcs.resource. If yes, handle it
+             * accordingly, otherwise delegate to user-provided implementation.
              */
-            final int maxTerms
-                = ((result.size() > 0) && (request.getMaximumTerms() > 0))
-                ? Math.min(result.size(), request.getMaximumTerms())
-                : result.size();
-
-            /*
-             * Shall we provide extended resource information ... ?
-             */
-            final boolean provideResourceInfo = parseBoolean(
-                    request.getExtraRequestData(X_CMD_RESOURCE_INFO));
-
-            return new SRUScanResultSet(diagnostics) {
-                private int idx = -1;
-
-                @Override
-                public boolean nextTerm() {
-                    return (result != null) && (++idx < maxTerms);
-                }
-
-
-                @Override
-                public String getValue() {
-                    return result.get(idx).getPid();
-                }
-
-
-                @Override
-                public int getNumberOfRecords() {
-                    return -1;
-                }
-
-
-                @Override
-                public String getDisplayTerm() {
-                    return result.get(idx).getTitle("en");
-                }
-
-
-                @Override
-                public WhereInList getWhereInList() {
-                    return null;
-                }
-
-
-                @Override
-                public boolean hasExtraTermData() {
-                    return provideResourceInfo;
-                }
-
-
-                @Override
-                public void writeExtraTermData(XMLStreamWriter writer)
-                        throws XMLStreamException {
-                    if (provideResourceInfo) {
-                        writeLegacyResourceInfo(writer, result.get(idx));
-                    }
-                }
-            };
+            final List<ResourceInfo> result = translateFcsScanResource(request
+                    .getScanClause());
+            if (result != null) {
+                /*
+                 * Make sure, we honor the maximumTerms limit, of the client
+                 * requests it ...
+                 */
+                final int maxTerms = ((result.size() > 0) && (request
+                        .getMaximumTerms() > 0)) ? Math.min(result.size(),
+                        request.getMaximumTerms()) : result.size();
+
+                /*
+                 * Shall we provide extended resource information ... ?
+                 */
+                final boolean provideResourceInfo = parseBoolean(request
+                        .getExtraRequestData(X_CMD_RESOURCE_INFO));
+
+                return new SRUScanResultSet(diagnostics) {
+                    private int idx = -1;
+
+
+                    @Override
+                    public boolean nextTerm() {
+                        return (result != null) && (++idx < maxTerms);
+                    }
+
+
+                    @Override
+                    public String getValue() {
+                        return result.get(idx).getPid();
+                    }
+
+
+                    @Override
+                    public int getNumberOfRecords() {
+                        return -1;
+                    }
+
+
+                    @Override
+                    public String getDisplayTerm() {
+                        return result.get(idx).getTitle("en");
+                    }
+
+
+                    @Override
+                    public WhereInList getWhereInList() {
+                        return null;
+                    }
+
+
+                    @Override
+                    public boolean hasExtraTermData() {
+                        return provideResourceInfo;
+                    }
+
+
+                    @Override
+                    public void writeExtraTermData(XMLStreamWriter writer)
+                            throws XMLStreamException {
+                        if (provideResourceInfo) {
+                            writeLegacyResourceInfo(writer, result.get(idx));
+                        }
+                    }
+                };
+            } else {
+                return doScan(config, request, diagnostics);
+            }
         } else {
             return doScan(config, request, diagnostics);
@@ -543 +558 @@
     }
 
+
+    /**
+     * Check, if running in legacy mode. Only intended for comparability with
+     * legacy clients until the new CLARIN-FCS specification is deployed on a
+     * larger scale.
+     *
+     * @return <code>true</code> if running in legacy mode, <code>false</code>
+     *         otherwise
+     */
+    protected boolean isLegacyMode() {
+        return !disableLegecyMode;
+    }
+
 } // class SimpleEndpointSearchEngineBase

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/XMLStreamWriterHelper.java

@@ -16 +16 @@
  */
 public final class XMLStreamWriterHelper {
-    private static final String FCS_NS          = "http://clarin.eu/fcs/1.0";
-    private static final String FCS_PREFIX      = "fcs";
+    private static final String FCS_NS          =
+            "http://clarin.eu/fcs/resource";
+    private static final String FCS_PREFIX      =
+            "fcs";
     private static final String FCS_KWIC_NS     =
             "http://clarin.eu/fcs/1.0/kwic";
-    private static final String FCS_KWIC_PREFIX = "kwic";
+    private static final String FCS_KWIC_PREFIX =
+            "kwic";
     private static final String FCS_KWIC_MIMETYPE =
             "application/x-clarin-fcs-kwic+xml";
     private static final String FCS_HITS_NS =
             "http://clarin.eu/fcs/dataview/hits";
-    private static final String FCS_HITS_PREFIX = "hits";
+    private static final String FCS_HITS_PREFIX =
+            "hits";
     private static final String FCS_HITS_MIMETYPE =
             "application/x-clarin-fcs-hits+xml";
@@ -354 +358 @@
 
     /**
-     * Convince method for writing a record with a KWIC data view. The following
+     * Convince method for writing a record with a HITS data view. The following
      * code (arguments omitted) would accomplish the same result:
      *
@@ -528 +532 @@
     }
 
+
+    /**
+     * Convince method for writing a record with a HITS and a KWIC data view.
+     * This method is intended for applications that want ensure computability
+     * to legacy CLARIN-FCS clients The following code (arguments omitted) would
+     * accomplish the same result:
+     *
+     * <pre>
+     * ...
+     * writeStartResource(...);
+     * writeHitsDataView(...);
+     * writeKWICDataView(...);
+     * writeEndResource(...);
+     * ...
+     * </pre>
+     *
+     * @param writer
+     *            the {@link XMLStreamWriter} to be used
+     * @param pid
+     *            the persistent identifier of this resource or
+     *            <code>null</code>, if not applicable
+     * @param ref
+     *            the reference of this resource or <code>null</code>, if not
+     *            applicable
+     * @param left
+     *            the left context of the hit or <code>null</code> if not
+     *            applicable
+     * @param hit
+     *            the actual hit, that will be highlighted
+     * @param right
+     *            the right context of the hit or <code>null</code> if not
+     *            applicable
+     * @throws XMLStreamException
+     *             if an error occurred
+     * @deprecated Only use, if you want compatability to legacy FCS
+     *             applications.
+     */
+    @Deprecated
+    public static void writeResourceWithHitsDataViewLegacy(XMLStreamWriter writer,
+            String pid, String ref, String left, String hit, String right)
+            throws XMLStreamException {
+        if (writer == null) {
+            throw new NullPointerException("writer == null");
+        }
+
+        writeStartResource(writer, pid, ref);
+        writeHitsDataView(writer, left, hit, right);
+        writeKWICDataView(writer, left, hit, right);
+        writeEndResource(writer);
+    }
+
 } // class XMLStreamWriterHelper

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/utils/AbstractEndpointDescriptionBase.java

@@ -36 +36 @@
             throw new IllegalArgumentException("capabilities are empty");
         }
+        for (URI capability : capabilities) {
+            if (capability == null) {
+                throw new IllegalArgumentException(
+                        "capabilities must not contain a 'null' item");
+            }
+        }
         this.capabilities = Collections.unmodifiableList(capabilities);
 
@@ -43 +49 @@
         if (supportedDataViews.isEmpty()) {
             throw new IllegalArgumentException("supportedDataViews are empty");
+        }
+        for (DataView supportedDataView : supportedDataViews) {
+            if (supportedDataView == null) {
+                throw new IllegalArgumentException(
+                        "supportedDataViews must not contain a 'null' item");
+            }
         }
         this.supportedDataViews =