Package VCF.Filters
Class SampleFilter
- java.lang.Object
-
- VCF.Filters.SampleFilter
-
- All Implemented Interfaces:
VCFFilter
- Direct Known Subclasses:
SampleMissing
public abstract class SampleFilter extends java.lang.Object implements VCFFilter
Represents a sample filter
-
-
Constructor Summary
Constructors Constructor Description SampleFilter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
change(VCF vcf)
Apply this filter to a VCFabstract boolean
test(Sample s)
Tests whether a sample should be filtered out-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface VCF.Filters.VCFFilter
getConfig, getSummary
-
-
-
-
Method Detail
-
test
public abstract boolean test(Sample s) throws VCFDataException
Tests whether a sample should be filtered out- Parameters:
s
- The sample to test- Returns:
- Whether this sample should be filtered out
- Throws:
VCFDataException
- If there is a problem with the data in the VCF
-
change
public void change(VCF vcf) throws VCFDataException
Description copied from interface:VCFFilter
Apply this filter to a VCF- Specified by:
change
in interfaceVCFFilter
- Parameters:
vcf
- The VCF- Throws:
VCFDataException
- If there is a problem with the data in the VCF
-
-