org.jbei.ice.services.rest

Class SearchResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.SearchResource

@Path(value="/search")
public class SearchResource
extends RestResource

REST resource for searching. Supports keyword search with query params for filtering and advanced search

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.services.rest.RestResource

API_KEY_CLIENT_ID, API_KEY_TOKEN, API_KEY_USER, apiClientId, apiToken, apiUser, AUTHENTICATION_PARAM_NAME, hmacHeader, querySessionId, REMOTE_USER_ID, REMOTE_USER_TOKEN, remoteUserId, remoteUserToken, request, sessionId, WOR_PARTNER_TOKEN, worPartnerToken

Constructor Summary

Constructors

Constructor and Description
SearchResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getIndexStatus(String indexType)
javax.ws.rs.core.Response	search(boolean searchWeb, SearchQuery query) Advanced Search.
javax.ws.rs.core.Response	search(String queryString, boolean searchWeb, int offset, int limit, String sort, boolean asc) Keyword search
javax.ws.rs.core.Response	searchPartFields(String token, String field, int limit) Search entries by using filters on the values
javax.ws.rs.core.Response	updateBlastIndex() Rebuild the blast database
javax.ws.rs.core.Response	updateLuceneIndex() Rebuild the lucene indexes used for searching

Methods inherited from class org.jbei.ice.services.rest.RestResource

addHeaders, getThisServer, getUserId, getUserId, getWebPartner, log, requireUserId, requireUserIdOrWebPartner, requireWebPartner, respond, respond, respond, respond

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResource

public SearchResource()

Method Detail

searchPartFields

@GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @Path(value="/filter")
public javax.ws.rs.core.Response searchPartFields(@DefaultValue(value="") @QueryParam(value="token")
                                                                                                                                                         String token,
                                                                                                                                                         @DefaultValue(value="SELECTION_MARKERS") @QueryParam(value="field")
                                                                                                                                                         String field,
                                                                                                                                                         @DefaultValue(value="8") @QueryParam(value="limit")
                                                                                                                                                         int limit)

Search entries by using filters on the values

search

@POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response search(@DefaultValue(value="false") @QueryParam(value="webSearch")
                                                                                                                        boolean searchWeb,
                                                                                                                        SearchQuery query)

Advanced Search. The use of post is mostly for the sequence string for blast which can get very long and results in a 413 status code if sent via GET

Parameters:

searchWeb - whether to perform a web of registry search or not

query - parameters to the search

Returns:

results of the search

search

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response search(@QueryParam(value="q")
                                                                                  String queryString,
                                                                                  @DefaultValue(value="false") @QueryParam(value="webSearch")
                                                                                  boolean searchWeb,
                                                                                  @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                  int offset,
                                                                                  @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                  int limit,
                                                                                  @DefaultValue(value="relevance") @QueryParam(value="sort")
                                                                                  String sort,
                                                                                  @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                  boolean asc)

Keyword search

Parameters:

queryString - keywords to search on

searchWeb - whether to perform a web of registry search or not

offset - result start

limit - result count upper limit

sort - result sort

asc - true if return results in ascending order, false otherwise

Returns:

wrapper around list of search results conforming to query params

updateLuceneIndex

@PUT
 @Path(value="/indexes/lucene")
public javax.ws.rs.core.Response updateLuceneIndex()

Rebuild the lucene indexes used for searching

updateBlastIndex

@PUT
 @Path(value="/indexes/blast")
public javax.ws.rs.core.Response updateBlastIndex()

Rebuild the blast database

getIndexStatus

@GET
 @Path(value="/indexes/{type}/status")
public javax.ws.rs.core.Response getIndexStatus(@PathParam(value="type")
                                                                                            String indexType)