Javadoc

diff --git a/src/main/java/com/indexdata/mkjsf/controls/package-info.java b/src/main/java/com/indexdata/mkjsf/controls/package-info.java
new file mode 100644 (file)
index 0000000..2e59177
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/controls/package-info.java
@@ -0,0 +1,4 @@
+/**\r
+ * UI controls - a configurable pager component for browsing through search results a page at a time\r
+ */\r
+package com.indexdata.mkjsf.controls;
\ No newline at end of file

diff --git a/src/main/java/com/indexdata/mkjsf/errors/package-info.java b/src/main/java/com/indexdata/mkjsf/errors/package-info.java
new file mode 100644 (file)
index 0000000..205b5c0
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/errors/package-info.java
@@ -0,0 +1,4 @@
+/**\r
+ * Error reporting, error diagnostics, and exception classes\r
+ */\r
+package com.indexdata.mkjsf.errors;
\ No newline at end of file

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java
index d217761..39619ad 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java
@@ -3,8 +3,8 @@
  * ResponseParser found in this package, the output being response data\r
  * objects accessible to the UI. \r
  * \r
- * <p>The most recent responses from each command are accessible to the UI\r
- * through the class Responses which is exposed to the UI as <code>pzresp</code></p>\r
+ * <p>The most recent response from each command is accessible to the UI\r
+ * through the class Responses, which is exposed to the UI as <code>pzresp</code></p>\r
  * \r
  * <p>Examples:</p>\r
  * <ul>\r

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponseDataObject.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponseDataObject.java
index 2620723..7816776 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponseDataObject.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponseDataObject.java
@@ -2,10 +2,28 @@ package com.indexdata.mkjsf.pazpar2.data.sp;
 \r
 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;\r
 \r
+/**\r
+ * Base class for Service Proxy-only response data\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class SpResponseDataObject extends ResponseDataObject {\r
 \r
   private static final long serialVersionUID = -3098556883153269199L;  \r
 \r
+  /**\r
+   * <p>Returns true if the command was not recognized by the Service Proxy,\r
+   * passed on to Pazpar2, and then also not recognized by Pazpar2.</p> \r
+   * <p>This results in an error no 3 from Pazpar2 which is passed back through \r
+   * the Service Proxy.</p> \r
+   * <p>This would normally be caused by issuing a Service Proxy-only command that \r
+   * the given Service Proxy is not configured for, or which the given \r
+   * Service Proxy has mapped to a different command name - in both cases it will \r
+   * just fall through.</p> \r
+   *  \r
+   * @return\r
+   */\r
   public boolean unsupportedCommand() {\r
     if (hasServiceError() \r
         && getServiceError().getCode().equals("3")\r

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponses.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponses.java
index b5bb18c..0986e86 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponses.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/SpResponses.java
@@ -4,6 +4,12 @@ import java.io.Serializable;
 \r
 import com.indexdata.mkjsf.pazpar2.data.Responses;\r
 \r
+/**\r
+ * Provides references to all current Service Proxy-only data objects.\r
+ *  \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class SpResponses implements Serializable {\r
   \r
   private static final long serialVersionUID = -3831357590639961167L;\r
@@ -52,6 +58,7 @@ public class SpResponses implements Serializable {
     responses.put("auth", new AuthResponse());\r
     resetInitAndBeyond(includePazpar2Responses);    \r
   }\r
+\r
   \r
   public AuthResponse getAuth () {\r
     return ((AuthResponse) responses.getResponseObject("auth"));\r

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java
new file mode 100644 (file)
index 0000000..d5994a7
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java
@@ -0,0 +1,14 @@
+/**\r
+ * Service Proxy responses produced by Service Proxy commands.\r
+ * \r
+ * <p>The most recent respons from each command is accessible to the UI\r
+ * through the class SpResponses, which is exposed to the UI as <code>pzresp.sp</code></p>\r
+ * \r
+ * <p>Examples:</p>\r
+ * <ul>\r
+ *  <li><code>pzresp.sp.auth.status<code> returns the status of the most recent authentication request</li>\r
+ *  <li><code>pzresp.sp.categories.tagetCategories</code> returns target categories for filtering by category</li>\r
+ * </ul>  \r
+ * \r
+ */\r
+package com.indexdata.mkjsf.pazpar2.data.sp;
\ No newline at end of file

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/state/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/state/package-info.java
new file mode 100644 (file)
index 0000000..d118af8
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/state/package-info.java
@@ -0,0 +1,6 @@
+/**\r
+ * Tracks the state of commands, parameter settings and \r
+ * command execution - primarily used for handling browser\r
+ * history navigation. \r
+ */\r
+package com.indexdata.mkjsf.pazpar2.state;
\ No newline at end of file

diff --git a/src/main/java/com/indexdata/mkjsf/utils/FileUpload.java b/src/main/java/com/indexdata/mkjsf/utils/FileUpload.java
index ac21771..ff8f0f1 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/utils/FileUpload.java
+++ b/src/main/java/com/indexdata/mkjsf/utils/FileUpload.java
@@ -10,6 +10,12 @@ import org.apache.commons.io.FilenameUtils;
 import org.apache.log4j.Logger;\r
 import org.apache.myfaces.custom.fileupload.UploadedFile;\r
 \r
+/**\r
+ * Helper class for file uploads.\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public abstract class FileUpload implements Serializable {\r
 \r
   private static Logger logger = Logger.getLogger(FileUpload.class);\r

diff --git a/src/main/java/com/indexdata/mkjsf/utils/UiUtils.java b/src/main/java/com/indexdata/mkjsf/utils/UiUtils.java
index c5cd943..93a3502 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/utils/UiUtils.java
+++ b/src/main/java/com/indexdata/mkjsf/utils/UiUtils.java
@@ -8,6 +8,12 @@ import javax.inject.Named;
 \r
 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;\r
 \r
+/**\r
+ * UI utilities \r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 @Named("pzui")\r
 @ApplicationScoped\r
 public class UiUtils {\r

diff --git a/src/main/java/com/indexdata/mkjsf/utils/Utils.java b/src/main/java/com/indexdata/mkjsf/utils/Utils.java
index 5b8a696..4e00387 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/utils/Utils.java
+++ b/src/main/java/com/indexdata/mkjsf/utils/Utils.java
@@ -1,8 +1,11 @@
 package com.indexdata.mkjsf.utils;\r
 \r
-import javax.enterprise.context.ApplicationScoped;\r
-import javax.inject.Named;\r
-\r
+/**\r
+ * A few utilities, mostly for logging\r
+ *  \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class Utils {\r
   \r
   public static String nl = System.getProperty("line.separator");  \r

diff --git a/src/main/java/com/indexdata/mkjsf/utils/package-info.java b/src/main/java/com/indexdata/mkjsf/utils/package-info.java
new file mode 100644 (file)
index 0000000..8b5bee3
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/utils/package-info.java
@@ -0,0 +1,4 @@
+/**\r
+ * Utility classes for file upload, string and list manipulation in UI, logging  \r
+ */\r
+package com.indexdata.mkjsf.utils;
\ No newline at end of file