Changeset 2663 for trunk/java-client

Timestamp:

2001-07-22T23:06:57+12:00 (23 years ago)

Author:

bas6

Message:

Added method getNumOfDocIdsRetrieved() to NzdlResultSet. Added a couple of comments to NzdlDocumentInfo

Location:

trunk/java-client/org/nzdl/gsdl/service

Files:

• NzdlDocumentInfo.java (modified) (1 diff)
• NzdlResultSet.java (modified) (1 diff)

trunk/java-client/org/nzdl/gsdl/service/NzdlDocumentInfo.java

@@ -104 +104 @@
     }
   }
-  
+
+/**
+ * Returns all metadata keys for each metadata value in the document.
+ * Each item returned corresponds to a value in the 'values' Vector.
+ *  The keys may include such Strings as title, author, creator etc.
+ * Where there is more than one instance of a metadata value (for
+ * example, if there are two authors) then two author keys will be
+ * produced each corresponding to an author name in the values Vector.
+ * @return an enumerated set of key strings
+ */
   public Enumeration getKeys() {return keys.elements();};
+
+
+ /**
+ * Returns all metadata values in the document.
+ * Each item returned corresponds to a key in the 'keys' Vector.
+ *  The keys may include such Strings as title, author, creator etc.
+ * @return an enumerated set of value strings
+ */
   public Enumeration getValues() {return values.elements();};
 }

trunk/java-client/org/nzdl/gsdl/service/NzdlResultSet.java

@@ -287 +287 @@
   }
 
+    /**
+   * Returns the number of document ID's retrieved <br>
+   * Pre: A {@link NzdlResponse NzdlResponse} object has been created. A
+   * {@link NzdlService NzdlService} object has filled the NzdlResponse
+   * object with results from servicing a {@link NzdlRequest NzdlRequest}.<br>
+   * @return The number of documents IDs that have been retrieved from the
+   * collection
+   */
+  public long getNumOfDocIdsRetrieved() {
+    return m_docIDs.size();
+  }
+
 }