Package htsjdk.samtools.filter

Class FilteringSamIterator

java.lang.Object
htsjdk.samtools.filter.FilteringSamIterator
All Implemented Interfaces:
CloseableIterator<SAMRecord>, Closeable, AutoCloseable, Iterator<SAMRecord>
Direct Known Subclasses:
FilteringIterator
public class FilteringSamIterator extends Object implements CloseableIterator<SAMRecord>
Filtering Iterator which takes a filter and an iterator and iterates through only those records which are not rejected by the filter.

$Id$

  • Constructor Details

    • FilteringSamIterator

      public FilteringSamIterator(Iterator<SAMRecord> iterator, SamRecordFilter filter, boolean filterByPair)
      Constructor
      Parameters:
      iterator - the backing iterator
      filter - the filter (which may be a FilterAggregator)
      filterByPair - if true, filter reads in pairs

    • FilteringSamIterator

      public FilteringSamIterator(Iterator<SAMRecord> iterator, SamRecordFilter filter)
      Constructor
      Parameters:
      iterator - the backing iterator
      filter - the filter (which may be a FilterAggregator)

  • Method Details