wamblee.org Git - utils/blob - crawler/kiss/src/main/java/org/wamblee/crawler/kiss/main/ProgramFilter.java

   1 /*
   2  * Copyright 2005 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.wamblee.crawler.kiss.main;
  18
  19 import java.util.List;
  20
  21 import org.wamblee.conditions.Condition;
  22 import org.wamblee.crawler.kiss.guide.MatchVisitor;
  23 import org.wamblee.crawler.kiss.guide.Program;
  24 import org.wamblee.crawler.kiss.guide.TVGuide;
  25
  26 /**
  27  * Obtains a list of interesting programs from a TV guide and decides what to do
  28  * with them.
  29  *
  30  * @author Erik Brakkee
  31  */
  32 public class ProgramFilter {
  33
  34     private Condition<Program> _condition;
  35
  36     private ProgramAction _action;
  37
  38     /**
  39      * Constructs the program filter.
  40      * @param aCondition Condition used to find interesting programs.
  41      * @param aAction Corresponding action to execute for matching programs.
  42      */
  43     public ProgramFilter(Condition<Program> aCondition, ProgramAction aAction) {
  44         _condition = aCondition;
  45         _action = aAction;
  46     }
  47
  48     /**
  49      * Gets the action.
  50      * @return Action.
  51      */
  52     public ProgramAction getAction() {
  53         return _action;
  54     }
  55
  56     /**
  57      * Applies the filter to a TV guide.
  58      * @param aGuide TV guide.
  59      * @return List of matching programs.
  60      */
  61     public List<Program> apply(TVGuide aGuide) {
  62         MatchVisitor matcher = new MatchVisitor(_condition);
  63         aGuide.accept(matcher);
  64         return matcher.getMatches();
  65     }
  66 }