org.broadinstitute.hellbender.tools.funcotator.metadata

Interface FuncotationMetadata

All Known Implementing Classes:

VcfFuncotationMetadata

public interface FuncotationMetadata

Represents metadata information for fields in in a Funcotation. Even though types are from the VCF Spec, this can be used for other formats besides VCF.

Method Summary

Modifier and Type	Method and Description
java.util.List<htsjdk.variant.vcf.VCFInfoHeaderLine>	retrieveAllHeaderInfo()
htsjdk.variant.vcf.VCFInfoHeaderLine	retrieveHeaderInfo(java.lang.String fieldName)

Method Detail

retrieveHeaderInfo

htsjdk.variant.vcf.VCFInfoHeaderLine retrieveHeaderInfo(java.lang.String fieldName)

Parameters:

fieldName - field to search. Never null

Returns:

Returns the metadata for the given field name as a VCF Info Header Line. null is returned if the given field name is not in this metadata.

retrieveAllHeaderInfo

java.util.List<htsjdk.variant.vcf.VCFInfoHeaderLine> retrieveAllHeaderInfo()

Returns:

All of the fields in this metadata object. Never null. Empty list if this metadata instance has no fields.