Changeset 5804 for SRUClient

Timestamp:

11/12/14 14:33:09 (10 years ago)

Author:

Oliver Schonefeld

Message:

• some javadoc and other miscellaneous stuff

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) (2 diffs)
• main/java/eu/clarin/sru/client/SRUGenericExtraResponseData.java (modified) (1 diff)
• main/java/eu/clarin/sru/client/fcs/ClarinFCSClientBuilder.java (modified) (2 diffs)
• main/java/eu/clarin/sru/client/fcs/ClarinFCSEndpointDescription.java (modified) (9 diffs)
• main/java/eu/clarin/sru/client/fcs/ClarinFCSEndpointDescriptionParser.java (modified) (6 diffs)
• test/java/eu/clarin/sru/client/TestClient.java (modified) (1 diff)
• test/java/eu/clarin/sru/client/TestThreadedClient.java (modified) (2 diffs)
• test/java/eu/clarin/sru/client/TestThreadedClientCallback.java (modified) (2 diffs)

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

@@ -392 +392 @@
     /**
      * <em>Note: this method is not a part of public API.</em>
-     * @return a constant for this
+     * @return a operation constant for this request
      */
     abstract SRUOperation getOperation();
@@ -400 +400 @@
             throws SRUClientException;
 
-} // class AbstractSRURequest
+} // class SRUAbstractRequest

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

@@ -434 +434 @@
                  */
                 throw new SRUClientException(
-                        "internal error; 'records' are null or empty");
+                        "internal error; 'records' is null or empty");
             }
         }
@@ -451 +451 @@
             SRUClient.this.timeParsing = millisProcessing;
         }
-
     } // inner class Handler
 

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

@@ -32 +32 @@
 
 
+    /**
+     * Constructor.
+     * 
+     * @param name
+     *            the root element of this extra response data fragment
+     * @param fragment
+     *            the extra response data fragment as {@link DocumentFragment}
+     */
     SRUGenericExtraResponseData(QName name, DocumentFragment fragment) {
         if (name == null) {

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

@@ -235 +235 @@
 
     /**
-     * Register a Data View parser.
+     * Register an extra response data parser.
      *
      * @param parser
@@ -241 +241 @@
      * @return this {@link ClarinFCSClientBuilder} instance
      * @throws IllegalArgumentException
-     *             if an error occurred while registering the data view parser
+     *             if an error occurred while registering the extra response
+     *             data parser
      * @see SRUExtraResponseDataParser
      */
-    public ClarinFCSClientBuilder registerExtraResponseDatar(SRUExtraResponseDataParser parser) {
+    public ClarinFCSClientBuilder registerExtraResponseDataParser(
+            SRUExtraResponseDataParser parser) {
         if (parser == null) {
             throw new NullPointerException("parser == null");

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

@@ -52 +52 @@
 
 
+    /**
+     * Get the version of this endpoint description.
+     *
+     * @return the version of the endpoint description
+     */
     public int getVersion() {
         return version;
@@ -57 +62 @@
 
 
+    /**
+     * Get the list of capabilities supported by this endpoint. The list
+     * contains the appropriate URIs defined by the CLARIN-FCS specification to
+     * indicate support for certain capabilities.
+     *
+     * @return the list of capabilities supported by this endpoint
+     */
     public List<URI> getCapabilities() {
         return capabilites;
@@ -62 +74 @@
 
 
+    /**
+     * Get the list of data views supported by this endpoint.
+     *
+     * @return the list of data views supported by this endpoint
+     */
     public List<DataView> getSupportedDataViews() {
         return supportedDataViews;
@@ -67 +84 @@
 
 
+    /**
+     * Get the list of top-level resources of this endpoint.
+     *
+     * @return the list of top-level resources of this endpoint
+     */
     public List<ResourceInfo> getResources() {
         return resources;
@@ -72 +94 @@
 
 
-    public static class DataView implements Serializable {
+    /**
+     * This class implements a description of a data view supported by the endpoint.
+     */
+    public static final class DataView implements Serializable {
         private static final long serialVersionUID = -5628565233032672627L;
 
@@ -94 +119 @@
 
 
+        /**
+         * Constructor. <em>Internal use only!</em>
+         */
         DataView(String identifier, String mimeType,
                 DeliveryPolicy deliveryPolicy) {
@@ -164 +192 @@
 
 
-    public static class ResourceInfo implements Serializable {
+    /**
+     * This class implements a description of a resource available at an
+     * endpoint.
+     */
+    public static final class ResourceInfo implements Serializable {
         private static final long serialVersionUID = 1046130188435071544L;
         private final String pid;
@@ -175 +207 @@
 
 
+        /**
+         * Constructor. <em>Internal use only!</em>
+         */
         ResourceInfo(String pid, Map<String, String> title,
                 Map<String, String> description, String landingPageURI,
@@ -311 +346 @@
 
         /**
+         * Check, if this resource supports a certain language.
+         *
+         * @param language
+         *            a language encoded as a ISO-632-3 three letter language
+         *            code
+         * @return <code>true</code> if the language is supported by this
+         *         resource, <code>false</code> otherwise
+         */
+        public boolean supportsLanguage(String language) {
+            if (language == null) {
+                throw new NullPointerException("language == null");
+            }
+            for (String l : languages) {
+                if (language.equals(l)) {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+
+        /**
          * Get the direct sub-ordinate resources of this resource.
          *
-         * @return a list of resources or <code>null</code> if this resource has no
-         *         sub-ordinate resources
+         * @return a list of resources or <code>null</code> if this resource has
+         *         no sub-ordinate resources
          */
         public List<ResourceInfo> getSubResources() {

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

@@ -46 +46 @@
 public class ClarinFCSEndpointDescriptionParser implements
         SRUExtraResponseDataParser {
+    /**
+     * constant for infinite resource enumeration parsing depth
+     */
     public static final int INFINITE_MAX_DEPTH = -1;
+    /**
+     * constant for default parsing resource enumeration parsing depth
+     */
     public static final int DEFAULT_MAX_DEPTH  = INFINITE_MAX_DEPTH;
     private static final Logger logger =
@@ -64 +70 @@
 
 
+    /**
+     * Constructor. By default, the parser will parse the endpoint resource
+     * enumeration to an infinite depth.
+     */
     public ClarinFCSEndpointDescriptionParser() {
         this(DEFAULT_MAX_DEPTH);
@@ -69 +79 @@
 
 
+    /**
+     * Constructor.
+     *
+     * @param maxDepth
+     *            maximum depth for parsing the endpoint resource enumeration.
+     * @throws IllegalArgumentException
+     *             if an argument is illegal
+     */
     public ClarinFCSEndpointDescriptionParser(int maxDepth) {
         if (maxDepth < -1) {
@@ -187 +205 @@
         // Resources
         final List<ResourceInfo> resources =
-                parseResources(reader, 0, supportedDataViews);
+                parseResources(reader, 0, maxDepth, supportedDataViews);
 
         // skip over extensions
@@ -208 +226 @@
 
 
-    private List<ResourceInfo> parseResources(XMLStreamReader reader, int depth,
-            List<DataView> supportedDataviews) throws XMLStreamException {
+    /**
+     * Get the maximum resource enumeration parsing depth. The first level is
+     * indicate by the value <code>0</code>.
+     *
+     * @return the default resource parsing depth or <code>-1</code> for
+     *         infinite.
+     */
+    public int getMaximumResourcePArsingDepth() {
+        return maxDepth;
+    }
+
+
+    private static List<ResourceInfo> parseResources(XMLStreamReader reader,
+            int depth, int maxDepth, List<DataView> supportedDataviews)
+            throws XMLStreamException {
         List<ResourceInfo> resources = null;
 
@@ -285 +316 @@
 
             List<ResourceInfo> subResources = null;
-            if (XmlStreamReaderUtils.peekStart(reader, ED_NS_URI, "Resources")) {
+            if (XmlStreamReaderUtils.peekStart(reader,
+                    ED_NS_URI, "Resources")) {
                 final int nextDepth = depth + 1;
-                if ((maxDepth == INFINITE_MAX_DEPTH) || (nextDepth < maxDepth)) {
+                if ((maxDepth == INFINITE_MAX_DEPTH) ||
+                        (nextDepth < maxDepth)) {
                     subResources = parseResources(reader, nextDepth,
-                            supportedDataviews);
+                            maxDepth, supportedDataviews);
                 } else {
                     XmlStreamReaderUtils.skipTag(reader, ED_NS_URI,

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

@@ -37 +37 @@
                     .unknownDataViewAsString()
                     .enableLegacySupport()
-                    .registerExtraResponseDatar(
+                    .registerExtraResponseDataParser(
                             new ClarinFCSEndpointDescriptionParser())
                     .buildClient();

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

@@ -24 +24 @@
 
 import eu.clarin.sru.client.fcs.ClarinFCSClientBuilder;
+import eu.clarin.sru.client.fcs.ClarinFCSEndpointDescriptionParser;
 
 @Deprecated
@@ -36 +37 @@
             SRUThreadedClient client = new ClarinFCSClientBuilder()
                     .addDefaultDataViewParsers()
+                    .unknownDataViewAsString()
+                    .enableLegacySupport()
+                    .registerExtraResponseDataParser(
+                            new ClarinFCSEndpointDescriptionParser())
                     .buildThreadedClient();
 

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

@@ -23 +23 @@
 
 import eu.clarin.sru.client.fcs.ClarinFCSClientBuilder;
+import eu.clarin.sru.client.fcs.ClarinFCSEndpointDescriptionParser;
 
 
@@ -35 +36 @@
             SRUThreadedClient client = new ClarinFCSClientBuilder()
                     .addDefaultDataViewParsers()
+                    .unknownDataViewAsString()
+                    .enableLegacySupport()
+                    .registerExtraResponseDataParser(
+                            new ClarinFCSEndpointDescriptionParser())
                     .buildThreadedClient();