Changeset 1177

Timestamp:

10/26/11 23:07:55 (20 months ago)

Author:

philsmart

Message:

 

Location:

raptor-ica/trunk/src/main/java/uk/ac/cardiff/raptorica

Files:

• model/EntryMetadata.java (modified) (2 diffs)
• server/RunServer.java (modified) (1 diff)
• service/IcaProcess.java (modified) (1 diff)

raptor-ica/trunk/src/main/java/uk/ac/cardiff/raptorica/model/EntryMetadata.java

@@ -17 +17 @@
  *
  */
+
 package uk.ac.cardiff.raptorica.model;
 
@@ -24 +25 @@
 import org.joda.time.DateTime;
 
-
 /**
  * @author philsmart
- *
+ * 
  */
-public class EntryMetadata{
+public class EntryMetadata {
 
-    /* used if a persistant db primary key is required, only one entrymetadata
-     * so only id of one needed*/
+    /**
+     * used if a persistant db primary key is required, only one entrymetadata so only id of one needed
+     */
     private Long persistantId;
 
-    /* pointer to the last recorded entry, for incremental update */
+    /** pointer to the last recorded entry, for incremental update */
     private DateTime latestEntryTime;
 
-    /* record of the last entry that was sent over SOAP */
+    /** record of the last entry that was sent over SOAP */
     private DateTime lastPublishedEntryTime;
 
-    /* stores the list of latest unique entries as their hash code (for easy persisting). That is, those with the latest and same
-     *  DateTime, but different hashcode (attribute values). */
+    /**
+     * stores the list of latest unique entries as their hash code (for easy persisting). That is, those with the latest
+     * and same DateTime, but different hashcode (attribute values).
+     */
     private List<Integer> latestEqualEntries;
 
-    public EntryMetadata(){
-        latestEqualEntries = new ArrayList<Integer>();
+    public EntryMetadata() {
+        latestEqualEntries = new ArrayList<Integer>();
     }
 
     public void setLatestEntryTime(DateTime latestEntryTime) {
-        this.latestEntryTime = latestEntryTime;
+        this.latestEntryTime = latestEntryTime;
     }
 
     public DateTime getLatestEntryTime() {
-        return latestEntryTime;
+        return latestEntryTime;
     }
 
     public void setLastPublishedEntryTime(DateTime lastPublishedEntryTime) {
-        this.lastPublishedEntryTime = lastPublishedEntryTime;
+        this.lastPublishedEntryTime = lastPublishedEntryTime;
     }
 
     public DateTime getLastPublishedEntryTime() {
-        return lastPublishedEntryTime;
+        return lastPublishedEntryTime;
     }
 
     public void setPersistantId(Long persistantId) {
-        this.persistantId = persistantId;
+        this.persistantId = persistantId;
     }
 
     public Long getPersistantId() {
-        return persistantId;
+        return persistantId;
     }
 
-    public String toString(){
-        return "["+persistantId+":"+latestEntryTime+","+lastPublishedEntryTime+"]";
+    public String toString() {
+        return "[" + persistantId + ":" + latestEntryTime + "," + lastPublishedEntryTime + "]";
     }
 
     public void setLatestEqualEntries(List<Integer> latestEqualEntries) {
-        this.latestEqualEntries = latestEqualEntries;
+        this.latestEqualEntries = latestEqualEntries;
     }
 
     public List<Integer> getLatestEqualEntries() {
-        return latestEqualEntries;
+        return latestEqualEntries;
     }
 

raptor-ica/trunk/src/main/java/uk/ac/cardiff/raptorica/server/RunServer.java

@@ -46 +46 @@
      * </ol>
      * 
-     * @param args
+     * @param args the program arguments
      * @throws IOException
      * @throws FileNotFoundException

raptor-ica/trunk/src/main/java/uk/ac/cardiff/raptorica/service/IcaProcess.java

@@ -14 +14 @@
  * limitations under the License.
  */
+
 package uk.ac.cardiff.raptorica.service;
 
+public interface IcaProcess {
 
-public interface IcaProcess{
+    /**
+     * Instructs this ICA to capture events from all registered data sources.
+     */
+    public void capture();
 
-        public void capture();
-        
-        public void release();
+    /**
+     * Instructs this ICA to release events using the configured client.
+     */
+    public void release();
 
-        public void garbageCollect();
+    /**
+     * Instructs this ICA to remove any events that have already been processed and sent through the configured client.
+     */
+    public void garbageCollect();
 
 }