org.jbei.ice.services.rest

Class AnnotationResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.AnnotationResource

@Path(value="/annotations")
public class AnnotationResource
extends RestResource

REST resource for annotations

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
AnnotationResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	curate(List<DNAFeature> list) Curate available annotations to include or exclude them from auto-annotation feature
javax.ws.rs.core.Response	getAnnotationsForSequence(FeaturedDNASequence sequence) Generates annotations for the passed sequence
javax.ws.rs.core.Response	getFeatures(int offset, int limit, String sort, boolean asc, String filter) Retrieve list of annotations available.
javax.ws.rs.core.Response	rebuildAnnotations()

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

AnnotationResource

public AnnotationResource()

Method Detail

getFeatures

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getFeatures(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                                       int offset,
                                                                                       @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                       int limit,
                                                                                       @DefaultValue(value="created") @QueryParam(value="sort")
                                                                                       String sort,
                                                                                       @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                       boolean asc,
                                                                                       @QueryParam(value="filter")
                                                                                       String filter)

Retrieve list of annotations available. Administrative privileges required

Parameters:

offset - paging start

limit - maximum number of results to return

sort - sort field

asc - sort order

curate

@PUT
 @Produces(value="application/json")
public javax.ws.rs.core.Response curate(List<DNAFeature> list)

Curate available annotations to include or exclude them from auto-annotation feature

Parameters:

list - list of annotations each with specified curate

getAnnotationsForSequence

@POST
public javax.ws.rs.core.Response getAnnotationsForSequence(FeaturedDNASequence sequence)

Generates annotations for the passed sequence

Parameters:

sequence - sequence wrapper.

Returns:

annotations for sequence

rebuildAnnotations

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