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