IndividualFilter.java

/* This program is free software: you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public License
 as published by the Free Software Foundation, either version 3 of
 the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>. */

package org.opentripplanner.analyst.batch;

public interface IndividualFilter {

    /**
     * An interface for classes that examine each Individual in a Population before a batch analyst run.
     * IndividualFilters can modify the individuals (for example, clamping or transforming values)
     * and accept or reject them for use in the analysis.
     * 
     * @param individual
     * @return true if the inividual should be included in the analysis, false otherwise
     */
    public boolean filter(Individual individual);
    
}