Package htsjdk.samtools.filter
Class ReadNameFilter
- java.lang.Object
-
- htsjdk.samtools.filter.ReadNameFilter
-
- All Implemented Interfaces:
SamRecordFilter
public class ReadNameFilter extends Object implements SamRecordFilter
Filter by a set of specified readnames $Id$
-
-
Constructor Summary
Constructors Constructor Description ReadNameFilter(File readNameFilterFile, boolean includeReads)
ReadNameFilter(Set<String> readNameFilterSet, boolean includeReads)
-
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 SAMRecords matches this filter
-
-
-
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 the filter, otherwise false
-
filterOut
public boolean filterOut(SAMRecord first, SAMRecord second)
Determines whether a pair of SAMRecords matches this filter- Specified by:
filterOut
in interfaceSamRecordFilter
- Parameters:
first
- the first SAMRecord to evaluatesecond
- the second SAMRecord to evaluate- Returns:
- true if the pair of records matches filter, otherwise false
-
-