Renames class, removes obsolete, javadoc

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / data / ResponseDataObject.java

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/ResponseDataObject.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/ResponseDataObject.java
index 535f859..5e2d639 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/data/ResponseDataObject.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/ResponseDataObject.java
@@ -9,6 +9,12 @@ import org.apache.log4j.Logger;
 \r
 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;\r
 \r
+/**\r
+ * Parent class of all response data objects, with generic methods for retrieving data elements\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class ResponseDataObject implements Serializable {\r
 \r
   Logger logger = Logger.getLogger(ResponseDataObject.class);\r
@@ -38,6 +44,12 @@ public class ResponseDataObject implements Serializable {
     return attributes.get(name);\r
   }\r
     \r
+  /**\r
+   * Used by the response XML parser to add child element objects to a parent element object\r
+   * \r
+   * @param name of the child element\r
+   * @param value the child object itself\r
+   */\r
   public void addElement (String name, ResponseDataObject value) {    \r
     if (elements.containsKey(name)) {\r
       elements.get(name).add(value);\r
@@ -74,6 +86,12 @@ public class ResponseDataObject implements Serializable {
     }\r
   }\r
   \r
+  /**\r
+   * Returns string array with the values of the named element(s)\r
+   *   \r
+   * @param name of the child object(s) to retrieve value(s) from\r
+   * @return\r
+   */\r
   public String[] getValueArray (String name) {\r
     List<ResponseDataObject> elements = getElements(name);\r
     String[] valueArray = {};\r