Skip to content

Class: SourceDocument

A parsed view of one physical artifact, distinct from a harmonized Dataset.

URI: bfs:class/SourceDocument

 classDiagram
    class SourceDocument
    click SourceDocument href "../../classes/SourceDocument/"
      SourceDocument : artifact





        SourceDocument --> "1" SourceArtifact : artifact
        click SourceArtifact href "../../classes/SourceArtifact/"



      SourceDocument : format





        SourceDocument --> "1" SourceFormatEnum : format
        click SourceFormatEnum href "../../enums/SourceFormatEnum/"



      SourceDocument : profile





        SourceDocument --> "1" MetadataProfileEnum : profile
        click MetadataProfileEnum href "../../enums/MetadataProfileEnum/"



      SourceDocument : records





        SourceDocument --> "1..*" SourceRecord : records
        click SourceRecord href "../../classes/SourceRecord/"



Class Properties

Property Value
Tree Root Yes

Slots

Name Cardinality and Range Description Inheritance
artifact 1
SourceArtifact
The physical source represented by this document direct
format 1
SourceFormatEnum
Explicitly selected source format; never guessed from a headerless file direct
profile 1
MetadataProfileEnum
Explicit producer metadata interpretation applied in addition to the selected... direct
records 1..*
SourceRecord
Every physical line, in original order, including blank lines and unrecognize... direct

Notes

  • Records retain all original UTF-8 text and line endings, including comments and unknown syntax.
  • scripts/source_document.py validates checksums and the interpreted projection by re-parsing. JSON Schema alone does not enforce record ordering, context references, or source integrity.
  • This model does not import SequenceFeature or NMDC DataObject. A source feature row is not necessarily one biological feature; GFF3 can describe a discontinuous feature with multiple rows.

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self bfs:SourceDocument
native bfs:SourceDocument

LinkML Source

Direct

name: SourceDocument
description: A parsed view of one physical artifact, distinct from a harmonized Dataset.
notes:
- Records retain all original UTF-8 text and line endings, including comments and
  unknown syntax.
- scripts/source_document.py validates checksums and the interpreted projection by
  re-parsing. JSON Schema alone does not enforce record ordering, context references,
  or source integrity.
- This model does not import SequenceFeature or NMDC DataObject. A source feature
  row is not necessarily one biological feature; GFF3 can describe a discontinuous
  feature with multiple rows.
from_schema: https://w3id.org/ber-data/feature-schemas
slots:
- artifact
- format
- profile
- records
tree_root: true

Induced

name: SourceDocument
description: A parsed view of one physical artifact, distinct from a harmonized Dataset.
notes:
- Records retain all original UTF-8 text and line endings, including comments and
  unknown syntax.
- scripts/source_document.py validates checksums and the interpreted projection by
  re-parsing. JSON Schema alone does not enforce record ordering, context references,
  or source integrity.
- This model does not import SequenceFeature or NMDC DataObject. A source feature
  row is not necessarily one biological feature; GFF3 can describe a discontinuous
  feature with multiple rows.
from_schema: https://w3id.org/ber-data/feature-schemas
attributes:
  artifact:
    name: artifact
    description: The physical source represented by this document.
    from_schema: https://w3id.org/ber-data/feature-schemas
    rank: 1000
    owner: SourceDocument
    domain_of:
    - SourceDocument
    range: SourceArtifact
    required: true
    inlined: true
  format:
    name: format
    description: Explicitly selected source format; never guessed from a headerless
      file.
    from_schema: https://w3id.org/ber-data/feature-schemas
    rank: 1000
    owner: SourceDocument
    domain_of:
    - SourceDocument
    range: SourceFormatEnum
    required: true
  profile:
    name: profile
    description: Explicit producer metadata interpretation applied in addition to
      the selected format.
    from_schema: https://w3id.org/ber-data/feature-schemas
    rank: 1000
    owner: SourceDocument
    domain_of:
    - SourceDocument
    range: MetadataProfileEnum
    required: true
  records:
    name: records
    description: Every physical line, in original order, including blank lines and
      unrecognized content.
    from_schema: https://w3id.org/ber-data/feature-schemas
    rank: 1000
    list_elements_ordered: true
    owner: SourceDocument
    domain_of:
    - SourceDocument
    range: SourceRecord
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
tree_root: true