activeannoservice / api.annotate.dto

Package api.annotate.dto

Types

Name	Summary
AnnotateProject	View data class - all properties relevant to annotate / curate a project in the frontenddata class AnnotateProject
AnnotationResultStoreResponse	Return model for storing endpoints, letting the frontend know the data was stored successfully. If not, will return validationErrorsdata class AnnotationResultStoreResponse
ListProject	View data class - all properties necessary to display project in list in the frontenddata class ListProject
PostAnnotationResult	Data class for annotation and curation endpoints for receiving annotation results. Will be mapped into other data structures for storing.data class PostAnnotationResult
ValidationError	Single ValidationError w.r.t. an annotation definition + targetdata class ValidationError

Extensions for External Classes

Name	Summary
kotlin.collections.MutableMap

Functions

Name	Summary
toAnnotateProject	Convert a Project to an AnnotateProject, doing some operations to enrich the project data to be able to use it for annotation. For example, if an OpenTagAnnotation is present, this method might aggregate the existing values from all documents of the project and add it to the AnnotateProject.suspend fun Project.toAnnotateProject(userIdentifier: UserIdentifier, userIsCurator: Boolean = false): AnnotateProject
toListProject	Convert a Project to a ListProjectfun Project.toListProject(): ListProject
validate	Validate a PostAnnotationResult by applying the enableConditions and validate the annotation if requiredsuspend fun PostAnnotationResult.validate(document: Document, project: Project, locale: Locale?): List<ValidationError>