ActiveAnno

Web-based responsive document annotation tool

View the Project on GitHub MaxMello/ActiveAnno

activeannoservice / project.annotationschema

Package project.annotationschema

Types

Name Summary
And data class And : EnableCondition
AnnotationSchema Annotation schema as defined in the database (with ID references to AnnotationDefinitions and AnnotationGenerators.data class AnnotationSchema
AnnotationSchemaElement Single element of the schema, mapping the ID of an AnnotationDefinition to data specific to this project and the Target of the annotation. different target definition for the same annotationdata class AnnotationSchemaElement
AnnotationsKey Get some data from some annotationsdata class AnnotationsKey : AnnotationStepKey
AnnotationStepKey Base class for subclasses that define how some data from a Document or GeneratedAnnotationData is extracted and used for EnableCondition or annotation generation.sealed class AnnotationStepKey
AtomicEnableCondition AtomicEnableConditions are defined in relation to a single referenceKey and do not include more complex conditions such as And or Or.abstract class AtomicEnableCondition : EnableCondition
DenormalizedAnnotationSchema Annotation schema as sent to the frontend / client, contains the actual models of AnnotationDefinition, AnnotationGenerator etc.data class DenormalizedAnnotationSchema
DenormalizedAnnotationSchemaElement Equivalent to AnnotationSchemaElement but denormalized, meaning all ID references are replaced by the actual objectsdata class DenormalizedAnnotationSchemaElement
EnableCondition AnnotationSchemaElements can be conditional, defined by an EnableCondition. If an EnableCondition is null, that means it is always required. Else, the enable conditions execute method needs to return true for the element to be prompted.abstract class EnableCondition
Not data class Not : EnableCondition
Or data class Or : EnableCondition
OriginalDocumentKey Get some data from the originalDocument of a Documentdata class OriginalDocumentKey : AnnotationStepKey
ValuesEqual class ValuesEqual : AtomicEnableCondition
ValuesExist class ValuesExist : AtomicEnableCondition
ValuesIntersect class ValuesIntersect : AtomicEnableCondition

Functions

Name Summary
denormalize suspend fun AnnotationSchema.denormalize(): DenormalizedAnnotationSchema
suspend fun AnnotationSchemaElement.denormalize(): DenormalizedAnnotationSchemaElement