com.dnastack.bob.rest.api

Interface BeaconResponseResource

@Produces(value={"application/json","application/xml"})
public interface BeaconResponseResource

Version:

1.0

Author:

Miroslav Cupak (mirocupak@gmail.com)

Method Summary

Modifier and Type	Method and Description
Collection<com.dnastack.bob.service.dto.BeaconResponseDto>	query(String beaconIds, String chrom, Long pos, String allele, String ref) Query all the beacons or a specific beacon as determined by a param.
com.dnastack.bob.service.dto.BeaconResponseDto	queryBeacon(String beaconId, String chrom, Long pos, String allele, String ref) Query a given beacon

Method Detail

query

@GET
Collection<com.dnastack.bob.service.dto.BeaconResponseDto> query(@QueryParam(value="beacon")
                                                                      String beaconIds,
                                                                      @QueryParam(value="chrom")
                                                                      String chrom,
                                                                      @QueryParam(value="pos")
                                                                      Long pos,
                                                                      @QueryParam(value="allele")
                                                                      String allele,
                                                                      @QueryParam(value="ref")
                                                                      String ref)
                                                               throws ClassNotFoundException

Query all the beacons or a specific beacon as determined by a param.

Parameters:

beaconIds - beacon to query (optional)

chrom - chromosome

pos - position

allele - allele

ref - reference genome (optional)

Returns:

list of beacon responses

Throws:

ClassNotFoundException

queryBeacon

@GET
 @Path(value="/{beaconId}")
com.dnastack.bob.service.dto.BeaconResponseDto queryBeacon(@PathParam(value="beaconId")
                                                                                            String beaconId,
                                                                                            @QueryParam(value="chrom")
                                                                                            String chrom,
                                                                                            @QueryParam(value="pos")
                                                                                            Long pos,
                                                                                            @QueryParam(value="allele")
                                                                                            String allele,
                                                                                            @QueryParam(value="ref")
                                                                                            String ref)
                                                                                     throws ClassNotFoundException

Query a given beacon

Parameters:

beaconId - beacon to query

chrom - chromosome

pos - position

allele - allele

ref - reference genome (optional)

Returns:

list of beacon responses

Throws:

ClassNotFoundException