/*
 * Copyright 2005 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.wamblee.crawler.kiss.guide;

import java.util.ArrayList;
import java.util.List;

import org.wamblee.conditions.Condition;

/**
 * Visitor which determines the interesting programs in the TV guide. 
 *
 * @author Erik Brakkee
 */
public class MatchVisitor extends AbstractVisitor {

    /**
     * Criterion that determines which programs are interesting. 
     */
    private Condition<Program> _matcher;

    /**
     * List of interesting programs. 
     */
    private List<Program> _programs;

    /**
     * Constructs the visitor. 
     * @param aMatcher Condition describing interesting programs. 
     */
    public MatchVisitor(Condition<Program> aMatcher) {
        _matcher = aMatcher;
        _programs = new ArrayList<Program>();
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.wamblee.crawler.kiss.Visitor#visitProgram(org.wamblee.crawler.kiss.Program)
     */
    public void visitProgram(Program aProgram) {
        if (_matcher.matches(aProgram)) {
            _programs.add(aProgram);
        }
    }

    /**
     * Gets the list of interesting programs. To be called after applying 
     * the visitor on a tv guide. 
     * @return List of interesting programs. 
     */
    public List<Program> getMatches() {
        return _programs;
    }

}