org.pharmgkb.parser.vcf.model.genotype

Class VcfGenotype

java.lang.Object

org.pharmgkb.parser.vcf.model.genotype.VcfGenotype

@Immutable
public class VcfGenotype
extends java.lang.Object

A diploid (or haploid; see below) genotype matching the VCF 4.2 specification.

For example:

• A/A (an unphased homozygous genotype)
• A|ATG (an phased heterozygous 2bp insertion of TG)

This class can also handle haploid genotypes (e.g. A), but note that:

     Genotype.fromString("A").toString(); // prints A|A
 
 

Always use equals(Object) to compare genotypes, not toString().equals.

Constructor Summary

Constructors

Constructor and Description
VcfGenotype(VcfAllele allele1, VcfAllele allele2, boolean isPhased) Note:

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static VcfGenotype	fromNumberString(VcfPosition position, java.lang.String genotype)
static VcfGenotype	fromString(java.lang.String genotype)
static VcfGenotype	fromVcf(VcfPosition position, VcfSample sample)
VcfAllele	getAllele1()
VcfAllele	getAllele2()
java.util.Set<VcfAllele>	getAlleleSet()
int	hashCode()
boolean	isHomozygous()
boolean	isNoCall()
boolean	isPhased()
java.lang.String	makeGt(VcfPosition position)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VcfGenotype

public VcfGenotype(@Nullable
                   VcfAllele allele1,
                   @Nullable
                   VcfAllele allele2,
                   boolean isPhased)

Note:

   VcfGenotype homozygous = new VcfGenotype("A", "A", false);
   homogyzgous.isPhased(); // false
 
 

The same logic applies with haploid genotypes.

Method Detail

fromString

@Nonnull
public static VcfGenotype fromString(@Nonnull
                                               java.lang.String genotype)

Parameters:

genotype - A string like A/TT

fromVcf

@Nullable
public static VcfGenotype fromVcf(@Nonnull
                                             VcfPosition position,
                                             @Nonnull
                                             VcfSample sample)

Returns:

The genotype, or null if GT is null

fromNumberString

@Nullable
public static VcfGenotype fromNumberString(@Nonnull
                                                      VcfPosition position,
                                                      @Nonnull
                                                      java.lang.String genotype)

Parameters:

genotype - A string like 0/1

Returns:

The genotype, or null if GT is null

makeGt

@Nonnull
public java.lang.String makeGt(@Nonnull
                                         VcfPosition position)

isPhased

public boolean isPhased()

Returns:

True iff the the genotype is effectively phased.: returns true for haploid genotypes and homozygous genotypes

isHomozygous

public boolean isHomozygous()

isNoCall

public boolean isNoCall()

getAllele1

@Nullable
public VcfAllele getAllele1()

getAllele2

@Nullable
public VcfAllele getAllele2()

getAlleleSet

@Nonnull
public java.util.Set<VcfAllele> getAlleleSet()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

For example, A|ATGC or A/C

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object