Package ubic.gemma.rest

Class AnalysisResultSetsWebService

java.lang.Object

ubic.gemma.rest.AnalysisResultSetsWebService

@Service
@Path("/resultSets")
public class AnalysisResultSetsWebService
extends Object

Endpoint for AnalysisResultSet

Constructor Summary

Constructors

Constructor	Description
AnalysisResultSetsWebService()

Method Summary

Modifier and Type	Method	Description
ResponseDataObject<Long>	getNumberOfResultSets(FilterArg<ExpressionAnalysisResultSet> filter)
ResponseDataObject<DifferentialExpressionAnalysisResultSetValueObject>	getResultSet(ExpressionAnalysisResultSetArg analysisResultSet, Boolean excludeResults)	Retrieve a AnalysisResultSet given its identifier.
javax.ws.rs.core.StreamingOutput	getResultSetAsTsv(ExpressionAnalysisResultSetArg analysisResultSet)	Retrieve an AnalysisResultSet in a tabular format.
FilteredAndPaginatedResponseDataObject<DifferentialExpressionAnalysisResultSetValueObject>	getResultSets(DatasetArrayArg datasets, DatabaseEntryArrayArg databaseEntries, FilterArg<ExpressionAnalysisResultSet> filters, OffsetArg offset, LimitArg limit, SortArg<ExpressionAnalysisResultSet> sort)	Retrieve all AnalysisResultSet matching a set of criteria.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalysisResultSetsWebService

public AnalysisResultSetsWebService()

Method Detail

getResultSets

@GET
@Produces("application/json")
public FilteredAndPaginatedResponseDataObject<DifferentialExpressionAnalysisResultSetValueObject> getResultSets(@QueryParam("datasets")
                                                                                                                DatasetArrayArg datasets,
                                                                                                                @QueryParam("databaseEntries")
                                                                                                                DatabaseEntryArrayArg databaseEntries,
                                                                                                                @QueryParam("filter") @DefaultValue("")
                                                                                                                FilterArg<ExpressionAnalysisResultSet> filters,
                                                                                                                @QueryParam("offset") @DefaultValue("0")
                                                                                                                OffsetArg offset,
                                                                                                                @QueryParam("limit") @DefaultValue("20")
                                                                                                                LimitArg limit,
                                                                                                                @QueryParam("sort") @DefaultValue("+id")
                                                                                                                SortArg<ExpressionAnalysisResultSet> sort)

Retrieve all AnalysisResultSet matching a set of criteria.

Parameters:

datasets - filter result sets that belong to any of the provided dataset identifiers, or null to ignore

databaseEntries - filter by associated datasets with given external identifiers, or null to ignore

getNumberOfResultSets

@GET
@Path("/count")
@Produces("application/json")
public ResponseDataObject<Long> getNumberOfResultSets(@QueryParam("filter") @DefaultValue("")
                                                      FilterArg<ExpressionAnalysisResultSet> filter)

getResultSet

@GET
@Path("/{resultSet}")
@Produces("application/json")
public ResponseDataObject<DifferentialExpressionAnalysisResultSetValueObject> getResultSet(@PathParam("resultSet")
                                                                                           ExpressionAnalysisResultSetArg analysisResultSet,
                                                                                           @QueryParam("excludeResults") @DefaultValue("false")
                                                                                           Boolean excludeResults)

Retrieve a AnalysisResultSet given its identifier.

getResultSetAsTsv

@GET
@Path("/{resultSet_}")
@Produces("text/tab-separated-values; charset=UTF-8; q=0.9")
public javax.ws.rs.core.StreamingOutput getResultSetAsTsv(@PathParam("resultSet_")
                                                          ExpressionAnalysisResultSetArg analysisResultSet)

Retrieve an AnalysisResultSet in a tabular format.

This is intentionally using a slightly different parameter name for the Path to create a distinct entry in the OpenAPI specification as a workaround to Swagger's codegen incapability to treat multiple media types per endpoint.