TagService.java

package org.molgenis.data.semanticsearch.service;

import com.google.common.collect.Multimap;
import org.molgenis.data.meta.model.Attribute;
import org.molgenis.data.meta.model.EntityType;
import org.molgenis.data.meta.model.Package;
import org.molgenis.data.semantic.LabeledResource;
import org.molgenis.data.semantic.Relation;
import org.molgenis.data.semantic.SemanticTag;
import org.molgenis.ontology.core.model.Ontology;
import org.molgenis.ontology.core.model.OntologyTerm;

/**
 * Service that administrates tags on attributes, entities and packages of a particular code system.
 *
 * @param <ObjectType>     the type of the tag object, for instance {@link OntologyTerm}
 * @param <CodeSystemType> the type of the code system, for instance {@link Ontology}
 */
public interface TagService<ObjectType, CodeSystemType>
{
	/**
	 * Retrieves all tags for an attribute, and groups them by relation
	 */
	Multimap<Relation, ObjectType> getTagsForAttribute(EntityType entityType, Attribute attribute);

	/**
	 * Retrieves all tags for a package
	 */
	Iterable<SemanticTag<Package, ObjectType, CodeSystemType>> getTagsForPackage(Package p);

	/**
	 * Retrieves all tags for an entity.
	 */
	Iterable<SemanticTag<EntityType, LabeledResource, LabeledResource>> getTagsForEntity(EntityType entityType);

	/**
	 * Tags an attribute.
	 *
	 * @param entityType the entity the tagged attribute sits on
	 * @param tag        the tag to add
	 */
	void addAttributeTag(EntityType entityType, SemanticTag<Attribute, ObjectType, CodeSystemType> tag);

	/**
	 * Removes attribute tag
	 *
	 * @param entityType the entity the tagged attribute sits on
	 * @param tag        the tag to remove
	 */
	void removeAttributeTag(EntityType entityType, SemanticTag<Attribute, ObjectType, CodeSystemType> tag);

	/**
	 * Tags an entity.
	 *
	 * @param tag the tag to add
	 */
	void addEntityTag(SemanticTag<EntityType, ObjectType, CodeSystemType> tag);

	/**
	 * Removes an entity tag.
	 *
	 * @param tag the tag to remove
	 */
	void removeEntityTag(SemanticTag<EntityType, ObjectType, CodeSystemType> tag);

	/**
	 * Removes all tags for a given entity
	 *
	 * @param entityName the name of the entity for which all tags should be removed
	 */
	void removeAllTagsFromEntity(String entityName);
}