/* SAMRecordPredicate
 *
 * This file is part of Artemis
 * 
 * Copyright (C) 2009  Genome Research Limited
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 **/

package uk.ac.sanger.artemis.components.alignment;

import net.sf.samtools.SAMRecord;

/**
 *  Each object that implements this interface represents a predicate that can
 *  be tested with a SAMRecord reference.
 **/

public interface SAMRecordPredicate {
  /**
   *  Test the given SAMRecord against this predicate.
   *  @param feature The SAMRecord to test the predicate against.
   *  @return Return true if and only if this predicate is true for the given
   *    SAMRecord.
   **/
  boolean testPredicate (final SAMRecord samRecord);
}


