org.molgenis.semanticmapper.service

Interface MappingService

All Known Implementing Classes:

MappingServiceImpl

public interface MappingService

Method Summary

Modifier and Type	Method and Description
MappingProject	addMappingProject(String name, String target, int depth) Creates a new MappingProject
long	applyMappings(String mappingProjectId, String entityTypeId, Boolean addSourceAttribute, String packageId, String label, org.molgenis.jobs.Progress progress) Applies all mappings in a MappingTarget
MappingProject	cloneMappingProject(String mappingProjectId) Clones a MappingProject.
MappingProject	cloneMappingProject(String mappingProjectId, String clonedMappingProjectName) Clones a MappingProject.
void	deleteMappingProject(String mappingProjectId) Deletes a MappingProject
List<MappingProject>	getAllMappingProjects() Retrieves all MappingProjects.
Stream<EntityType>	getCompatibleEntityTypes(EntityType target) Retrieves a Stream of existing compatible EntityTypes that are valid as a mapping target.
MappingProject	getMappingProject(String identifier) Retrieves a MappingProject from the repository.
void	updateMappingProject(MappingProject mappingProject) Updates a MappingProject in the repository.

Method Detail

addMappingProject

MappingProject addMappingProject(String name,
                                 String target,
                                 int depth)

Creates a new MappingProject

Parameters:

target - name of the first target entity

getAllMappingProjects

List<MappingProject> getAllMappingProjects()

Retrieves all MappingProjects.

Returns:

list of all MappingProjects.

updateMappingProject

void updateMappingProject(MappingProject mappingProject)

Updates a MappingProject in the repository. All MappingTargets, EntityMappings and AttributeMappings are updated.

Parameters:

mappingProject - the MappingProject to update.

getMappingProject

MappingProject getMappingProject(String identifier)

Retrieves a MappingProject from the repository.

Parameters:

identifier - ID of the MappingProject

Returns:

the retrieved MappingProject

applyMappings

long applyMappings(String mappingProjectId,
                   String entityTypeId,
                   Boolean addSourceAttribute,
                   String packageId,
                   String label,
                   org.molgenis.jobs.Progress progress)

Applies all mappings in a MappingTarget

Parameters:

mappingProjectId - the id of the MappingProject whose mappings are applied

entityTypeId - the name of the entity to map to

addSourceAttribute - boolean indicating if the 'source' attribute should be added to the target repository

packageId - the id of the destination Package, ignored when mapping to existing EntityType

label - label of the target EntityType, ignored when mapping to existing EntityType

progress - progress of the mapping

Returns:

the total amount of entities mapped

deleteMappingProject

void deleteMappingProject(String mappingProjectId)

Deletes a MappingProject

Parameters:

mappingProjectId - id of the MappingProject to delete

cloneMappingProject

MappingProject cloneMappingProject(String mappingProjectId)

Clones a MappingProject. Deep copies all related mappings. Automatically generates name for cloned MappingProject.

Parameters:

mappingProjectId - id of the MappingProject to clone

Returns:

cloned MappingProject

cloneMappingProject

MappingProject cloneMappingProject(String mappingProjectId,
                                   String clonedMappingProjectName)

Clones a MappingProject. Deep copies all related mappings.

Parameters:

mappingProjectId - id of the MappingProject to clone

clonedMappingProjectName - name of the cloned MappingProject

Returns:

cloned MappingProject

getCompatibleEntityTypes

Stream<EntityType> getCompatibleEntityTypes(EntityType target)

Retrieves a Stream of existing compatible EntityTypes that are valid as a mapping target.

Parameters:

target - EntityType of the mapping target

Returns:

Stream of compatible EntityTypes