org.brapi.v2.model.geno

Class BrAPIVariantSetAvailableFormats

java.lang.Object

org.brapi.v2.model.geno.BrAPIVariantSetAvailableFormats

public class BrAPIVariantSetAvailableFormats
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
BrAPIVariantSetAvailableFormats()

Method Summary

Modifier and Type	Method and Description
BrAPIVariantSetAvailableFormats	dataFormat(BrAPIGenoFileDataFormatEnum dataFormat)
boolean	equals(Object o)
BrAPIVariantSetAvailableFormats	fileFormat(BrAPIWSMIMEDataTypes fileFormat)
BrAPIVariantSetAvailableFormats	fileURL(String fileURL)
BrAPIGenoFileDataFormatEnum	getDataFormat() dataFormat defines the structure of the data within a file (ie DartSeq, VCF, Hapmap, tabular, etc)
BrAPIWSMIMEDataTypes	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.
int	hashCode()
void	setDataFormat(BrAPIGenoFileDataFormatEnum dataFormat)
void	setFileFormat(BrAPIWSMIMEDataTypes fileFormat)
void	setFileURL(String fileURL)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIVariantSetAvailableFormats

public BrAPIVariantSetAvailableFormats()

Method Detail

dataFormat

public BrAPIVariantSetAvailableFormats 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)

fileFormat

public BrAPIVariantSetAvailableFormats fileFormat(BrAPIWSMIMEDataTypes fileFormat)

getFileFormat

public BrAPIWSMIMEDataTypes 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(BrAPIWSMIMEDataTypes fileFormat)

fileURL

public BrAPIVariantSetAvailableFormats 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)

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