π OfficePrinterMapper.cs Documentation
π Table of Contents
- Overview & Purpose
- Architecture & Class Diagram
- Dependencies & Technologies
- Key Functional Areas
- View Models & Data Models
- Helper Methods & Utilities
- Error Handling & Return Types
- Sample Code Blocks & Usage Examples
- Mermaid UML Class Diagram
- Conclusion
1. Overview & Purpose π
The OfficePrinterMapper is part of the
IrbyImaging.Services namespace and implements the
IOfficePrinterMapper interface. Its main goal is to:
- Map between domain entities (
OfficePrinter,AssetHistory)
and View Models (OfficePrinterCreateViewModel,
OfficePrinterDetailViewModel, etc.). - Encapsulate the logic required for creating, reading, updating,
and viewing the history of Office Printer assets. - Simplify controllers by abstracting the transformation logic into
a reusable service.
This mapper is typically consumed by ASP.NET MVC or Razor Pages
controllers to prepare models for UI rendering or to transform UI
input back into domain entities for business logic.
2. Architecture & Class Diagram ποΈ
classDiagram
%% Interface and Implementation
IOfficePrinterMapper <|.. OfficePrinterMapper
%% Dependencies
OfficePrinterMapper : - IAssetManager _assetManager
%% Methods (grouped by CRUD+History)
OfficePrinterMapper : + GenerateOfficePrinterCreateViewModel()
OfficePrinterMapper : + CreateViewModelToOfficePrinter(vm)
OfficePrinterMapper : + GenerateOfficePrinterDetailViewModel(op)
OfficePrinterMapper : + GenerateOfficePrinterListViewModel(ops, st)
OfficePrinterMapper : + OfficePrinterToEditViewModel(op)
OfficePrinterMapper : + EditViewModelToOfficePrinter(vm)
OfficePrinterMapper : + GenerateOfficePrinterHistoryViewModel(h)
OfficePrinterMapper : + GenerateOfficePrinterHistoryListViewModel(hs)
%% Related Domain & VM classes
OfficePrinter --> "1" OfficePrinterCreateViewModel
OfficePrinter --> "1" OfficePrinterDetailViewModel
OfficePrinter --> "1" OfficePrinterEditViewModel
AssetHistory --> "1" HistoryViewModel
HistoryViewModel --> "1" OfficePrinter
%% Utility
OfficePrinterMapper ..> Helpers : uses
OfficePrinterMapper ..> JsonConvert : uses
3. Dependencies & Technologies βοΈ
| Dependency | Purpose |
|---|---|
| IrbyImaging.BusinessLogic.IAssetManager | Fetch asset models, field offices, etc. |
| IrbyImaging.DomainClasses | Domain entities: OfficePrinter, AssetHistory |
| IrbyImaging.Models | View Models: Create/Edit/Detail/List/History |
| IrbyImaging.Utility.Helpers | Utility to build SelectListItem collections (dropdowns) |
| Newtonsoft.Json | JSON (de)serialization of asset history |
| System.Linq, System, Generics | Core .NET libraries |
4. Key Functional Areas π
4.1. Create β¨
-
GenerateOfficePrinterCreateViewModel()
Prepares a blank create form:- Populates ModelList and OwnerList via
IAssetManager. - Sets PurchaseDate and ContractEndDate to Now.
- Populates ModelList and OwnerList via
-
CreateViewModelToOfficePrinter(viewModel)
Maps user input (VM) to domainOfficePrinter:- Assigns a new
Guidas Id. - Copies fields like SerialNumber, Status, ModelId, etc.
- Assigns a new
var createVm = mapper.GenerateOfficePrinterCreateViewModel();
// User fills in createVm via a form...
var domainEntity = mapper.CreateViewModelToOfficePrinter(createVm);
4.2. Read (Detail & List) π
-
GenerateOfficePrinterDetailViewModel(officePrinter)
Converts a singleOfficePrinterto a detail VM:- Builds
MakeAndModel(e.g., βHP LaserJetβ). - Determines a CSS StatusColor based on
AssetStatus.
- Builds
-
GenerateOfficePrinterListViewModel(officePrinters, status)
Filters and transforms a collection of domain entities into a list VM:- Optionally filters by AssetStatus.
- Invokes Detail mapping for each item.
// Retrieving all printers and showing only Active ones
var all = _assetManager.GetOfficePrinters();
var listVm = mapper.GenerateOfficePrinterListViewModel(all, AssetStatus.Active);
4.3. Update π
-
OfficePrinterToEditViewModel(officePrinter)
Builds an edit form VM populated with existing data:- Pre-selects ModelList and OwnerList.
- Copies current values for SerialNumber, Status, etc.
-
EditViewModelToOfficePrinter(viewModel)
Maps the edit VM back to anOfficePrinterdomain entity
(ready for business logic update).
var editVm = mapper.OfficePrinterToEditViewModel(existingPrinter);
// User updates editVmβ¦
var updatedPrinter = mapper.EditViewModelToOfficePrinter(editVm);
// _assetManager.UpdateOfficePrinter(updatedPrinter);
4.4. History π
-
GenerateOfficePrinterHistoryViewModel(history)
MapsAssetHistorytoHistoryViewModel:- Deserializes SomeAsset from JSON into
OfficePrinter. - Includes owner changes, who modified, timestamp, reason.
- Deserializes SomeAsset from JSON into
-
GenerateOfficePrinterHistoryListViewModel(assetHistories)
Builds a list of history entries for UI display.
var histories = _assetManager.GetHistoryFor(printerId);
var histListVm = mapper.GenerateOfficePrinterHistoryListViewModel(histories);
5. View Models & Data Models ποΈ
| View Model | Domain Entity | Purpose |
|---|---|---|
| OfficePrinterCreateViewModel | OfficePrinter | Capture fields for creation |
| OfficePrinterDetailViewModel | OfficePrinter | Show details in UI |
| OfficePrinterListViewModel | OfficePrinter | Paginate/filter a list |
| OfficePrinterEditViewModel | OfficePrinter | Prepopulate edit form |
| HistoryViewModel | AssetHistory | Single history record |
| HistoryListViewModel | AssetHistory | List of history records |
6. Helper Methods & Utilities π οΈ
-
Helpers.GenerateSelectListFor(β¦)
CreatesIEnumerable<SelectListItem>from any collection
β used to populate<select>dropdowns in Razor Views. -
JsonConvert.DeserializeObject(β¦)
Deserializeshistory.SerializedPropertiesback into anOfficePrinter.
7. Error Handling & Return Types π¨
-
No explicit exception handling in the mapper:
- Relies on upstream validation (controllers/services).
- If JSON is invalid during history mapping,
JsonConvertmay throw.
-
Return Types are always non-null VMs or domain objects.
- Methods follow a βmap-onlyβ approach with no
nullreturns.
- Methods follow a βmap-onlyβ approach with no
8. Sample Code Blocks & Usage Examples π―
8.1. Registering in ASP.NET Core DI
public void ConfigureServices(IServiceCollection services)
{
services.AddTransient<IAssetManager, AssetManager>();
services.AddTransient<IOfficePrinterMapper, OfficePrinterMapper>();
// ...
}
8.2. Consuming in a Controller
public class OfficePrinterController : Controller
{
private readonly IOfficePrinterMapper _mapper;
private readonly IAssetManager _assetManager;
public OfficePrinterController(
IOfficePrinterMapper mapper,
IAssetManager assetManager)
{
_mapper = mapper;
_assetManager = assetManager;
}
// GET: /OfficePrinter/Create
public IActionResult Create()
{
var vm = _mapper.GenerateOfficePrinterCreateViewModel();
return View(vm);
}
// POST: /OfficePrinter/Create
[HttpPost]
public IActionResult Create(OfficePrinterCreateViewModel vm)
{
if (!ModelState.IsValid) return View(vm);
var entity = _mapper.CreateViewModelToOfficePrinter(vm);
_assetManager.AddOfficePrinter(entity);
return RedirectToAction("Index");
}
// GET: /OfficePrinter/Details/{id}
public IActionResult Details(Guid id)
{
var entity = _assetManager.GetOfficePrinterById(id);
var vm = _mapper.GenerateOfficePrinterDetailViewModel(entity);
return View(vm);
}
}
9. Mermaid UML Class Diagram
classDiagram
class IOfficePrinterMapper {
+ OfficePrinterCreateViewModel GenerateOfficePrinterCreateViewModel()
+ OfficePrinter CreateViewModelToOfficePrinter(OfficePrinterCreateViewModel)
+ OfficePrinterDetailViewModel GenerateOfficePrinterDetailViewModel(OfficePrinter)
+ OfficePrinterListViewModel GenerateOfficePrinterListViewModel(IEnumerable~OfficePrinter~, AssetStatus)
+ OfficePrinterEditViewModel OfficePrinterToEditViewModel(OfficePrinter)
+ OfficePrinter EditViewModelToOfficePrinter(OfficePrinterEditViewModel)
+ HistoryViewModel GenerateOfficePrinterHistoryViewModel(AssetHistory)
+ HistoryListViewModel GenerateOfficePrinterHistoryListViewModel(IEnumerable~AssetHistory~)
}
class OfficePrinterMapper {
- IAssetManager _assetManager
+ GenerateOfficePrinterCreateViewModel()
+ CreateViewModelToOfficePrinter(vm)
+ GenerateOfficePrinterDetailViewModel(entity)
+ GenerateOfficePrinterListViewModel(entities, status)
+ OfficePrinterToEditViewModel(entity)
+ EditViewModelToOfficePrinter(vm)
+ GenerateOfficePrinterHistoryViewModel(history)
+ GenerateOfficePrinterHistoryListViewModel(histories)
}
IOfficePrinterMapper <|.. OfficePrinterMapper
OfficePrinterMapper ..> IAssetManager : constructor
OfficePrinterMapper ..> Helpers : GenerateSelectListFor
OfficePrinterMapper ..> JsonConvert : DeserializeObject
10. Conclusion π
OfficePrinterMappercentralizes all mapping concerns between
domain entities and UIβfacing view models for Office Printers.- By abstracting this logic, controllers remain thin and
focused on HTTP concerns. - This mapping layer supports Create, Read, Update, and
History functionalities, ensuring a consistent contract between
the UI and the underlying business logic.
Feel free to integrate this mapper in your ASP.NET Core pipeline,
and let it handle the gritty details of transforming data for your
Office Printer UIs! π