Package picard.vcf.processor
Class VariantIteratorProducer
- java.lang.Object
-
- picard.vcf.processor.VariantIteratorProducer
-
public abstract class VariantIteratorProducer extends Object
A mechanism for iterating overCloseableIteratorofVariantContexts in in some fashion, given VCF files and optionally an interval list. The produced iterators may perform on-the-fly filtering of the producedVariantContexts.
-
-
Constructor Summary
Constructors Constructor Description VariantIteratorProducer()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static VariantIteratorProducerbyHundredMegabaseChunks(List<File> vcfs)Produces a chunking with segments of size 100 megabases (or less if a contig boundary is reached).static VariantIteratorProducerbyHundredMegabaseChunksWithOnTheFlyFilteringByInterval(List<File> vcfs, htsjdk.samtools.util.IntervalList intervalList)Produces a chunking with segments of size 100 megabases (or less if a contig boundary is reached), that also performs on-the-fly filtering ofVariantContextabstract voidclose()Closes any latent file handles that may have been opened by calls toiterators().abstract Iterable<htsjdk.samtools.util.CloseableIterator<htsjdk.variant.variantcontext.VariantContext>>iterators()Renders the embodied regions of the VCF files in the form ofCloseableIterators overVariantContexts.
-
-
-
Method Detail
-
iterators
public abstract Iterable<htsjdk.samtools.util.CloseableIterator<htsjdk.variant.variantcontext.VariantContext>> iterators()
Renders the embodied regions of the VCF files in the form ofCloseableIterators overVariantContexts. The iterator may perform on-the-fly filtering of these elements.
-
close
public abstract void close()
Closes any latent file handles that may have been opened by calls toiterators().
-
byHundredMegabaseChunksWithOnTheFlyFilteringByInterval
public static VariantIteratorProducer byHundredMegabaseChunksWithOnTheFlyFilteringByInterval(List<File> vcfs, htsjdk.samtools.util.IntervalList intervalList)
Produces a chunking with segments of size 100 megabases (or less if a contig boundary is reached), that also performs on-the-fly filtering ofVariantContext
-
byHundredMegabaseChunks
public static VariantIteratorProducer byHundredMegabaseChunks(List<File> vcfs)
Produces a chunking with segments of size 100 megabases (or less if a contig boundary is reached).
-
-