Skip to content

File format versions

Nils Reiter edited this page May 29, 2018 · 8 revisions

From time to time, a change in the file format becomes necessary. Specifically, this means changes in the UIMA type system. This page lists the different versions of the type system, and the versions of the program they are used with.

Type system version Application version
v1 1.5 -
LEGACY 1.0.0-alpha1 - 1.4

Conversion

To convert files from one type system to the other, we use the importer mechanism that is in place to import from other entirely different file types. For each step from one version to the next, an converter is added. Their names all start with the label "Convert", followed by the step they are converting from and to. E.g., the converter labeled Convert: LEGACY → v1 converts from LEGACY files to v1 files.

Format documentation

v1

de.unistuttgart.ims.coref.annotator.api.v1.Mention

Inherits from: uima.tcas.Annotation

Description: A mention in the text.

Features
Name Description Range
Entity the entity that this mention belongs to. de.unistuttgart.ims.coref.annotator.api.v1.Entity
Discontinuous If this mention is discontinuous, the detached part is stored here. de.unistuttgart.ims.coref.annotator.api.v1.DetachedMentionPart
Flags An array of strings that stores flags uima.cas.StringArray

de.unistuttgart.ims.coref.annotator.api.v1.Entity

Inherits from: uima.cas.TOP

Description: An entity, that is not linked to a specific text segment.

Features
Name Description Range
Label A label of the entity, shown in the tree view. uima.cas.String
Color The color used for underlining uima.cas.Integer
Key The key for keyboard based annotation uima.cas.String
Flags An array of strings that stores flags uima.cas.StringArray
Hidden A boolean to indicate whether this entity has been hidden uima.cas.Boolean
XmlId A field to store the xml id of the entity, if it has been loaded from TEI/XML uima.cas.String

de.unistuttgart.ims.coref.annotator.api.v1.EntityGroup

Inherits from: de.unistuttgart.ims.coref.annotator.api.v1.Entity

Description: Represents an entity group

Features
Name Description Range
Members An array containin the members of the group uima.cas.FSArray

de.unistuttgart.ims.coref.annotator.api.v1.DetachedMentionPart

Inherits from: uima.tcas.Annotation

Description: For detached relative clauses etc., this is used to mark them

Features
Name Description Range
Mention A pointer to the mention this detached part belongs to de.unistuttgart.ims.coref.annotator.api.v1.Mention

Legacy

This is the type system that has been used from the start. It does not contain a version number, which is why it's called legacy.

de.unistuttgart.ims.coref.annotator.api.Mention

Inherits from: uima.tcas.Annotation

Description:

Features
Name Description Range
Entity de.unistuttgart.ims.coref.annotator.api.Entity
Discontinuous de.unistuttgart.ims.coref.annotator.api.DetachedMentionPart
Flags uima.cas.StringArray

de.unistuttgart.ims.coref.annotator.api.Entity

Inherits from: uima.cas.TOP

Features
Name Description Range
Label uima.cas.String
Color uima.cas.Integer
Key uima.cas.String
Flags uima.cas.StringArray
Hidden uima.cas.Boolean
XmlId uima.cas.String

de.unistuttgart.ims.coref.annotator.api.EntityGroup

Inherits from: de.unistuttgart.ims.coref.annotator.api.Entity

Features
Name Description Range
Members uima.cas.FSArray

de.unistuttgart.ims.coref.annotator.api.DetachedMentionPart

Inherits from: uima.tcas.Annotation

Features
Name Description Range
Mention de.unistuttgart.ims.coref.annotator.api.Mention

de.unistuttgart.ims.coref.annotator.api.Comment

Inherits from: uima.cas.TOP

Features
Name Description Range
Author uima.cas.String
Value uima.cas.String

de.unistuttgart.ims.coref.annotator.api.MentionComment

Inherits from: de.unistuttgart.ims.coref.annotator.api.Comment

Features
Name Description Range
Mention de.unistuttgart.ims.coref.annotator.api.Mention

de.unistuttgart.ims.coref.annotator.api.AnnotationComment

Inherits from: de.unistuttgart.ims.coref.annotator.api.Comment

Features
Name Description Range
Annotation uima.tcas.Annotation

de.unistuttgart.ims.coref.annotator.api.CommentAnchor

Inherits from: uima.tcas.Annotation