001/*
002 * #%L
003 * Netarchivesuite - common
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 */
023
024package dk.netarkivet.common.utils.cdx;
025
026import java.io.Serializable;
027
028/**
029 * Interface defining a filter to use in CDXReader when finding CDXRecords.
030 */
031public interface CDXRecordFilter extends Serializable {
032
033    /**
034     * Process one CDXRecord - return true/false.
035     *
036     * @param cdxrec the CDXRecord to be processed.
037     * @return true or false on whether the processed CDXRecord is "valid" according to this filter implementation. true
038     * means this CDXRecord is valid!
039     */
040    boolean process(CDXRecord cdxrec);
041
042    /**
043     * @return the name of the Filter
044     */
045    String getFilterName();
046
047}