Package ca.corefacility.bioinformatics.irida.service.sample

Interface MetadataTemplateService

All Superinterfaces:

CRUDService<java.lang.Long,MetadataTemplate>

All Known Implementing Classes:

MetadataTemplateServiceImpl

public interface MetadataTemplateService
extends CRUDService<java.lang.Long,MetadataTemplate>

Service for managing MetadataTemplates and related Projects

Method Summary

Modifier and Type	Method	Description
java.util.Set<MetadataEntry>	convertMetadataStringsToSet(java.util.Map<java.lang.String,MetadataEntry> metadataMap)	Get the appropriate MetadataTemplateFields and MetadataEntrys for a given map of Strings
MetadataTemplate	createMetadataTemplateInProject(MetadataTemplate template, Project project)	Create a new MetadataTemplate for a Project
void	deleteMetadataTemplateFromProject(Project project, java.lang.Long id)	Deleta a MetadataTemplate from a Project
java.util.List<MetadataTemplateField>	getAllMetadataFieldsByQueryString(java.lang.String query)	Get a list of all MetadataTemplateFields that contain the query
MetadataTemplate	getDefaultTemplateForProject(Project project)	Get the default MetadataTemplate for the given Project (if one exists)
java.util.List<MetadataTemplateField>	getMetadataFieldsForProject(Project project)	Deprecated.
MetadataRestriction	getMetadataRestrictionForFieldAndProject(Project project, MetadataTemplateField field)	Get the MetadataRestriction for the given MetadataTemplateField and Project
java.util.List<MetadataRestriction>	getMetadataRestrictionsForProject(Project project)	List all the MetadataRestriction for the given Project
java.util.List<MetadataTemplate>	getMetadataTemplatesForProject(Project project)	Get a list of MetadataTemplates for a given Project
java.util.List<MetadataTemplateField>	getPermittedFieldsForCurrentUser(Project project, boolean includeTemplateFields)	Get all MetadataTemplateField that the currently logged in user is allowed to read
java.util.List<MetadataTemplateField>	getPermittedFieldsForTemplate(MetadataTemplate template)	Get all MetadataTemplateField the current user is allowed to read for a MetadataTemplate
java.util.List<StaticMetadataTemplateField>	getStaticMetadataFields()	Get a list of all StaticMetadataTemplateFields available
MetadataTemplateField	readMetadataField(java.lang.Long id)	Get a MetadataTemplateField by its Long identifier
MetadataTemplateField	readMetadataFieldByKey(java.lang.String key)	Read a MetadataTemplateField by its key
MetadataTemplateField	readMetadataFieldByLabel(java.lang.String label)	Get a MetadataTemplateField by its String label
void	removeDefaultMetadataTemplateForProject(Project project)	Remove the default MetadataTemplate from the project.
MetadataTemplateField	saveMetadataField(MetadataTemplateField field)	Save a new metadata fields
MetadataRestriction	setMetadataRestriction(Project project, MetadataTemplateField field, ProjectMetadataRole role)	Adds or updates the MetadataRestriction for a project and field
MetadataTemplate	updateDefaultMetadataTemplateForProject(Project project, MetadataTemplate template)	Update which MetadataTemplate is the default for the given Project
MetadataTemplate	updateMetadataTemplateInProject(MetadataTemplate metadataTemplate)	Update a MetadataTemplate within a Project

Methods inherited from interface ca.corefacility.bioinformatics.irida.service.CRUDService

count, create, delete, exists, findAll, findRevisions, findRevisions, list, list, list, read, readMultiple, search, search, update, updateFields, updateMultiple

Method Detail

createMetadataTemplateInProject

MetadataTemplate createMetadataTemplateInProject(MetadataTemplate template,
                                                 Project project)

Create a new MetadataTemplate for a Project

Parameters:

template - the MetadataTemplate to create

project - the Project to create the template in

Returns:

a MetadataTemplate

deleteMetadataTemplateFromProject

void deleteMetadataTemplateFromProject(Project project,
                                       java.lang.Long id)

Deleta a MetadataTemplate from a Project

Parameters:

project - the Project to template lives in.

id - the Long identifier for a MetadataTemplate

updateMetadataTemplateInProject

MetadataTemplate updateMetadataTemplateInProject(MetadataTemplate metadataTemplate)

Update a MetadataTemplate within a Project

Parameters:

metadataTemplate - MetadataTemplate

Returns:

MetadataTemplate

getMetadataTemplatesForProject

java.util.List<MetadataTemplate> getMetadataTemplatesForProject(Project project)

Get a list of MetadataTemplates for a given Project

Parameters:

project - the Project

Returns:

a list of MetadataTemplate

readMetadataField

MetadataTemplateField readMetadataField(java.lang.Long id)

Get a MetadataTemplateField by its Long identifier

Parameters:

id - Long identifier for a MetadataTemplateField

Returns:

MetadataTemplateField

readMetadataFieldByLabel

MetadataTemplateField readMetadataFieldByLabel(java.lang.String label)

Get a MetadataTemplateField by its String label

Parameters:

label - the String label for the MetadataTemplateField.

Returns:

MetadataTemplateField

readMetadataFieldByKey

MetadataTemplateField readMetadataFieldByKey(java.lang.String key)

Read a MetadataTemplateField by its key

Parameters:

key - key for the field

Returns:

a MetadataTemplateField

getStaticMetadataFields

java.util.List<StaticMetadataTemplateField> getStaticMetadataFields()

Get a list of all StaticMetadataTemplateFields available

Returns:

a list of StaticMetadataTemplateField

saveMetadataField

MetadataTemplateField saveMetadataField(MetadataTemplateField field)

Save a new metadata fields

Parameters:

field - the MetadataTemplateField to save.

Returns:

the saved MetadataTemplateField

getAllMetadataFieldsByQueryString

java.util.List<MetadataTemplateField> getAllMetadataFieldsByQueryString(java.lang.String query)

Get a list of all MetadataTemplateFields that contain the query

Parameters:

query - the String to search labels for.

Returns:

List of MetadataTemplateField

convertMetadataStringsToSet

java.util.Set<MetadataEntry> convertMetadataStringsToSet(java.util.Map<java.lang.String,MetadataEntry> metadataMap)

Get the appropriate MetadataTemplateFields and MetadataEntrys for a given map of Strings

Parameters:

metadataMap - the strings to convert

Returns:

a Set of MetadataEntrys

getMetadataFieldsForProject

@Deprecated
java.util.List<MetadataTemplateField> getMetadataFieldsForProject(Project project)

Deprecated.

Get all the MetadataTemplateFields on a given Project

Parameters:

project - the Project to get fields for

Returns:

a list of fields

getMetadataRestrictionForFieldAndProject

MetadataRestriction getMetadataRestrictionForFieldAndProject(Project project,
                                                             MetadataTemplateField field)

Get the MetadataRestriction for the given MetadataTemplateField and Project

Parameters:

project - the Project to get the restriction for

field - the MetadataTemplateField to get the restriction for

Returns:

The found MetadataRestriction. If there is no restriction defined, this may be null

getMetadataRestrictionsForProject

java.util.List<MetadataRestriction> getMetadataRestrictionsForProject(Project project)

List all the MetadataRestriction for the given Project

Parameters:

project - the Project the Project to get restrictions for

Returns:

a List of all defined MetadataRestriction

setMetadataRestriction

MetadataRestriction setMetadataRestriction(Project project,
                                           MetadataTemplateField field,
                                           ProjectMetadataRole role)

Adds or updates the MetadataRestriction for a project and field

Parameters:

project - the Project to add a restriction for

field - the field to set a restriction on

role - the role level to set the restriction for

Returns:

the created MetadataRestriction

getPermittedFieldsForTemplate

java.util.List<MetadataTemplateField> getPermittedFieldsForTemplate(MetadataTemplate template)

Get all MetadataTemplateField the current user is allowed to read for a MetadataTemplate

Parameters:

template - the MetadataTemplate to get fields for

Returns:

a list of MetadataTemplateField

getPermittedFieldsForCurrentUser

java.util.List<MetadataTemplateField> getPermittedFieldsForCurrentUser(Project project,
                                                                       boolean includeTemplateFields)

Get all MetadataTemplateField that the currently logged in user is allowed to read

Parameters:

project - the Project to request fields from

includeTemplateFields - whether to include fields from the project's associated MetadataTemplates

Returns:

a list of MetadataTemplateField collecting the allowed MetadataTemplateField

getDefaultTemplateForProject

MetadataTemplate getDefaultTemplateForProject(Project project)

Get the default MetadataTemplate for the given Project (if one exists)

Parameters:

project - the Project to get the template for

Returns:

the default MetadataTemplate if one is set

updateDefaultMetadataTemplateForProject

MetadataTemplate updateDefaultMetadataTemplateForProject(Project project,
                                                         MetadataTemplate template)

Update which MetadataTemplate is the default for the given Project

Parameters:

project - the Project to set a template on

template - the MetadataTemplate to set

Returns:

the new default MetadataTemplate

removeDefaultMetadataTemplateForProject

void removeDefaultMetadataTemplateForProject(Project project)

Remove the default MetadataTemplate from the project. It will now use all fields as default

Parameters:

project - the Project to remove the template from