htsjdk.samtools.filter

Class TagFilter

java.lang.Object

htsjdk.samtools.filter.TagFilter

All Implemented Interfaces:

SamRecordFilter

public class TagFilter
extends java.lang.Object
implements SamRecordFilter

Filter class for matching tag attributes in SAMRecords $Id$

Constructor Summary

Constructors

Constructor and Description
TagFilter(java.lang.String tag, java.util.List<java.lang.Object> values) Constructor for multiple values
TagFilter(java.lang.String tag, java.lang.Object value) Constructor for a single value

Method Summary

Modifier and Type	Method and Description
boolean	filterOut(SAMRecord record) Determines whether a SAMRecord matches this filter
boolean	filterOut(SAMRecord first, SAMRecord second) Determines whether a paired of SAMRecord matches this filter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagFilter

public TagFilter(java.lang.String tag,
                 java.lang.Object value)

Constructor for a single value

Parameters:

tag - the key of the tag to match

value - the value to match

TagFilter

public TagFilter(java.lang.String tag,
                 java.util.List<java.lang.Object> values)

Constructor for multiple values

Parameters:

tag - the key of the tag to match

values - the matching values

Method Detail

filterOut

public boolean filterOut(SAMRecord record)

Determines whether a SAMRecord matches this filter

Specified by:

filterOut in interface SamRecordFilter

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 paired of SAMRecord matches this filter

Specified by:

filterOut in interface SamRecordFilter

Parameters:

first - the first SAMRecord to evaluate

second - the second SAMRecord to evaluate

Returns:

true if the SAMRecords matches the filter, otherwise false