Domain Model

Overview

Documentation on the domain objects used by this system.

Details

There are threemain "categories" of domain objects used by the system

• Terminology 

• Application 

• Workflow

Following is information about the domain objects within each category.

Terminology Objects

•  

  • Concept

    • Used to capture data both retrieved from the terminology server integration, and also to store translation descriptions as part of a translation project.

    • Concepts used to track translated descriptions are stored and indexed locally

  • ConceptRefsetMember

    • Used to capture the actual concept members of a reference set.  

    • For intensional reference sets, these are the "materialized" members of the definition.

    • Inclusions/Exclusions are also stored as explicit members.

    • Persisted and indexed locally

  • Description

    • Used to capture descriptions returned from terminology server and also to represent translations of concepts as part of a translation project.

    • Descriptions representing translations are indexed and persisted locally

  • LanguageDescriptionType

    • Used to capture supported description types used by a translation project.

  • LanguageRefsetMember

    • Used to capture language refset data returned from terminology server

  • Relationship

    • Used to capture relationships returned from the terminology server

Application Objects

All application objects are persisted and indexed locally.

• ConceptDiffReport

  • Represents a computed report showing differences between two translations or two versions of the same translation.

  • Not persisted

• ConceptNote

  • A note on a concept created by a user.

  • Persisted and indexed locally.

• ConceptRefsetMemberNote

  • A note on a refset member created by a user.

  • Persisted and indexed locally.

• ConceptValidationResult

  • Used by the validation framework to report warnings and errors

  • Not persisted

• DefinitionClause

  • Used by intensional refsets to capture parts of a definition.

  • Persisted locally

• IoHandlerInfo

  • Represent configurations for import/export handlers

  • Driven from config.properties

  • Not persisted

• MemberDiffReport

  • Represents a computed report showing differences between two refsets or two versions of the same refset.

  • Not persisted

• MemberValidationResult

  • Used by the validation framework to report warnings and errors

  • Not persisted

• MemoryEntry

  • Used by translation projects to store translation memory

  • Persisted and indexed locally

• PhraseMemory

  • A collection of MemoryEntry objects

  • persisted and indexed locally

• Project

  • Represents a collection of users with particular roles and some default configurations to manage a collection of refsets or translations (or both).

  • Persisted and indexed locally.

• Refset

  • Reference sets being developed within the application.

  • Persisted and indexed locally.

• RefsetNote

  • A note on a refset  created by a user.

  • Persisted and indexed locally.

• ReleaseArtifact

  • A data file produced as part of a released

  • Persisted locally in the database as binary data

• ReleaseInfo

  • Represents a release of a refset or a translation.

  • Captures version info and other relevant metadata. 

  • Links to ReleaseArtifact objects.

  • Persisted an dindexed locally

• ReleaseProperty

  • Not used at the moment.

• SpellingDictionary

  • Used by translation projects for spelling correction.

  • Persisted and indexed locally.

• StagedRefsetChange

  • Represents a refset undergoing a staging process (import, migration, release, etc.)

  • Persisted and indexed locally

• StagedTranslationChange

  • Represents a translation undergoing a staging process (import, migration, release, etc.)

  • Persisted and indexed locally

• Terminology

  • Represents a SNOMEDCT edition and version

  • Used to capture info supplied by the terminology server

• Translation

  • Translation being developed within the application.

  • Persisted and indexed locally.

• TranslationNote

  • A note on a translation created by a user.

  • Persisted and indexed locally.

• User

  • A user of the application

  • Persisted and indexed locally

• UserPreferences

  • Preferences of a user (such as "last tab" and "last accordion", etc).

  • Associated with a user

  • Persisted locally

• ValidationResult

  • Used by the validation framework to report warnings and errors

  • Not persisted

Workflow Objects

• TrackingRecord

  • Represents a workflow state for a refset, or for a concept of a translation

References/Links

• n/a