53a840392c1fc7e66e003e7deb954e0f5a43baf0
[utils] / crawler / kiss / src / main / java / org / wamblee / crawler / kiss / guide / MatchVisitor.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.guide;
18
19 import java.util.ArrayList;
20 import java.util.List;
21
22 import org.wamblee.conditions.Condition;
23
24 /**
25  * Visitor which determines the interesting programs in the TV guide. 
26  *
27  * @author Erik Brakkee
28  */
29 public class MatchVisitor extends AbstractVisitor {
30
31     /**
32      * Criterion that determines which programs are interesting. 
33      */
34     private Condition<Program> _matcher;
35
36     /**
37      * List of interesting programs. 
38      */
39     private List<Program> _programs;
40
41     /**
42      * Constructs the visitor. 
43      * @param aMatcher Condition describing interesting programs. 
44      */
45     public MatchVisitor(Condition<Program> aMatcher) {
46         _matcher = aMatcher;
47         _programs = new ArrayList<Program>();
48     }
49
50     /*
51      * (non-Javadoc)
52      * 
53      * @see org.wamblee.crawler.kiss.Visitor#visitProgram(org.wamblee.crawler.kiss.Program)
54      */
55     public void visitProgram(Program aProgram) {
56         if (_matcher.matches(aProgram)) {
57             _programs.add(aProgram);
58         }
59     }
60
61     /**
62      * Gets the list of interesting programs. To be called after applying 
63      * the visitor on a tv guide. 
64      * @return List of interesting programs. 
65      */
66     public List<Program> getMatches() {
67         return _programs;
68     }
69
70 }