Package 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	Description
static final String	DESCRIPTION
static final String	ID
static final String	NUMBER
static final String	SOURCE
static final String	TYPE
static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
InfoMetadata(String id, String description, InfoType type, String number, String source, String version)
InfoMetadata(Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
String	getNumber()	Value is either an integer or "A", "G", "R", or ".".
SpecialVcfNumber	getReservedNumber()
String	getSource()
InfoType	getType()
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 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

SOURCE

public static final String SOURCE

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

Constructor Details

InfoMetadata

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

InfoMetadata

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

Method Details

getNumber

@Nullable
public 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 String getSource()

getVersion

@Nullable
public String getVersion()