Package org.pharmgkb.parser.vcf.model

Class FormatMetadata

java.lang.Object

org.pharmgkb.parser.vcf.model.BaseMetadata

org.pharmgkb.parser.vcf.model.IdMetadata

org.pharmgkb.parser.vcf.model.IdDescriptionMetadata

org.pharmgkb.parser.vcf.model.FormatMetadata

public class FormatMetadata
extends IdDescriptionMetadata

This class represents a single VCF FORMAT metadata line.

 ##FORMAT=<ID=ID,Number=number,Type=type,Description="description">
 
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION
static final String	ID
static final String	NUMBER
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
FormatMetadata(String id, String description, String number, FormatType type)
FormatMetadata(Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
String	getNumber()	Value is either an integer or ".".
SpecialVcfNumber	getReservedNumber()
FormatType	getType()
void	init()

Methods inherited from class org.pharmgkb.parser.vcf.model.IdDescriptionMetadata

getDescription

Methods inherited from class org.pharmgkb.parser.vcf.model.IdMetadata

getId

Methods inherited from class org.pharmgkb.parser.vcf.model.BaseMetadata

ensureNoExtras, getPropertiesRaw, getPropertiesUnquoted, getPropertyKeys, getPropertyRaw, getPropertyUnquoted, putAndQuoteProperty, putPropertyRaw

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

NUMBER

public static final String NUMBER

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

FormatMetadata

public FormatMetadata(@Nonnull
 String id,
 @Nonnull
 String description,
 @Nonnull
 String number,
 @Nonnull
 FormatType type)

FormatMetadata

public FormatMetadata(@Nonnull
 Map<String,String> properties)

Method Details

init

public void init()

getNumber

@Nullable
public String getNumber()

Value is either an integer or ".".

Returns:

Null only when incorrectly constructed without one

getReservedNumber

@Nullable
public SpecialVcfNumber getReservedNumber()

Returns:

A special (reserved) Number ("A", "G", "R", or "."), or null if the Number is not reserved (it is numerical).

getType

@Nullable
public FormatType getType()

Returns:

Null only when incorrectly constructed without one