# xomega-net/xomegaframework architecture

> Architecture diagram of the GitHub repository xomega-net/xomegaframework, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/xomega-net/xomegaframework
- Repository: https://github.com/xomega-net/xomegaframework

## Overview

Xomega Framework is a reusable .NET framework for data-oriented web and desktop applications. Its main user-facing flow is to define search criteria, run a search through a view model, represent results and editable records in framework data objects, and bind those models to technology-specific views. Business services, REST/WCF hosting, lookup data, authentication, and shared error handling support that flow. The README documents several UI targets; sampled source confirms only selected implementations and relationships, so unsampled integrations are shown without inferred call paths.

Main entry points: [`src/Xomega.Framework/ViewModels/SearchViewModel.cs`](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/SearchViewModel.cs) (Search workflow), [`src/Xomega.Framework.AspNetCore/LookupTableController.cs`](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/LookupTableController.cs) (Lookup API), [`src/Xomega.Framework/Criteria/CriteriaObject.cs`](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Criteria/CriteriaObject.cs) (Search criteria), [`src/Xomega.Framework/Errors/ErrorList.cs`](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Errors/ErrorList.cs) (Error handling)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_model["Data model"]
  node_criteria["Search criteria<br/>[CriteriaObject.cs]"]
  node_operators["Criteria operators<br/>[Operator.cs]"]
  node_properties["Typed properties<br/>[DataProperty.cs]"]
  node_dataobject["Data objects<br/>[DataObject.cs]"]
  node_rows["Data rows<br/>[DataRow.cs]"]
  node_datalist["Result lists<br/>[DataListObject.cs]"]
end

subgraph group_services["Services and APIs"]
  node_services["Business services<br/>[BaseService.cs]"]
  node_output["Service output<br/>[Output.cs]"]
  node_restclient["REST client<br/>[RestApiClient.cs]"]
  node_aspnet["REST controllers<br/>[BaseController.cs]"]
  node_wcf["WCF hosting"]
  node_lookupapi["Lookup API"]
  node_auth["JWT authentication"]
end

subgraph group_presentation["Presentation logic"]
  node_viewmodel["View models<br/>[ViewModel.cs]"]
  node_searchvm["Search workflow<br/>[SearchViewModel.cs]"]
  node_detailsvm["Details workflow"]
end

subgraph group_ui["UI adapters"]
  node_webview["WebForms views<br/>[WebSearchView.cs]"]
  node_blazorview["Blazor views"]
  node_wpfview["WPF views<br/>[WPFSearchView.cs]"]
  node_syncfusion["Syncfusion views<br/>[XSfSearchView.cs]"]
end

subgraph group_crosscut["Shared capabilities"]
  node_lookups[("Lookup caching<br/>[LookupCache.cs]")]
  node_errors["Error handling<br/>[ErrorList.cs]"]
  node_errorparser["Exception parsing<br/>[ErrorParser.cs]"]
  node_principal["Principal provider"]
end

node_user(("App user"))

node_user -->|"initiates search"| node_searchvm
node_searchvm -->|"extends"| node_viewmodel
node_searchvm -->|"sets criteria"| node_criteria
node_searchvm -->|"reads results"| node_datalist
node_datalist -->|"applies criteria"| node_criteria
node_criteria -->|"uses operators"| node_operators
node_webview -->|"binds view model"| node_searchvm
node_blazorview -->|"binds view model"| node_searchvm
node_wpfview -->|"binds view model"| node_searchvm
node_syncfusion -->|"extends search view"| node_blazorview
node_services -->|"uses criteria operators"| node_operators
node_aspnet -->|"collects request errors"| node_errors
node_lookupapi -->|"reads and clears"| node_lookups
node_lookupapi -->|"returns lookup result"| node_output
node_lookupapi -->|"reports missing table"| node_errors
node_errorparser -->|"builds error list"| node_errors
node_wcf -->|"sets request principal"| node_principal
node_user -.->|"opens record"| node_detailsvm
node_restclient -.->|"calls REST API"| node_aspnet
node_auth -.->|"supports API authentication"| node_restclient
node_dataobject -.->|"contains typed fields"| node_properties
node_rows -->|"reads property values"| node_properties
node_services -.->|"returns operation output"| node_output

click node_criteria "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Criteria/CriteriaObject.cs"
click node_operators "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Operators/Operator.cs"
click node_properties "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataProperties/DataProperty.cs"
click node_dataobject "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataObjects/DataObject.cs"
click node_rows "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataObjects/DataRow.cs"
click node_datalist "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataObjects/DataListObject.cs"
click node_viewmodel "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/ViewModel.cs"
click node_searchvm "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/SearchViewModel.cs"
click node_detailsvm "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/DetailsViewModel.cs"
click node_services "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Services/BaseService.cs"
click node_output "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Services/Output.cs"
click node_restclient "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Client/RestApiClient.cs"
click node_aspnet "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/BaseController.cs"
click node_wcf "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Wcf/ServiceInstanceProvider.cs"
click node_webview "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Web/Views/WebSearchView.cs"
click node_blazorview "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Blazor/Views/BlazorSearchView.cs"
click node_wpfview "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Wpf/Views/WPFSearchView.cs"
click node_syncfusion "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Syncfusion.Blazor/Views/XSfSearchView.cs"
click node_lookups "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Lookup/LookupCache.cs"
click node_lookupapi "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/LookupTableController.cs"
click node_errors "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Errors/ErrorList.cs"
click node_errorparser "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Errors/ErrorParser.cs"
click node_auth "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/Security/JwtAuthController.cs"
click node_principal "https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Services/IPrincipalProvider.cs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_criteria,node_operators,node_properties,node_dataobject,node_rows,node_datalist,node_user toneBlue
class node_services,node_output,node_restclient,node_aspnet,node_wcf,node_lookupapi,node_auth toneAmber
class node_viewmodel,node_searchvm,node_detailsvm toneMint
class node_webview,node_blazorview,node_wpfview,node_syncfusion toneRose
class node_lookups,node_errors,node_errorparser,node_principal toneIndigo
```

## Components

### Data model

- [Search criteria](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Criteria/CriteriaObject.cs): `src/Xomega.Framework/Criteria/CriteriaObject.cs`
- [Criteria operators](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Operators/Operator.cs): `src/Xomega.Framework/Operators/Operator.cs`
- [Typed properties](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataProperties/DataProperty.cs): `src/Xomega.Framework/DataProperties/DataProperty.cs`
- [Data objects](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataObjects/DataObject.cs): `src/Xomega.Framework/DataObjects/DataObject.cs`
- [Data rows](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataObjects/DataRow.cs): `src/Xomega.Framework/DataObjects/DataRow.cs`
- [Result lists](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/DataObjects/DataListObject.cs): `src/Xomega.Framework/DataObjects/DataListObject.cs`

### Services and APIs

- [Business services](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Services/BaseService.cs): `src/Xomega.Framework/Services/BaseService.cs`
- [Service output](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Services/Output.cs): `src/Xomega.Framework/Services/Output.cs`
- [REST client](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Client/RestApiClient.cs): `src/Xomega.Framework/Client/RestApiClient.cs`
- [REST controllers](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/BaseController.cs): `src/Xomega.Framework.AspNetCore/BaseController.cs`
- [WCF hosting](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Wcf/ServiceInstanceProvider.cs): `src/Xomega.Framework.Wcf/ServiceInstanceProvider.cs`
- [Lookup API](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/LookupTableController.cs): `src/Xomega.Framework.AspNetCore/LookupTableController.cs`
- [JWT authentication](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.AspNetCore/Security/JwtAuthController.cs): `src/Xomega.Framework.AspNetCore/Security/JwtAuthController.cs`

### Presentation logic

- [View models](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/ViewModel.cs): `src/Xomega.Framework/ViewModels/ViewModel.cs`
- [Search workflow](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/SearchViewModel.cs): `src/Xomega.Framework/ViewModels/SearchViewModel.cs`
- [Details workflow](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/ViewModels/DetailsViewModel.cs): `src/Xomega.Framework/ViewModels/DetailsViewModel.cs`

### UI adapters

- [WebForms views](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Web/Views/WebSearchView.cs): `src/Xomega.Framework.Web/Views/WebSearchView.cs`
- [Blazor views](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Blazor/Views/BlazorSearchView.cs): `src/Xomega.Framework.Blazor/Views/BlazorSearchView.cs`
- [WPF views](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework.Wpf/Views/WPFSearchView.cs): `src/Xomega.Framework.Wpf/Views/WPFSearchView.cs`
- [Syncfusion views](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Syncfusion.Blazor/Views/XSfSearchView.cs): `src/Xomega.Syncfusion.Blazor/Views/XSfSearchView.cs`

### Shared capabilities

- [Lookup caching](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Lookup/LookupCache.cs): `src/Xomega.Framework/Lookup/LookupCache.cs`
- [Error handling](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Errors/ErrorList.cs): `src/Xomega.Framework/Errors/ErrorList.cs`
- [Exception parsing](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Errors/ErrorParser.cs): `src/Xomega.Framework/Errors/ErrorParser.cs`
- [Principal provider](https://github.com/xomega-net/xomegaframework/blob/master/src/Xomega.Framework/Services/IPrincipalProvider.cs): `src/Xomega.Framework/Services/IPrincipalProvider.cs`

### Other components

- **App user**

## Connections

- App user → Search workflow: initiates search (evidence: `README.md`)
- Search workflow → View models: extends (evidence: `src/Xomega.Framework/ViewModels/SearchViewModel.cs`)
- Search workflow → Search criteria: sets criteria (evidence: `src/Xomega.Framework/ViewModels/SearchViewModel.cs`)
- Search workflow → Result lists: reads results (evidence: `src/Xomega.Framework/ViewModels/SearchViewModel.cs`)
- Result lists → Search criteria: applies criteria (evidence: `src/Xomega.Framework/DataObjects/DataListObject.cs`)
- Search criteria → Criteria operators: uses operators (evidence: `src/Xomega.Framework/Criteria/CriteriaObject.cs`)
- WebForms views → Search workflow: binds view model (evidence: `src/Xomega.Framework.Web/Views/WebSearchView.cs`)
- Blazor views → Search workflow: binds view model (evidence: `src/Xomega.Framework.Blazor/Views/BlazorSearchView.cs`)
- WPF views → Search workflow: binds view model (evidence: `src/Xomega.Framework.Wpf/Views/WPFSearchView.cs`)
- Syncfusion views → Blazor views: extends search view (evidence: `src/Xomega.Syncfusion.Blazor/Views/XSfSearchView.cs`)
- Business services → Criteria operators: uses criteria operators (evidence: `src/Xomega.Framework/Services/BaseService.cs`)
- REST controllers → Error handling: collects request errors (evidence: `src/Xomega.Framework.AspNetCore/BaseController.cs`)
- Lookup API → Lookup caching: reads and clears (evidence: `src/Xomega.Framework.AspNetCore/LookupTableController.cs`)
- Lookup API → Service output: returns lookup result (evidence: `src/Xomega.Framework.AspNetCore/LookupTableController.cs`)
- Lookup API → Error handling: reports missing table (evidence: `src/Xomega.Framework.AspNetCore/LookupTableController.cs`)
- Exception parsing → Error handling: builds error list (evidence: `src/Xomega.Framework/Errors/ErrorParser.cs`)
- WCF hosting → Principal provider: sets request principal (evidence: `src/Xomega.Framework.Wcf/ServiceInstanceProvider.cs`)
- App user → Details workflow: opens record (evidence: `README.md`)
- REST client → REST controllers: calls REST API (evidence: `README.md`)
- JWT authentication → REST client: supports API authentication (evidence: `README.md`)
- Data objects → Typed properties: contains typed fields (evidence: `src/Xomega.Framework/DataObjects/DataObject.cs`)
- Data rows → Typed properties: reads property values (evidence: `src/Xomega.Framework/DataObjects/DataRow.cs`)
- Business services → Service output: returns operation output (evidence: `README.md`)
