Added priority mechanism.
[utils] / trunk / crawler / kiss / src / org / wamblee / crawler / kiss / main / ProgramActionExecutor.java
index d47868f5ad040871340a905f7a58ccd5beff2521..4b2476d06dd2653deb38dca28f36e9d64aba2b2e 100644 (file)
 package org.wamblee.crawler.kiss.main;
 
 import java.util.EnumMap;
+import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
 import java.util.TreeMap;
 import java.util.TreeSet;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.dom4j.DocumentFactory;
 import org.dom4j.Element;
 import org.wamblee.crawler.kiss.guide.Program;
+import org.wamblee.crawler.kiss.guide.TimeInterval;
 import org.wamblee.crawler.kiss.guide.Program.RecordingResult;
 
 /**
  * Provides execution of actions for programs. Actions use this class to tell
- * the executor what to do. The executor then decide on exactly what to do and
+ * the executor what to do. The executor then decides on exactly what to do and
  * in what order and makes decisions in case of conflicts.
  */
 public class ProgramActionExecutor {
 
+    private static final Log LOG = LogFactory
+            .getLog(ProgramActionExecutor.class);
+
     /**
      * A map of category name to a set of program. Useful for displaying the
      * output of possibly interesting programs on a per category basis.
@@ -41,9 +48,9 @@ public class ProgramActionExecutor {
     private Map<String, Set<Program>> _interestingShows;
 
     /**
-     * Set of programs to record.
+     * Map of priority to set of programs.
      */
-    private Set<Program> _showsToRecord;
+    private Map<Integer, Set<Program>> _showsToRecord;
 
     /**
      * Map or recording result to a set of programs.
@@ -56,7 +63,7 @@ public class ProgramActionExecutor {
      */
     public ProgramActionExecutor() {
         _interestingShows = new TreeMap<String, Set<Program>>();
-        _showsToRecord = new TreeSet<Program>(new Program.TimeSorter());
+        _showsToRecord = new TreeMap<Integer, Set<Program>>();
         _recordings = new EnumMap<RecordingResult, Set<Program>>(
                 RecordingResult.class);
         for (RecordingResult result : RecordingResult.values()) {
@@ -74,7 +81,15 @@ public class ProgramActionExecutor {
      *            Program to record.
      */
     public void recordProgram(int aPriority, Program aProgram) {
-        _showsToRecord.add(aProgram);
+        LOG.info("priority = " + aPriority + ", program: " + aProgram);
+        // Putting -priority into the set makes sure that iteration order 
+        // over the priorities will go from higher priority to lower priority. 
+        Set<Program> programs = _showsToRecord.get(-aPriority);
+        if (programs == null) {
+            programs = new TreeSet<Program>(new Program.TimeSorter());
+            _showsToRecord.put(-aPriority, programs); 
+        }
+        programs.add(aProgram);
     }
 
     /**
@@ -86,6 +101,7 @@ public class ProgramActionExecutor {
      *            Program.
      */
     public void interestingProgram(String aCategory, Program aProgram) {
+        LOG.info("category = '" + aCategory + "', program: " + aProgram);
         Set<Program> programs = _interestingShows.get(aCategory);
         if (programs == null) {
             programs = new TreeSet<Program>(new Program.TimeSorter());
@@ -99,10 +115,34 @@ public class ProgramActionExecutor {
      * 
      */
     public void commit() {
-        for (Program program : _showsToRecord) {
-            RecordingResult result = program.record();
-            _recordings.get(result).add(program);
+        Set<TimeInterval> previouslyRecorded = new HashSet<TimeInterval>();
+        for (Integer priority : _showsToRecord.keySet()) {
+            for (Program program : _showsToRecord.get(priority)) {
+                TimeInterval interval = program.getInterval(); 
+                if ( recordingConflictExists(previouslyRecorded, interval)) { 
+                    _recordings.get(RecordingResult.CONFLICT).add(program);
+                } else {
+                    RecordingResult result = program.record();
+                    _recordings.get(result).add(program);
+                    previouslyRecorded.add(interval);
+                }
+            }
+        }
+    }
+    
+    /**
+     * Checks an interval for overlap with a previously recorded program. 
+     * @param aPreviouslyRecorded Previously recorded programs. 
+     * @param interval Interval. 
+     * @return True iff there is a recording conflict.
+     */
+    private boolean recordingConflictExists(Set<TimeInterval> aPreviouslyRecorded, TimeInterval interval) { 
+        for (TimeInterval recordedInterval: aPreviouslyRecorded ) { 
+            if ( interval.overlap(recordedInterval)) {
+                return true; 
+            }
         }
+        return false; 
     }
 
     /**