Package ubic.gemma.rest

Class SearchWebService

java.lang.Object

ubic.gemma.rest.SearchWebService

@Service
@Path("/search")
public class SearchWebService
extends Object

Provides search capabilities to the RESTful API.

Author:

poirigui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchWebService.SearchResultsResponseDataObject
static final class	SearchWebService.SearchResultValueObject<T extends IdentifiableValueObject<?>>	Representation of SearchResult for the RESTful API.
final class	SearchWebService.SearchSettingsValueObject	Represents search settings for the RESTful API.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_SEARCH_RESULTS	Maximum number of search results.
static final String	RESULT_TYPES_SCHEMA_NAME	Name used in the OpenAPI schema to identify result types as per search(QueryArg, TaxonArg, PlatformArg, List, LimitArg, ExcludeArg)'s fourth argument.

Constructor Summary

Constructors

Constructor	Description
SearchWebService()

Method Summary

Modifier and Type	Method	Description
SearchWebService.SearchResultsResponseDataObject	search(QueryArg query, TaxonArg<?> taxonArg, PlatformArg<?> platformArg, List<String> resultTypes, LimitArg limit, ExcludeArg<SearchResult<?>> excludeArg)	Search everything subject to taxon and platform constraints.

Methods inherited from class java.lang.Object

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

Field Details

RESULT_TYPES_SCHEMA_NAME

public static final String RESULT_TYPES_SCHEMA_NAME

Name used in the OpenAPI schema to identify result types as per search(QueryArg, TaxonArg, PlatformArg, List, LimitArg, ExcludeArg)'s fourth argument.

See Also:

• Constant Field Values

MAX_SEARCH_RESULTS

public static final int MAX_SEARCH_RESULTS

Maximum number of search results.

See Also:

• Constant Field Values

Constructor Details

SearchWebService

public SearchWebService()

Method Details

search

@GET
@GZIP
@Produces("application/json")
public SearchWebService.SearchResultsResponseDataObject search(@QueryParam("query")
 QueryArg query,
 @QueryParam("taxon")
 TaxonArg<?> taxonArg,
 @QueryParam("platform")
 PlatformArg<?> platformArg,
 @QueryParam("resultTypes")
 List<String> resultTypes,
 @QueryParam("limit")
 LimitArg limit,
 @QueryParam("exclude")
 ExcludeArg<SearchResult<?>> excludeArg)

Search everything subject to taxon and platform constraints.

Naming the schema in for the result types is necessary so that it can be resolved in CustomModelResolver.