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 and Description
static java.lang.String	DESCRIPTION
static java.lang.String	ID
static java.lang.String	NUMBER
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
FormatMetadata(java.util.Map<java.lang.String,java.lang.String> properties)
FormatMetadata(java.lang.String id, java.lang.String description, java.lang.String number, FormatType type)

Method Summary

Modifier and Type	Method and Description
java.lang.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 Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

NUMBER

public static final java.lang.String NUMBER

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

FormatMetadata

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

FormatMetadata

public FormatMetadata(@Nonnull
                      java.util.Map<java.lang.String,java.lang.String> properties)

Method Detail

init

public void init()

getNumber

@Nullable
public java.lang.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