Interface RecommendationService
-
public interface RecommendationService
The main contact point of the Recommendation module. This interface can be injected in the wicket pages. It is used to pull the latest recommendations for an annotation layer and render them.
-
-
Field Summary
Fields Modifier and Type Field Description static int
MAX_RECOMMENDATIONS_CAP
static int
MAX_RECOMMENDATIONS_DEFAULT
static java.lang.String
SERVICE_NAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
createOrUpdateRecommender(Recommender aRecommender)
void
deleteRecommender(Recommender aRecommender)
boolean
existsRecommender(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, java.lang.String aName)
java.util.List<Recommender>
getActiveRecommenders(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer aLayer)
RecommenderContext
getContext(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, Recommender aRecommender)
Returns theRecommenderContext
for the given recommender if it exists, else it creates an empty one.java.util.List<Recommender>
getEnabledRecommenders(java.lang.Long aRecommenderId)
Predictions
getIncomingPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
Predictions
getPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
Preferences
getPreferences(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
Recommender
getRecommender(long aId)
java.util.Optional<Recommender>
getRecommender(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, java.lang.String aName)
RecommendationEngineFactory
getRecommenderFactory(Recommender aRecommender)
java.util.List<Recommender>
listEnabledRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
java.util.List<de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer>
listLayersWithEnabledRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
Returns all annotation layers in the given project which have any enabled recommenders.java.util.List<Recommender>
listRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer aLayer)
java.util.List<Recommender>
listRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
void
putIncomingPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, Predictions aPredictions)
void
setActiveRecommenders(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer layer, java.util.List<Recommender> selectedClassificationTools)
void
setPreferences(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, Preferences aPreferences)
java.lang.Boolean
showLearningCurveDiagram()
boolean
switchPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
int
upsertFeature(de.tudarmstadt.ukp.clarin.webanno.api.AnnotationSchemaService annotationService, de.tudarmstadt.ukp.clarin.webanno.model.SourceDocument aDocument, java.lang.String aUsername, org.apache.uima.jcas.JCas aJCas, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer layer, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationFeature aFeature, java.lang.String aValue, int aBegin, int aEnd)
Uses the given annotation suggestion to create a new annotation or to update a feature in an existing annotation.
-
-
-
Field Detail
-
SERVICE_NAME
static final java.lang.String SERVICE_NAME
- See Also:
- Constant Field Values
-
MAX_RECOMMENDATIONS_DEFAULT
static final int MAX_RECOMMENDATIONS_DEFAULT
- See Also:
- Constant Field Values
-
MAX_RECOMMENDATIONS_CAP
static final int MAX_RECOMMENDATIONS_CAP
- See Also:
- Constant Field Values
-
-
Method Detail
-
createOrUpdateRecommender
void createOrUpdateRecommender(Recommender aRecommender)
-
deleteRecommender
void deleteRecommender(Recommender aRecommender)
-
getRecommender
Recommender getRecommender(long aId)
-
getRecommender
java.util.Optional<Recommender> getRecommender(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, java.lang.String aName)
-
existsRecommender
boolean existsRecommender(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, java.lang.String aName)
-
listRecommenders
java.util.List<Recommender> listRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
-
listRecommenders
java.util.List<Recommender> listRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer aLayer)
-
getEnabledRecommenders
java.util.List<Recommender> getEnabledRecommenders(java.lang.Long aRecommenderId)
-
listEnabledRecommenders
java.util.List<Recommender> listEnabledRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
-
listLayersWithEnabledRecommenders
java.util.List<de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer> listLayersWithEnabledRecommenders(de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
Returns all annotation layers in the given project which have any enabled recommenders.
-
getRecommenderFactory
RecommendationEngineFactory getRecommenderFactory(Recommender aRecommender)
-
setActiveRecommenders
void setActiveRecommenders(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer layer, java.util.List<Recommender> selectedClassificationTools)
-
getActiveRecommenders
java.util.List<Recommender> getActiveRecommenders(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer aLayer)
-
setPreferences
void setPreferences(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, Preferences aPreferences)
-
getPreferences
Preferences getPreferences(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
-
getPredictions
Predictions getPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
-
getIncomingPredictions
Predictions getIncomingPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
-
putIncomingPredictions
void putIncomingPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject, Predictions aPredictions)
-
switchPredictions
boolean switchPredictions(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, de.tudarmstadt.ukp.clarin.webanno.model.Project aProject)
-
getContext
RecommenderContext getContext(de.tudarmstadt.ukp.clarin.webanno.security.model.User aUser, Recommender aRecommender)
Returns theRecommenderContext
for the given recommender if it exists, else it creates an empty one.- Parameters:
aUser
- The owner of the contextaRecommender
- The recommender to which the desired context belongs- Returns:
- The context of the given recommender if there is one, or an empty one
-
upsertFeature
int upsertFeature(de.tudarmstadt.ukp.clarin.webanno.api.AnnotationSchemaService annotationService, de.tudarmstadt.ukp.clarin.webanno.model.SourceDocument aDocument, java.lang.String aUsername, org.apache.uima.jcas.JCas aJCas, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationLayer layer, de.tudarmstadt.ukp.clarin.webanno.model.AnnotationFeature aFeature, java.lang.String aValue, int aBegin, int aEnd) throws de.tudarmstadt.ukp.clarin.webanno.api.annotation.exception.AnnotationException
Uses the given annotation suggestion to create a new annotation or to update a feature in an existing annotation.- Returns:
- the CAS address of the created/updated annotation.
- Throws:
de.tudarmstadt.ukp.clarin.webanno.api.annotation.exception.AnnotationException
-
showLearningCurveDiagram
java.lang.Boolean showLearningCurveDiagram()
-
-