org.brapi.v2.model.geno

Class BrAPIAvailableFormat

java.lang.Object

org.brapi.v2.model.geno.BrAPIAvailableFormat

public class BrAPIAvailableFormat
extends Object

Each 'availableFormat' object is a pairing of dataFormat and fileFormat. These must be communicated in pairs because they are not independant parameters and sometimes one influences the other.

Constructor Summary

Constructors

Constructor and Description
BrAPIAvailableFormat()

Method Summary

Modifier and Type	Method and Description
BrAPIAvailableFormat	dataFormat(BrAPIGenoFileDataFormatEnum dataFormat)
boolean	equals(Object o)
BrAPIAvailableFormat	expandHomozygotes(Boolean expandHomozygotes)
BrAPIAvailableFormat	fileFormat(BrAPIFileFormatEnum fileFormat)
BrAPIAvailableFormat	fileURL(String fileURL)
BrAPIGenoFileDataFormatEnum	getDataFormat() dataFormat defines the structure of the data within a file (ie DartSeq, VCF, Hapmap, tabular, etc)
BrAPIFileFormatEnum	getFileFormat() fileFormat defines the MIME type of the file (ie text/csv, application/excel, application/zip).
String	getFileURL() A URL which indicates the location of the file version of this VariantSet.
String	getSepPhased() The string used as a separator for phased allele calls.
String	getSepUnphased() The string used as a separator for unphased allele calls.
String	getUnknownString() The string used as a representation for missing data.
int	hashCode()
Boolean	isExpandHomozygotes() Should homozygotes be expanded (true) or collapsed into a single occurrence (false)
BrAPIAvailableFormat	sepPhased(String sepPhased)
BrAPIAvailableFormat	sepUnphased(String sepUnphased)
void	setDataFormat(BrAPIGenoFileDataFormatEnum dataFormat)
void	setExpandHomozygotes(Boolean expandHomozygotes)
void	setFileFormat(BrAPIFileFormatEnum fileFormat)
void	setFileURL(String fileURL)
void	setSepPhased(String sepPhased)
void	setSepUnphased(String sepUnphased)
void	setUnknownString(String unknownString)
String	toString()
BrAPIAvailableFormat	unknownString(String unknownString)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIAvailableFormat

public BrAPIAvailableFormat()

Method Detail

dataFormat

public BrAPIAvailableFormat dataFormat(BrAPIGenoFileDataFormatEnum dataFormat)

getDataFormat

public BrAPIGenoFileDataFormatEnum getDataFormat()

dataFormat defines the structure of the data within a file (ie DartSeq, VCF, Hapmap, tabular, etc)

Returns:

dataFormat

setDataFormat

public void setDataFormat(BrAPIGenoFileDataFormatEnum dataFormat)

expandHomozygotes

public BrAPIAvailableFormat expandHomozygotes(Boolean expandHomozygotes)

isExpandHomozygotes

public Boolean isExpandHomozygotes()

Should homozygotes be expanded (true) or collapsed into a single occurrence (false)

Returns:

expandHomozygotes

setExpandHomozygotes

public void setExpandHomozygotes(Boolean expandHomozygotes)

fileFormat

public BrAPIAvailableFormat fileFormat(BrAPIFileFormatEnum fileFormat)

getFileFormat

public BrAPIFileFormatEnum getFileFormat()

fileFormat defines the MIME type of the file (ie text/csv, application/excel, application/zip). This should also be reflected in the Accept and ContentType HTTP headers for every relevant request and response.

Returns:

fileFormat

setFileFormat

public void setFileFormat(BrAPIFileFormatEnum fileFormat)

fileURL

public BrAPIAvailableFormat fileURL(String fileURL)

getFileURL

public String getFileURL()

A URL which indicates the location of the file version of this VariantSet. Could be a static file URL or an API endpoint which generates the file.

Returns:

fileURL

setFileURL

public void setFileURL(String fileURL)

sepPhased

public BrAPIAvailableFormat sepPhased(String sepPhased)

getSepPhased

public String getSepPhased()

The string used as a separator for phased allele calls.

Returns:

sepPhased

setSepPhased

public void setSepPhased(String sepPhased)

sepUnphased

public BrAPIAvailableFormat sepUnphased(String sepUnphased)

getSepUnphased

public String getSepUnphased()

The string used as a separator for unphased allele calls.

Returns:

sepUnphased

setSepUnphased

public void setSepUnphased(String sepUnphased)

unknownString

public BrAPIAvailableFormat unknownString(String unknownString)

getUnknownString

public String getUnknownString()

The string used as a representation for missing data.

Returns:

unknownString

setUnknownString

public void setUnknownString(String unknownString)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object