Package htsjdk.beta.codecs.reads.htsget
Class HtsgetBAMDecoder
java.lang.Object
htsjdk.beta.codecs.reads.htsget.HtsgetBAMDecoder
- All Implemented Interfaces:
HtsDecoder<SAMFileHeader,
,SAMRecord> HtsQuery<SAMRecord>
,ReadsDecoder
,ReadsQuery<SAMRecord>
,Closeable
,AutoCloseable
,Iterable<SAMRecord>
- Direct Known Subclasses:
HtsgetBAMDecoderV1_2
Base class for concrete implementations of reads decoders that handle
BundleResourceType.READS_HTSGET_BAM
decoding.-
Constructor Summary
ConstructorDescriptionHtsgetBAMDecoder
(Bundle inputBundle, ReadsDecoderOptions readsDecoderOptions) -
Method Summary
Modifier and TypeMethodDescriptionfinal String
Get a user-friendly display name for this decoder.Get the name of the file format supported by this decoder.The format name defines the underlying format handled by this decoder, and also corresponds to the format of the primary bundle resource that is required when decoding (seeBundleResourceType
andBundleResource.getFileFormat()
).Get the inputBundle
for this decoder.Get theReadsDecoderOptions
for this decoder.Get the version of the file format supported by this decoder.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface htsjdk.beta.plugin.HtsDecoder
close, getHeader
Methods inherited from interface htsjdk.beta.plugin.interval.HtsQuery
hasIndex, isQueryable, iterator, query, query, query, query, queryContained, queryContained, queryContained, queryOverlapping, queryOverlapping, queryOverlapping, queryStart
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface htsjdk.beta.plugin.reads.ReadsDecoder
queryMate, queryUnmapped
-
Constructor Details
-
HtsgetBAMDecoder
-
-
Method Details
-
getFileFormat
Description copied from interface:HtsDecoder
Get the name of the file format supported by this decoder.The format name defines the underlying format handled by this decoder, and also corresponds to the format of the primary bundle resource that is required when decoding (seeBundleResourceType
andBundleResource.getFileFormat()
).- Specified by:
getFileFormat
in interfaceHtsDecoder<SAMFileHeader,
SAMRecord> - Returns:
- the name of the underlying file format handled by this decoder
-
getVersion
Description copied from interface:HtsDecoder
Get the version of the file format supported by this decoder.- Specified by:
getVersion
in interfaceHtsDecoder<SAMFileHeader,
SAMRecord>
-
getDisplayName
Description copied from interface:HtsDecoder
Get a user-friendly display name for this decoder.- Specified by:
getDisplayName
in interfaceHtsDecoder<SAMFileHeader,
SAMRecord> - Returns:
- a user-friendly display name for this decoder for use in error and warning messages
-
getInputBundle
Get the inputBundle
for this decoder.- Returns:
- the input
Bundle
for this decoder
-
getReadsDecoderOptions
Get theReadsDecoderOptions
for this decoder.- Returns:
- the
ReadsDecoderOptions
for this decoder.
-