# Note class (singular)
# Generic class for typed notes with provenance
#
# Generation date: 2026-01-18
# Rule compliance: 0 (LinkML single source of truth), 38 (slot centralization), 43 (singular nouns)
# Migration: Supports has_or_had_note slot (replaces claim_note, category_note, etc.)
#
# NOTE: This is the SINGULAR form per Rule 43. Used with has_or_had_note slot.
# Notes (plural class) exists for historical/backwards compatibility with has_or_had_notes slot.

id: https://nde.nl/ontology/hc/class/Note
name: note_class
title: Note Class

prefixes:
  linkml: https://w3id.org/linkml/
  hc: https://nde.nl/ontology/hc/
  skos: http://www.w3.org/2004/02/skos/core#
  rdfs: http://www.w3.org/2000/01/rdf-schema#
  schema: http://schema.org/
  dcterms: http://purl.org/dc/terms/

default_prefix: hc

imports:
  - linkml:types
  - ../metadata
  - ../slots/note_type
  - ../slots/note_content
  - ../slots/note_date
  - ../slots/language
  - ../slots/specificity_annotation
  - ../slots/has_or_had_score
  - ./SpecificityAnnotation
  - ./TemplateSpecificityScore
  - ./TemplateSpecificityType
  - ./TemplateSpecificityTypes

classes:
  Note:
    class_uri: skos:note
    description: |
      A typed note with optional provenance metadata.
      
      **Purpose**:
      Note provides a reusable class for representing documentation notes
      across the heritage custodian schema. Supports typed notes (claim,
      appraisal, arrangement, conservation, extraction, etc.) with language
      tagging and dates.
      
      **Ontological Alignment**:
      - **Primary**: `skos:note` - general note
      - **Close**: `rdfs:comment` - comment on resource
      
      **Use Cases**:
      - Claim notes documenting extraction details
      - Category notes for classification explanations
      - Certainty notes for confidence documentation
      - Conservation notes documenting treatments
      - Extraction notes for pipeline documentation
      - General documentation notes
      
      **Replaces** (per slot_fixes.yaml):
      - `claim_note` (string) → has_or_had_note with Note class
      - `category_note` (string) → has_or_had_note with Note class
      - `certainty_note` (string) → has_or_had_note with Note class
      - `conservation_note` (string) → has_or_had_note with Note class
      - `copy_note` (string) → has_or_had_note with Note class
      - `event_note` (string) → has_or_had_note with Note class
      - `extraction_note` (string) → has_or_had_note with Note class
      - `feature_note` (string) → has_or_had_note with Note class
      - Other *_note slots per slot_fixes.yaml
      
    exact_mappings:
      - skos:note
    
    close_mappings:
      - rdfs:comment
      - dcterms:description
    
    slots:
      - note_type
      - note_content
      - note_date
      - language
      - specificity_annotation
      - has_or_had_score
    
    slot_usage:
      note_type:
        description: |
          The type of note (claim, category, certainty, conservation, copy, event, extraction, feature, general).
          This allows distinguishing different kinds of notes when multiple
          apply to the same entity.
        range: string
        required: false
        examples:
          - value: claim
            description: Claim extraction documentation
          - value: category
            description: Category/classification notes
          - value: conservation
            description: Treatment documentation
          - value: extraction
            description: Pipeline extraction notes
          - value: general
            description: General documentation notes
      note_content:
        description: The textual content of the note.
        range: string
        required: true
      note_date:
        description: Date the note was created or last updated.
        range: date
        required: false
      language:
        description: |
          ISO 639-1 two-letter language code for this note.
          Examples: "en", "nl", "de", "fr"
        range: string
        required: false
        pattern: "^[a-z]{2}$"
    
    annotations:
      custodian_types: '["*"]'
      custodian_types_rationale: Generic note class applicable to all custodian types.
      custodian_types_primary: null
      specificity_score: 0.2
      specificity_rationale: Very broadly applicable generic class for documentation notes.
    
    examples:
      - value: |
          note_type: claim
          note_content: "Additional verification required for this claim. Source webpage may have changed since extraction."
          note_date: "2026-01-18"
          language: en
        description: "Claim note documenting extraction issue"
      - value: |
          note_type: extraction
          note_content: "Biography truncated from longer text on page. Original text exceeded 500 chars."
          note_date: "2025-11-29"
          language: en
        description: "Extraction note documenting processing decision"
      - value: |
          note_type: conservation
          note_content: "Surface cleaning completed. No further treatment recommended at this time."
          note_date: "2024-06-15"
          language: en
        description: "Conservation note documenting treatment"