data-modelling-core 2.4.0

Core SDK library for model operations across platforms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

//! Models module for the SDK
//!
//! Defines core data structures used by the SDK for import/export operations.
//! These models are simplified versions focused on the SDK's needs.

#[cfg(feature = "bpmn")]
pub mod bpmn;
pub mod cads;
pub mod column;
pub mod cross_domain;
pub mod data_model;
pub mod dbmv;
pub mod decision;
#[cfg(feature = "dmn")]
pub mod dmn;
pub mod domain;
pub mod domain_config;
pub mod enums;
pub mod knowledge;
pub mod odcs;
pub mod odps;
#[cfg(feature = "openapi")]
pub mod openapi;
pub mod relationship;
pub mod sketch;
pub mod table;
pub mod tag;
pub mod workspace;

#[cfg(feature = "bpmn")]
pub use bpmn::{BPMNModel, BPMNModelFormat};
pub use cads::{
    CADSAsset, CADSBPMNFormat, CADSBPMNModel, CADSCompliance, CADSComplianceControl,
    CADSComplianceFramework, CADSComplianceStatus, CADSDMNFormat, CADSDMNModel, CADSDescription,
    CADSExternalLink, CADSImpactArea, CADSKind, CADSMitigationStatus, CADSOpenAPIFormat,
    CADSOpenAPISpec, CADSPricing, CADSPricingModel, CADSRisk, CADSRiskAssessment,
    CADSRiskClassification, CADSRiskMitigation, CADSRuntime, CADSRuntimeContainer,
    CADSRuntimeResources, CADSSLA, CADSSLAProperty, CADSStatus, CADSTeamMember,
    CADSValidationProfile, CADSValidationProfileAppliesTo,
};
pub use column::{
    AuthoritativeDefinition, Column, ForeignKey, LogicalTypeOptions, PropertyRelationship,
};
pub use cross_domain::{CrossDomainConfig, CrossDomainRelationshipRef, CrossDomainTableRef};
pub use data_model::DataModel;
#[cfg(feature = "dmn")]
pub use dmn::{DMNModel, DMNModelFormat};
pub use domain::{
    CADSNode, CrowsfeetCardinality, Domain, NodeConnection, ODCSNode, SharedNodeReference, System,
    SystemConnection,
};
pub use domain_config::{DomainConfig, DomainOwner, ViewPosition};
pub use enums::*;
pub use odps::{
    ODPSApiVersion, ODPSAuthoritativeDefinition, ODPSCustomProperty, ODPSDataProduct,
    ODPSDescription, ODPSInputContract, ODPSInputPort, ODPSManagementPort, ODPSOutputPort,
    ODPSSBOM, ODPSStatus, ODPSSupport, ODPSTeam, ODPSTeamMember,
};
#[cfg(feature = "openapi")]
pub use openapi::{OpenAPIFormat, OpenAPIModel};
pub use relationship::{
    ConnectionHandle, ConnectionPoint, ETLJobMetadata, ForeignKeyDetails, Relationship,
    VisualMetadata,
};
pub use table::{ContactDetails, Position, SlaProperty, Table};
pub use tag::Tag;
pub use workspace::{
    DomainReference, EnvironmentConnection, SharedResource, SystemReference, TableVisibility,
    TransformationLink, Workspace,
};

// Decision and Knowledge models
pub use dbmv::{
    DBMVDimension, DBMVDocument, DBMVJoin, DBMVMaterialization, DBMVMaterializedView, DBMVMeasure,
    DBMVMeasureFormat, DBMVMetricView, DBMVWindow,
};
pub use decision::{
    AssetLink, AssetRelationship, ComplianceAssessment, Decision, DecisionCategory, DecisionDriver,
    DecisionIndex, DecisionIndexEntry, DecisionOption, DecisionStatus, DriverPriority,
};
pub use knowledge::{
    ArticleRelationship, KnowledgeArticle, KnowledgeIndex, KnowledgeIndexEntry, KnowledgeStatus,
    KnowledgeType, RelatedArticle, ReviewFrequency, SkillLevel,
};
pub use sketch::{Sketch, SketchIndex, SketchIndexEntry, SketchStatus, SketchType};

use serde::{Deserialize, Serialize};

/// Model type for references
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum ModelType {
    /// BPMN model
    Bpmn,
    /// DMN model
    Dmn,
    /// OpenAPI specification
    OpenApi,
}

/// Model reference for CADS assets
///
/// Represents a reference from a CADS asset to a BPMN, DMN, or OpenAPI model.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ModelReference {
    /// Type of model being referenced
    pub model_type: ModelType,
    /// Target domain ID (None for same domain)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub domain_id: Option<uuid::Uuid>,
    /// Name of the referenced model
    pub model_name: String,
    /// Optional description of the reference
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

impl ModelReference {
    /// Create a new model reference
    pub fn new(model_type: ModelType, model_name: String) -> Self {
        ModelReference {
            model_type,
            domain_id: None,
            model_name,
            description: None,
        }
    }

    /// Create a cross-domain model reference
    pub fn new_cross_domain(
        model_type: ModelType,
        domain_id: uuid::Uuid,
        model_name: String,
    ) -> Self {
        ModelReference {
            model_type,
            domain_id: Some(domain_id),
            model_name,
            description: None,
        }
    }
}