Skip to content

Rename SubjectEntity to Ad4mModel and adjust decorator names#579

Merged
jhweir merged 16 commits intodevfrom
ad4m-model-renaming
Mar 21, 2025
Merged

Rename SubjectEntity to Ad4mModel and adjust decorator names#579
jhweir merged 16 commits intodevfrom
ad4m-model-renaming

Conversation

@lucksus
Copy link
Copy Markdown
Member

@lucksus lucksus commented Mar 20, 2025

Rename SubjectEntity to Ad4mModel and Update Decorator Names

Overview

This PR renames the SubjectEntity class to Ad4mModel and updates related decorator names to use more intuitive and consistent terminology. These changes aim to make the codebase more approachable and better reflect the actual concepts being represented.

Key Changes

Class Renaming

  • Renamed SubjectEntity to Ad4mModel to better represent its role as the base class for data models in AD4M
  • Updated all references and imports across the codebase
  • Renamed SubjectQueryBuilder to ModelQueryBuilder for consistency

Decorator Updates

  • @SubjectProperty@Property
  • @SubjectOptional@Optional
  • @SubjectReadOnly@ReadOnly
  • @SubjectCollection@Collection
  • @SubjectFlag@Flag
  • @SubjectOptions@ModelOptions

Documentation Improvements

  • Updated class and method documentation to use the new terminology
  • Added comprehensive examples showing proper usage of decorators
  • Improved descriptions of how models interact with perspectives and links
  • Added detailed examples of querying and real-time subscriptions
  • Enhanced documentation around model lifecycle (creation, updates, deletion)

@lucksus lucksus changed the base branch from dev to Ad4mModel-updates March 20, 2025 23:26
@lucksus lucksus changed the base branch from Ad4mModel-updates to dev March 21, 2025 14:30
@lucksus lucksus marked this pull request as ready for review March 21, 2025 14:31
@jhweir jhweir merged commit 7474aaa into dev Mar 21, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants