org.molgenis.data.annotation.core.entity

Interface EntityAnnotator

All Superinterfaces:

Annotator

All Known Implementing Classes:

AbstractAnnotator, QueryAnnotatorImpl

public interface EntityAnnotator
extends Annotator

Simple interface to implement for fine-grained annotators.

Author:

fkelpin

Method Summary

Modifier and Type	Method and Description
Iterable<Entity>	annotateEntity(Entity sourceEntity, boolean updateMode) Annotates a single entity.
CmdLineAnnotatorSettingsConfigurer	getCmdLineAnnotatorSettingsConfigurer()
List<Attribute>	getRequiredAttributes()
boolean	sourceExists()

Methods inherited from interface org.molgenis.data.annotation.core.entity.Annotator

createAnnotatorAttributes, getAnnotatorAttributes, getInfo

Method Detail

annotateEntity

Iterable<Entity> annotateEntity(Entity sourceEntity,
                                boolean updateMode)

Annotates a single entity.

Parameters:

sourceEntity - the entity to annotate

updateMode - boolean indicating if existing annotations should be updated

Returns:

Iterable for the annotated data

getRequiredAttributes

List<Attribute> getRequiredAttributes()

Returns:

the List that must be present in the source entity.

sourceExists

boolean sourceExists()

Returns:

Indication if the required source repository is present in the dataService

getCmdLineAnnotatorSettingsConfigurer

CmdLineAnnotatorSettingsConfigurer getCmdLineAnnotatorSettingsConfigurer()