ubic.gemma.rest

Class AnalysisResultSetsWebService

java.lang.Object

ubic.gemma.rest.AnalysisResultSetsWebService

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

Endpoint for AnalysisResultSet

Constructor Summary

Constructors

Constructor and Description
AnalysisResultSetsWebService()

Method Summary

Modifier and Type	Method and Description
ResponseDataObject<Long>	getNumberOfResultSets(FilterArg<ubic.gemma.model.analysis.expression.diff.ExpressionAnalysisResultSet> filter)
ResponseDataObject<ubic.gemma.model.analysis.expression.diff.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<ubic.gemma.model.analysis.expression.diff.DifferentialExpressionAnalysisResultSetValueObject>	getResultSets(DatasetArrayArg datasets, DatabaseEntryArrayArg databaseEntries, FilterArg<ubic.gemma.model.analysis.expression.diff.ExpressionAnalysisResultSet> filters, OffsetArg offset, LimitArg limit, SortArg<ubic.gemma.model.analysis.expression.diff.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(value="application/json")
public FilteredAndPaginatedResponseDataObject<ubic.gemma.model.analysis.expression.diff.DifferentialExpressionAnalysisResultSetValueObject> getResultSets(@QueryParam(value="datasets")
                                                                                                                                                                                                    DatasetArrayArg datasets,
                                                                                                                                                                                                    @QueryParam(value="databaseEntries")
                                                                                                                                                                                                    DatabaseEntryArrayArg databaseEntries,
                                                                                                                                                                                                    @QueryParam(value="filter") @DefaultValue(value="")
                                                                                                                                                                                                    FilterArg<ubic.gemma.model.analysis.expression.diff.ExpressionAnalysisResultSet> filters,
                                                                                                                                                                                                    @QueryParam(value="offset") @DefaultValue(value="0")
                                                                                                                                                                                                    OffsetArg offset,
                                                                                                                                                                                                    @QueryParam(value="limit") @DefaultValue(value="20")
                                                                                                                                                                                                    LimitArg limit,
                                                                                                                                                                                                    @QueryParam(value="sort") @DefaultValue(value="+id")
                                                                                                                                                                                                    SortArg<ubic.gemma.model.analysis.expression.diff.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(value="/count")
 @Produces(value="application/json")
public ResponseDataObject<Long> getNumberOfResultSets(@QueryParam(value="filter") @DefaultValue(value="")
                                                                                                                       FilterArg<ubic.gemma.model.analysis.expression.diff.ExpressionAnalysisResultSet> filter)

getResultSet

@GET
 @Path(value="/{resultSet}")
 @Produces(value="application/json")
public ResponseDataObject<ubic.gemma.model.analysis.expression.diff.DifferentialExpressionAnalysisResultSetValueObject> getResultSet(@PathParam(value="resultSet")
                                                                                                                                                                                                            ExpressionAnalysisResultSetArg analysisResultSet,
                                                                                                                                                                                                            @QueryParam(value="excludeResults") @DefaultValue(value="false")
                                                                                                                                                                                                            Boolean excludeResults)

Retrieve a AnalysisResultSet given its identifier.

getResultSetAsTsv

@GET
 @Path(value="/{resultSet_}")
 @Produces(value="text/tab-separated-values; charset=UTF-8; q=0.9")
public javax.ws.rs.core.StreamingOutput getResultSetAsTsv(@PathParam(value="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.