Package htsjdk.samtools.filter
Class AggregateFilter
- java.lang.Object
-
- htsjdk.samtools.filter.AggregateFilter
-
- All Implemented Interfaces:
SamRecordFilter
public class AggregateFilter extends Object implements SamRecordFilter
Aggregates multiple filters and provides a method for applying them all to a given record with one method call. $Id$
-
-
Constructor Summary
Constructors Constructor Description AggregateFilter(List<SamRecordFilter> filters)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
filterOut(SAMRecord record)
Determines whether a SAMRecord matches this filterboolean
filterOut(SAMRecord first, SAMRecord second)
Determines whether a pair of SAMRecord matches this filter
-
-
-
Constructor Detail
-
AggregateFilter
public AggregateFilter(List<SamRecordFilter> filters)
Constructor- Parameters:
filters
- the list of filters that this Aggregator applies
-
-
Method Detail
-
filterOut
public boolean filterOut(SAMRecord record)
Determines whether a SAMRecord matches this filter- Specified by:
filterOut
in interfaceSamRecordFilter
- Parameters:
record
- the SAMRecord to evaluate- Returns:
- true if the SAMRecord matches at least one filter, otherwise false
-
filterOut
public boolean filterOut(SAMRecord first, SAMRecord second)
Determines whether a pair of SAMRecord matches this filter- Specified by:
filterOut
in interfaceSamRecordFilter
- Parameters:
first
- the first SAMRecord to evaluatesecond
- the second SAMRecord to evaluate- Returns:
- true if the SAMRecords matches the filter, otherwise false
-
-