001/*
002 * #%L
003 * Netarchivesuite - harvester
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023package dk.netarkivet.harvester.harvesting.frontier;
024
025/**
026 * Interface for a frontier report filter.
027 * <p>
028 * Such a filter takes a frontier report as input, and filters its lines to generate another frontier report.
029 */
030public interface FrontierReportFilter {
031
032    /**
033     * Initialize the filter from arguments.
034     *
035     * @param args the arguments as strings.
036     */
037    void init(String[] args);
038
039    /**
040     * Filters the given frontier report.
041     *
042     * @param initialFrontier the report to filter.
043     * @return a filtered frontier report.
044     */
045    InMemoryFrontierReport process(FrontierReport initialFrontier);
046
047    /**
048     * Returns a unique identifier for this filter class.
049     *
050     * @return unique identifier for this filter class
051     */
052    String getFilterId();
053
054}