glam/schemas/20251121/linkml/modules/classes/OutputData.yaml

124 lines
4 KiB
YAML

# OutputData - Class for device/service output specifications
#
# Created per slot_fixes.yaml migration for: data_format
# Creation date: 2026-01-22
# Rule compliance: 39 (RiC-O naming), 50 (ontology mapping), 53 (generic slot reuse)
id: https://nde.nl/ontology/hc/class/OutputData
name: output_data
title: Output Data
prefixes:
linkml: https://w3id.org/linkml/
hc: https://nde.nl/ontology/hc/
schema: http://schema.org/
sosa: http://www.w3.org/ns/sosa/
dct: http://purl.org/dc/terms/
default_prefix: hc
imports:
- linkml:types
- ./DataFormat
- ../slots/has_or_had_format
- ../slots/has_or_had_description
- ../slots/has_or_had_identifier
classes:
OutputData:
class_uri: hc:OutputData
description: |
Specification of output produced by a device, service, or process.
**DEFINITION**:
OutputData captures the characteristics of data or signals emitted by
systems, including format, structure, destination, and metadata.
**USAGE**:
- IoT device data (sensor readings, beacon signals)
- API responses (JSON, XML, RDF)
- Export files (CSV, Excel, PDF)
- Streaming data (MQTT, WebSocket)
**ONTOLOGY ALIGNMENT**:
- **Primary** (`class_uri`): `hc:OutputData` - Heritage Custodian class
- **Close**: `sosa:Result` - SOSA observation result
- **Close**: `schema:DataDownload` - Schema.org data download
**Example**:
```yaml
has_or_had_output:
- has_or_had_format:
has_or_had_type: JsonFormat
has_or_had_media_type: "application/json"
has_or_had_description: "Climate sensor readings"
destination_url: "https://analytics.museum.nl/climate"
```
close_mappings:
- sosa:Result
- schema:DataDownload
slots:
- has_or_had_format
- has_or_had_description
- has_or_had_identifier
- destination_url
- schema_url
- is_streaming
slot_usage:
has_or_had_format:
range: DataFormat
inlined: true
description: |
The format specification for this output.
Uses DataFormat class to capture format type, media type, and schema.
examples:
- value:
has_or_had_type: JsonFormat
has_or_had_media_type: "application/json"
description: JSON output format
has_or_had_description:
range: string
description: Human-readable description of the output data.
examples:
- value: "Temperature and humidity readings from conservation sensors"
description: Sensor data description
destination_url:
range: uri
description: URL where output is sent or published.
examples:
- value: "https://analytics.museum.nl/data"
description: Analytics platform destination
schema_url:
range: uri
description: URL to schema definition for the output data structure.
examples:
- value: "https://api.museum.nl/schemas/climate-v1.json"
description: JSON Schema for climate data
is_streaming:
range: boolean
description: Whether this output is continuous/streaming vs batch/discrete.
examples:
- value: true
description: Real-time streaming data
- value: false
description: Batch data export
attributes:
destination_url:
range: uri
description: URL where output is sent or published.
schema_url:
range: uri
description: URL to schema definition for the output data.
is_streaming:
range: boolean
description: Whether this output is streaming vs batch.
annotations:
custodian_types: '["*"]'
custodian_types_rationale: "Output data specifications apply to all custodian types with digital systems."
specificity_score: 0.65
specificity_rationale: "Fairly specific to IoT and digital platform contexts."