From 939fcdf71c4897d6bf78c16bd8d290495daa14b5 Mon Sep 17 00:00:00 2001
From: "Niels Erik G. Nielsen" <nielserik@indexdata.com>
Date: Thu, 6 Jun 2013 17:55:53 -0400
Subject: [PATCH] Javadoc

---
 .../com/indexdata/mkjsf/controls/package-info.java   |    4 ++++
 .../com/indexdata/mkjsf/errors/package-info.java     |    4 ++++
 .../indexdata/mkjsf/pazpar2/data/package-info.java   |    4 ++--
 .../mkjsf/pazpar2/data/sp/SpResponseDataObject.java  |   18 ++++++++++++++++++
 .../indexdata/mkjsf/pazpar2/data/sp/SpResponses.java |    7 +++++++
 .../mkjsf/pazpar2/data/sp/package-info.java          |   14 ++++++++++++++
 .../indexdata/mkjsf/pazpar2/state/package-info.java  |    6 ++++++
 .../java/com/indexdata/mkjsf/utils/FileUpload.java   |    6 ++++++
 src/main/java/com/indexdata/mkjsf/utils/UiUtils.java |    6 ++++++
 src/main/java/com/indexdata/mkjsf/utils/Utils.java   |    9 ++++++---
 .../java/com/indexdata/mkjsf/utils/package-info.java |    4 ++++
 11 files changed, 77 insertions(+), 5 deletions(-)
 create mode 100644 src/main/java/com/indexdata/mkjsf/controls/package-info.java
 create mode 100644 src/main/java/com/indexdata/mkjsf/errors/package-info.java
 create mode 100644 src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java
 create mode 100644 src/main/java/com/indexdata/mkjsf/pazpar2/state/package-info.java
 create mode 100644 src/main/java/com/indexdata/mkjsf/utils/package-info.java

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
index 0000000..2e59177
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/controls/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * UI controls - a configurable pager component for browsing through search results a page at a time
+ */
+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
index 0000000..205b5c0
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/errors/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Error reporting, error diagnostics, and exception classes
+ */
+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
--- 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
  * objects accessible to the UI. 
  * 
- * <p>The most recent responses from each command are accessible to the UI
- * through the class Responses which is exposed to the UI as <code>pzresp</code></p>
+ * <p>The most recent response from each command is accessible to the UI
+ * through the class Responses, which is exposed to the UI as <code>pzresp</code></p>
  * 
  * <p>Examples:</p>
  * <ul>
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
--- 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;
 
 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;
 
+/**
+ * Base class for Service Proxy-only response data
+ * 
+ * @author Niels Erik
+ *
+ */
 public class SpResponseDataObject extends ResponseDataObject {
 
   private static final long serialVersionUID = -3098556883153269199L;  
 
+  /**
+   * <p>Returns true if the command was not recognized by the Service Proxy,
+   * passed on to Pazpar2, and then also not recognized by Pazpar2.</p> 
+   * <p>This results in an error no 3 from Pazpar2 which is passed back through 
+   * the Service Proxy.</p> 
+   * <p>This would normally be caused by issuing a Service Proxy-only command that 
+   * the given Service Proxy is not configured for, or which the given 
+   * Service Proxy has mapped to a different command name - in both cases it will 
+   * just fall through.</p> 
+   *  
+   * @return
+   */
   public boolean unsupportedCommand() {
     if (hasServiceError() 
         && getServiceError().getCode().equals("3")
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
--- 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;
 
 import com.indexdata.mkjsf.pazpar2.data.Responses;
 
+/**
+ * Provides references to all current Service Proxy-only data objects.
+ *  
+ * @author Niels Erik
+ *
+ */
 public class SpResponses implements Serializable {
   
   private static final long serialVersionUID = -3831357590639961167L;
@@ -52,6 +58,7 @@ public class SpResponses implements Serializable {
     responses.put("auth", new AuthResponse());
     resetInitAndBeyond(includePazpar2Responses);    
   }
+
   
   public AuthResponse getAuth () {
     return ((AuthResponse) responses.getResponseObject("auth"));
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
index 0000000..d5994a7
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java
@@ -0,0 +1,14 @@
+/**
+ * Service Proxy responses produced by Service Proxy commands.
+ * 
+ * <p>The most recent respons from each command is accessible to the UI
+ * through the class SpResponses, which is exposed to the UI as <code>pzresp.sp</code></p>
+ * 
+ * <p>Examples:</p>
+ * <ul>
+ *  <li><code>pzresp.sp.auth.status<code> returns the status of the most recent authentication request</li>
+ *  <li><code>pzresp.sp.categories.tagetCategories</code> returns target categories for filtering by category</li>
+ * </ul>  
+ * 
+ */
+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
index 0000000..d118af8
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/state/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Tracks the state of commands, parameter settings and 
+ * command execution - primarily used for handling browser
+ * history navigation. 
+ */
+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
--- 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;
 import org.apache.myfaces.custom.fileupload.UploadedFile;
 
+/**
+ * Helper class for file uploads.
+ * 
+ * @author Niels Erik
+ *
+ */
 public abstract class FileUpload implements Serializable {
 
   private static Logger logger = Logger.getLogger(FileUpload.class);
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
--- 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;
 
 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;
 
+/**
+ * UI utilities 
+ * 
+ * @author Niels Erik
+ *
+ */
 @Named("pzui")
 @ApplicationScoped
 public class UiUtils {
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
--- 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;
 
-import javax.enterprise.context.ApplicationScoped;
-import javax.inject.Named;
-
+/**
+ * A few utilities, mostly for logging
+ *  
+ * @author Niels Erik
+ *
+ */
 public class Utils {
   
   public static String nl = System.getProperty("line.separator");  
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
index 0000000..8b5bee3
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/utils/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Utility classes for file upload, string and list manipulation in UI, logging  
+ */
+package com.indexdata.mkjsf.utils;
\ No newline at end of file
-- 
1.7.10.4