Package ca.corefacility.bioinformatics.irida.web.controller.api.samples

Class RESTSampleMetadataController

java.lang.Object

ca.corefacility.bioinformatics.irida.web.controller.api.samples.RESTSampleMetadataController

@Controller
public class RESTSampleMetadataController
extends java.lang.Object

REST controller to handle storing and retrieving metadata from a Sample

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALL_METADATA_REL
static java.lang.String	METADATA_REL
static java.lang.String	SAMPLE_REL

Constructor Summary

Constructors

Constructor	Description
RESTSampleMetadataController(SampleService sampleService, MetadataTemplateService metadataTemplateService, ProjectService projectService)

Method Summary

Modifier and Type	Method	Description
ResponseResource<SampleMetadataResponse>	addSampleMetadata(java.lang.Long sampleId, java.util.Map<java.lang.String,MetadataEntry> metadataMap)	Add select new metadata fields to the Sample.
ResponseResource<ResourceCollection<SampleMetadataResponse>>	getProjectSampleMetadata(java.lang.Long projectId)	Get all the sample metadata for a given Project
ResponseResource<SampleMetadataResponse>	getSampleMetadata(java.lang.Long sampleId)	Get the metadata for a given Sample
ResponseResource<SampleMetadataResponse>	saveSampleMetadata(java.lang.Long sampleId, java.util.Map<java.lang.String,MetadataEntry> metadataMap)	Save new metadata for a Sample.

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_REL

public static final java.lang.String METADATA_REL

See Also:

Constant Field Values

ALL_METADATA_REL

public static final java.lang.String ALL_METADATA_REL

See Also:

Constant Field Values

SAMPLE_REL

public static final java.lang.String SAMPLE_REL

See Also:

Constant Field Values

Constructor Detail

RESTSampleMetadataController

@Autowired
public RESTSampleMetadataController(SampleService sampleService,
                                    MetadataTemplateService metadataTemplateService,
                                    ProjectService projectService)

Method Detail

getSampleMetadata

@RequestMapping(value="/api/samples/{sampleId}/metadata",
                method=GET)
public ResponseResource<SampleMetadataResponse> getSampleMetadata(@PathVariable
                                                                  java.lang.Long sampleId)

Get the metadata for a given Sample

Parameters:

sampleId - the id of the Sample to get metadata for

Returns:

the metadata for the sample

getProjectSampleMetadata

@RequestMapping(value="/api/projects/{projectId}/samples/metadata",
                method=GET)
public ResponseResource<ResourceCollection<SampleMetadataResponse>> getProjectSampleMetadata(@PathVariable
                                                                                             java.lang.Long projectId)

Get all the sample metadata for a given Project

Parameters:

projectId - the id of the Project to get metadata for

Returns:

A collection of metadata for all the Samples in the Project

saveSampleMetadata

@RequestMapping(value="/api/samples/{sampleId}/metadata",
                method=POST)
public ResponseResource<SampleMetadataResponse> saveSampleMetadata(@PathVariable
                                                                   java.lang.Long sampleId,
                                                                   @RequestBody
                                                                   java.util.Map<java.lang.String,MetadataEntry> metadataMap)

Save new metadata for a Sample. Note this will overwrite the existing metadata

Parameters:

sampleId - the id of the Sample to save new metadata

metadataMap - the metadata to save to the Sample

Returns:

the updated Sample

addSampleMetadata

@RequestMapping(value="/api/samples/{sampleId}/metadata",
                method=PUT)
public ResponseResource<SampleMetadataResponse> addSampleMetadata(@PathVariable
                                                                  java.lang.Long sampleId,
                                                                  @RequestBody
                                                                  java.util.Map<java.lang.String,MetadataEntry> metadataMap)

Add select new metadata fields to the Sample. Note this will only overwrite duplicate terms. Existing metadata will not be affected.

Parameters:

sampleId - the Sample to add metadata to

metadataMap - the new metadata

Returns:

the updated Sample