Package org.pharmgkb.parser.vcf.model

Class IdDescriptionMetadata

java.lang.Object

org.pharmgkb.parser.vcf.model.BaseMetadata

org.pharmgkb.parser.vcf.model.IdMetadata

org.pharmgkb.parser.vcf.model.IdDescriptionMetadata

Direct Known Subclasses:

FormatMetadata, InfoMetadata

public class IdDescriptionMetadata
extends IdMetadata

This class represents a single VCF metadata line with an id and description.

In 4.1/4.2:

 ##ALT=<ID=type,Description="description">
 ##FILTER=<ID=ID,Description="description">
 
 

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	IdDescriptionMetadata(String id, String description)
protected	IdDescriptionMetadata(String id, String description, boolean isBaseType)
	IdDescriptionMetadata(Map<String,String> properties, boolean isBaseType)

Method Summary

Modifier and Type	Method	Description
String	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

Constructor Details

IdDescriptionMetadata

public IdDescriptionMetadata(@Nonnull
 String id,
 @Nonnull
 String description)

IdDescriptionMetadata

public IdDescriptionMetadata(@Nonnull
 Map<String,String> properties,
 boolean isBaseType)

IdDescriptionMetadata

protected IdDescriptionMetadata(@Nonnull
 String id,
 @Nonnull
 String description,
 boolean isBaseType)

Method Details

getDescription

@Nullable
public String getDescription()

Returns:

Null only when incorrectly constructed without one