org.pharmgkb.parser.vcf.model

Class InfoMetadata

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.InfoMetadata

public class InfoMetadata
extends IdDescriptionMetadata

This class represents a single VCF INFO metadata line.

In 4.1:

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

In 4.2:

 ##INFO=<ID=ID,Number=number,Type=type,Description="description",Source="source",Version="version">
 
 

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	SOURCE
static java.lang.String	TYPE
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
InfoMetadata(java.util.Map<java.lang.String,java.lang.String> properties)
InfoMetadata(java.lang.String id, java.lang.String description, InfoType type, java.lang.String number, java.lang.String source, java.lang.String version)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNumber() Value is either an integer or "A", "G", "R", or ".".
SpecialVcfNumber	getReservedNumber()
java.lang.String	getSource()
InfoType	getType()
java.lang.String	getVersion()

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

SOURCE

public static final java.lang.String SOURCE

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

InfoMetadata

public InfoMetadata(@Nonnull
                    java.lang.String id,
                    @Nonnull
                    java.lang.String description,
                    @Nonnull
                    InfoType type,
                    @Nonnull
                    java.lang.String number,
                    @Nullable
                    java.lang.String source,
                    @Nullable
                    java.lang.String version)

InfoMetadata

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

Method Detail

getNumber

@Nullable
public java.lang.String getNumber()

Value is either an integer or "A", "G", "R", 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 InfoType getType()

Returns:

Null only when incorrectly constructed without one

getSource

@Nullable
public java.lang.String getSource()

getVersion

@Nullable
public java.lang.String getVersion()