Changeset 1911 for OAIProvider/trunk/src/main/java/eu/clarin/oai/provider/RecordList.java

Timestamp:

04/26/12 13:25:34 (12 years ago)

Author:

oschonef

Message:

• first round of major refactoring to simply the provider
  • result sets converted to iterator/cursor-mode (better streaming support)
  • delegate serializing of records to Result and ResultList?
  • prepare getting rid of over-engineered and complicated MetadataFormats? classes (not done, yet)

HEADS UP: breaks existing API

File:

• OAIProvider/trunk/src/main/java/eu/clarin/oai/provider/RecordList.java (modified) (2 diffs)

OAIProvider/trunk/src/main/java/eu/clarin/oai/provider/RecordList.java

@@ -1 +1 @@
 package eu.clarin.oai.provider;
 
+import java.util.Date;
+import java.util.List;
+
+import javax.xml.stream.XMLStreamException;
+import javax.xml.stream.XMLStreamWriter;
 
 /**
@@ -6 +11 @@
  * <em>ListRecords</em> and <em>ListIdentifiers</em> verb. This can also be a
  * partial list if the repository wants do flow-control.
+ * 
+ * A <code>RecordList</code> object maintains a cursor pointing to its
+ * current record. Initially the cursor is positioned before the first row.
+ * The next method moves the cursor to the next row, and because it returns
+ * <code>false</code> when there are no more records in the
+ * <code>RecordList</code> object, it can be used in a while loop to iterate through the
+ * result set.
  */
 public interface RecordList {
 
     /**
-     * Release resources as this record list instance is about to be discared.
-     */
-    public void close();
-
-    /**
-     * Returns <code>true</code> if the list has more records. (In other
-     * words, returns <code>true</code> if <code>nextRecord</code> would
-     * return an element rather than throwing an exception.)
-     *  
-     *  @return <code>true</code> if the list has more records
-     */
-    public boolean hasNextRecord();
-
-    /**
-     * Gets the next record in the list. RecordList implementations must set
-     * the appropriate values to the passed Record instance.
-     * 
-     * @param record
-     *            a Record instance to gather the record data
-     * @see Record
-     * @throws NoSuchElementException - iteration has no more results.
-     */
-    public void nextRecord(Record record);
-
-    /**
-     * Return <code>true</code>, if no more partial result lists are
-     * available for this request. In other words, this method should return
-     * <code>true</code> either  if this list contains all appropriate records
-     * for the request or if this result list is the last partial list for the
-     * request. This is needed for flow-control.
-     * 
-     * @return <code>true</code> if no more results are available in
-     *         subsequent requests, <code>false</code> otherwise
-     */
-    public boolean isListComplete();
-
-    /**
      * Get the size of the complete result list.
      * 
-     * @return the size of the complete result list or <code>-1</code>, if
-     *         the repository cannot calculate the total size.
+     * @return the size of the complete result list or <code>-1</code>, if the
+     *         repository cannot calculate the total size.
      * @see #getSize()
      */
     public int getTotalSize();
 
+
+    /**
+     * Return <code>true</code>, if no more partial result lists are available
+     * for this request. In other words, this method should return
+     * <code>true</code> either if this list contains all appropriate records
+     * for the request or if this result list is the last partial list for the
+     * request. This is needed for flow-control.
+     * 
+     * @return <code>true</code> if no more results are available in subsequent
+     *         requests, <code>false</code> otherwise
+     */
+    public boolean isListComplete();
+
+
+    /**
+     * Release resources as this record list instance is about to be discarded.
+     */
+    public void close();
+
+    
+    /**
+     * Returns <code>true</code> if the list has more records. (In other words,
+     * returns <code>true</code> if <code>nextRecord</code> would return an
+     * element rather than throwing an exception.)
+     * 
+     * @return <code>true</code> if the list has more records
+     */
+    public boolean next();
+
+    
+    /**
+     * Get the localId of the record. The returned object must be compatible
+     * with repository's implementation of <code>parseLocalId</code> and
+     * <code>unparseLocalId</code>.
+     *
+     * @returns the local Id object of the record
+     */
+    public Object getLocalId();
+
+    /**
+     * Get the last changed timestamp of the item.
+     *
+     * @return the last changed timestamp of the item
+     */
+    public Date getDatestamp();
+
+    /**
+     * set deletion state of the record.
+     *
+     * @return <code>true</code> of the record is deleted, <code>false</code>
+     *         otherwise
+     * @see Repository#getDeletedNotion()            
+     */
+    public boolean isDeleted();
+
+    /**
+     * Get the sets to which this record belongs to.
+     *
+     * @return the list of sets to which the records belongs to or
+     *         <code>null</code> if it does not belong to any sets or the
+     *         repository does not support set
+     */
+    public List<String> getSetSpecs();
+
+    
+    public void writeRecord(XMLStreamWriter writer) throws XMLStreamException;
+    
+    // /**
+    // * Gets the next record in the list. RecordList implementations must set
+    // * the appropriate values to the passed Record instance.
+    // *
+    // * @param record
+    // * a Record instance to gather the record data
+    // * @see Record
+    // * @throws NoSuchElementException - iteration has no more results.
+    // */
+    // public void nextRecord(Record record);
+    //
+    // /**
+    // * Return <code>true</code>, if no more partial result lists are
+    // * available for this request. In other words, this method should return
+    // * <code>true</code> either if this list contains all appropriate records
+    // * for the request or if this result list is the last partial list for the
+    // * request. This is needed for flow-control.
+    // *
+    // * @return <code>true</code> if no more results are available in
+    // * subsequent requests, <code>false</code> otherwise
+    // */
+    // public boolean isListComplete();
+    //
+
 } // class RecordList