bx-orm-entity-mapping

Generate Hibernate HBM XML mapping files from BoxLang ORM entity annotations.

2|Updated Apr 11, 2024
One-click install
npx skills add https://github.com/ortus-boxlang/bx-orm --skill bx-orm-entity-mapping
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bx-orm-entity-mapping
Source: https://github.com/ortus-boxlang/bx-orm/tree/main/.agents/skills-custom/bx-orm-entity-mapping
Command: npx skills add https://github.com/ortus-boxlang/bx-orm --skill bx-orm-entity-mapping

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill resolves the complexity of mapping BoxLang persistent classes to Hibernate HBM XML files, ensuring that entity metadata is correctly parsed, validated, and transformed for the ORM layer.

Core Features & Use Cases

  • Automated Entity Discovery: Scans directories for .bx and .cfc files and compiles them into structured EntityRecords.
  • Metadata Normalization: Translates diverse CFML annotations into a unified IEntityMeta contract for consistent Hibernate configuration.
  • Use Case: When developing a new module, use this Skill to automatically generate the necessary Hibernate mapping XML files from your entity annotations, ensuring your database schema and object model remain perfectly synchronized.

Quick Start

Use the bx-orm-entity-mapping skill to scan the models directory and generate the required Hibernate XML mapping files for all discovered entities.

Frequently Asked Questions about bx-orm-entity-mapping

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Hibernate HBM XML files from BoxLang entities?

You can generate Hibernate HBM XML files by scanning directories for .bx and .cfc persistent classes. The Skill parses class metadata and applies Hibernate configuration standards to automatically produce the required mapping files.

What is ORM entity metadata normalization for Hibernate configuration?

ORM entity metadata normalization translates diverse CFML annotations into a unified IEntityMeta contract. This ensures consistent Hibernate configuration by validating and transforming the parsed metadata for the underlying ORM layer.

Can I process large datasets of ORM entities asynchronously?

Yes, you can process large datasets of ORM entities asynchronously. The Skill supports asynchronous processing to handle complex entity scanning and normalized metadata inspection efficiently without blocking execution.

Does this ORM mapping tool support legacy CFML annotation styles?

Yes, the ORM mapping tool supports both legacy and modern CFML annotation styles. It normalizes these diverse annotations into a unified metadata contract to ensure correct Hibernate SessionFactory integration.

Why do I need to map persistent classes to Hibernate XML?

Mapping persistent classes to Hibernate XML resolves the complexity of manually aligning your object model with the database schema. It ensures BoxLang entity metadata is correctly parsed and transformed for the ORM layer.

How do I discover all .bx and .cfc entities in my project directory?

You can discover all entities by scanning your project directories for .bx and .cfc files. The Skill compiles these discovered persistent classes into structured EntityRecords for automated Hibernate mapping generation.