e8633401222faa21e6478ae4b1ec295d2778d9c8
[utils] /
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 public class ProgramFilter {
31
32     private Condition<Program> _condition;
33
34     private ProgramAction _action;
35
36     /**
37      * Constructs the program filter. 
38      * @param aCondition Condition used to find interesting programs. 
39      * @param aAction Corresponding action to execute for matching programs. 
40      */
41     public ProgramFilter(Condition<Program> aCondition, ProgramAction aAction) {
42         _condition = aCondition;
43         _action = aAction;
44     }
45
46     /**
47      * Gets the action. 
48      * @return Action. 
49      */
50     public ProgramAction getAction() {
51         return _action;
52     }
53
54     /**
55      * Applies the filter to a TV guide. 
56      * @param aGuide TV guide. 
57      * @return List of matching programs. 
58      */
59     public List<Program> apply(TVGuide aGuide) {
60         MatchVisitor matcher = new MatchVisitor(_condition);
61         aGuide.accept(matcher);
62         return matcher.getMatches();
63     }
64 }