module__org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader

#org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader

Synopsis

org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader reads documents and annotations from an AlvisAE campaign.

Description

org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader reads an AlvisAE server database and imports documents and annotation sets from an annotation campaign. The database connection is specified with url, username, password and schema. The campaignId parameter specifies the campaign identifier in the AlvisAE database (the AlvisAE client displays this identifier).

All AlvisAE annotations, including text-bound annotations, will be represented in AlvisNLP/ML as relation tuples, in a relation named after the annotation type.

• For text-bound annotations, each fragment is represented in an annotation stored in the layer fragmentsLayerName. The tuple references the fragments through its arguments; their role name is fragmentRolePrefix with the fragment order appended (starting at zero). Thus a single-fragment annotation will have a single argument with role frag0. The type of the annotation is stored in the feature typeFeature of the tuple and of each fragment.
• A group tuple references its items through its arguments; their role name is itemRolePrefix with the item order appended (starting at zero).
• A relation tuple hareferences its arguments in a straightforward way.

Parameters

campaignId

Optional

Type: Integer

Identifier of the AlvisAE campaign to import.

password

Optional

Type: String

User password for JDBC connection.

schema

Optional

Type: String

PostgreSQL schema.

url

Optional

Type: String

PostgreSQL database URL.

username

Optional

Type: String

PostgreSQL user name.

constantAnnotationFeatures

Optional

Type: Mapping

Constant features to add to each annotation created by this module

constantDocumentFeatures

Optional

Type: Mapping

Constant features to add to each document created by this module

constantRelationFeatures

Optional

Type: Mapping

Constant features to add to each relation created by this module

constantSectionFeatures

Optional

Type: Mapping

Constant features to add to each section created by this module

constantTupleFeatures

Optional

Type: Mapping

Constant features to add to each tuple created by this module

docDescriptions

Optional

Type: String[]]

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only documents whose description is included in the value. If not set, then org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports all documents.

docExternalIds

Optional

Type: String[]]

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only documents whose external id is included in the value. If not set, then org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports all documents.

docIds

Optional

Type: Integer[]]

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only documents whose external id is included in the value. If not set, then org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports all documents.

taskFeature

Optional

Type: String

Name of the feature where to store the name task where the annotation belongs.

taskId

Optional

Type: Integer

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only annotation sets of tasks whose id is included in the value. If this parameter and taskName are not set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports annotations of all tasks.

taskIdFeature

Optional

Type: String

Feature where to store the task identifier from which the annotation was imported.

taskName

Optional

Type: String

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only annotation sets of tasks whose name is included in the value. If this parameter and taskId are not set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports annotations of all tasks.

userFeature

Optional

Type: String

Name of the feature where to store the name of the AlvisAE user that created the annotation.

userIdFeature

Optional

Type: String

Feature where to store the user identifier from which the annotation was imported.

userIds

Optional

Type: Integer[]]

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only annotation sets created by an user whose id is included in the value. If this parameter and userNames are not set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports annotations of all users.

userNames

Optional

Type: String[]]

If set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports only annotation sets created by an user included in the value. If this parameter and userIds are not set, org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports annotations of all users.

adjudicate

Default value: false

Type: Boolean

Either to automatically adjudicate identical source annotations, implies loadDependencies.

annotationIdFeature

Default value: id

Type: String

Name of the feature where to store AlvisAE identifier of the annotation.

annotationSetIdFeature

Default value: annotation-set

Type: String

Name of the feature where to store the identifier of the annotation set to which belongs the annotation.

createdFeature

Default value: created

Type: String

Feature containing the annotation creation date.

descriptionFeature

Default value: description

Type: String

Feature containing the document description.

externalIdFeature

Default value: external-id

Type: String

Feature containing the document external id.

fragmentRolePrefix

Default value: frag

Type: String

For tuples that represent text-bound annotations, prefix of the role of fragment arguments.

fragmentTypeFeature

Default value: type

Type: String

In annotations that represent text-bound fragments, name of the feature where to store the type of the annotation.

fragmentsLayerName

Default value: alvisae

Type: String

Name of the layer where to store text-bound annotation fragments.

head

Default value: true

Type: Boolean

If true, then org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports the head annotation set. If false, then org.bibliome.alvisnlp.modules.alvisae.AlvisAEReader imports the annotation set with version 1.

htmlLayerName

Default value: html

Type: String

Name of the layer where to store annotations that represent HTML tags.

htmlTagFeature

Default value: tag

Type: String

Feature where to store HTML tag name for annotations imported from the HTML annotation set.

itemRolePrefix

Default value: item

Type: String

Prefix of the roles of arguments that represent group items.

kindFeature

Default value: kind

Type: String

Name of the relation feature containing the annotation kind (values are: text-bound, group, or relation).

loadDependencies

Default value: false

Type: Boolean

Either to load dependencies if the annotation set task is a review.

loadGroups

Default value: true

Type: Boolean

Either to import group annotations.

loadRelations

Default value: true

Type: Boolean

Either to import relation annotations.

loadTextBound

Default value: true

Type: Boolean

Either to import text-bound annotations.

oldModel

Default value: false

Type: Boolean

Support database model for AlvisAE v0.3.

referentFeature

Default value: referent

Type: String

Name of the feature where to store back-reference of sources.

sectionName

Default value: alvisae

Type: String

Name of the unique section created in each document.

sourceRolePrefix

Default value: source

Type: String

Prefix for the roles for source annotations, will only be used if loadDependencies is true.

typeFeature

Default value: type

Type: String

Feature that contains the type of the annotation.

unmatchedFeature

Default value: unmatched

Type: String

Feature where to store the AlvisAE identifiers of unmatched annotations (for review annotation sets).