QuickStart2Modeling

Quick start 2. Modeling

First thing, we add new XML file to "Model" project and save it as QuickStart.Project.xml.

Next, we add GenieLamp XML schemas for easy XML editing (they are in "D:\Projects\GenieLamp\Bin\Release\XMLSchema"). Select menu XML -- Schemas...

Now we write our GL project configuration. Assume we have SQL Server persistence layer and NHibernate domain layer (services layer will be added later). So we add SQLServer and NHibernate genies and corresponding layers configuration.

<?xml version="1.0" encoding="utf-8"?>
<GenieLamp xmlns="http://www.arbinada.com/GenieLamp/1/0"
           project="QuickStart"
           version="1.0">

    <ImportModel fileName="QuickStart.xml" />

    <Genie  name="SqlServer"
            type="GenieLamp.Genies.SqlServer.SqlServerGenie"
            assembly="GenieLamp.Genies.SqlServer"
            active="true"
            outDir="%PROJECT_DIR%/../SQL/SqlServer-%TARGET_VERSION%"
            outFileName="%PROJECT_NAME%.sql"
            updateDatabase="true"
            targetVersion="2008">
        <Param name="Database.Create" value="true" />
        <Param name="Database.Name" value="QuickStartDB" />
        <Param name="Schemas.Create" value="false" />
        <Param name="UpdateDatabase.Utility" value="sqlcmd" />
        <Param name="UpdateDatabase.Arguments" value="-b -S localhost -i %FILE_NAME%" />
    </Genie>

    <Genie name="NHibernate"
           type="GenieLamp.Genies.NHibernate.NHibernateGenie"
           assembly="GenieLamp.Genies.NHibernate"
           active="true"
           outDir="%PROJECT_DIR%/../Domain"
           outFileName="%PROJECT_NAME%.Domain.cs"
           targetVersion="*">
        <Param name="TargetAssemblyName" value="Domain" />
    </Genie>

    <Configuration>
        <!-- Layers configurations -->
        <Layer name="Persistence">
            <NamingConvention style="uppercase" maxLength="128">
                <Param name="PrimaryKey.ColumnTemplate" value="ID_%TABLE%" />
                <Param name="PrimaryKey.ConstraintTemplate" value="PK_%TABLE%" />
                <Param name="Unique.ConstraintTemplate" value="UC_%TABLE%_%COLUMNS%%COUNTER%" />
                <Param name="ForeignKey.ColumnTemplate" value="ID_%REF_TABLE%" />
                <Param name="ForeignKey.ConstraintTemplate" value="FK_%TABLE%_%REF_TABLE%_%COLUMNS%_%COLUMNS_HASH%" />
                <Param name="Index.Template" value="IX_%TABLE%_%COLUMNS%_%COLUMNS_HASH%" />
            </NamingConvention>
            <Param name="ForeignKey.CreateIndex" value="true" />
        </Layer>

        <Layer name="Domain">
            <Param name="BaseNamespace" value="GenieLamp.Examples.%PROJECT_NAME%" />
        </Layer>
    </Configuration>
</GenieLamp>

Now we add the model as new file "QuickStart.xml".

<?xml version="1.0" encoding="utf-8"?>
<Model xmlns="http://www.arbinada.com/GenieLampModel/1/0"
       defaultPersistentSchema="dbo"
       defaultSchema="QuickStart">

    <Type name="TEntityId" baseType="int" />
    <Type name="TCaption" baseType="string" length="100" />

    <Entity name="Customer">
        <Attribute name="Id" type="TEntityId" autoincrement="true" primaryid="true" />
        <Attribute name="Code" type="string" length="10" uniqueid="true" />
        <Attribute name="Name" type="TCaption" />
        <Attribute name="Phone" type="string" length="40" required="false" />
        <Attribute name="Email" type="string" length="255" required="false" />
    </Entity>

    <Entity name="Product">
        <Attribute name="Id" type="TEntityId" autoincrement="true" primaryid="true" />
        <Attribute name="Reference" type="string" length="10" uniqueid="true" />
        <Attribute name="Name" type="TCaption" />
    </Entity>

    <Entity name="PurchaseOrder">
        <Attribute name="Id" type="TEntityId" autoincrement="true" primaryid="true" />
        <Attribute name="Number" type="string" length="15" uniqueid="true" />
        <Attribute name="IssueDate" type="date" />
        <Attribute name="CustomerId" type="TEntityId" />
        <Attribute name="Validated" type="boolean" default="false" />
        <Attribute name="ShipmentDate" type="date" required="false" />
    </Entity>

    <Relation entity="Customer" name="Orders" 
              entity2="PurchaseOrder" name2="Customer" 
              cardinality="1:M">
        <AttributeMatch attribute="Id" attribute2="CustomerId"/>
    </Relation>

    <Entity name="PurchaseOrderLine">
        <Attribute name="Id" type="TEntityId" autoincrement="true" primaryid="true" />
        <UniqueId>
            <Attribute name="PurchaseOrderId" type="TEntityId" />
            <Attribute name="Position" type="smallint" />
        </UniqueId>
        <Attribute name="ProductId" type="TEntityId" />
        <Attribute name="Price" type="currency" />
        <Attribute name="Quantity" type="int" />
    </Entity>

    <Relation entity="PurchaseOrderLine" name="PurchaseOrder" 
              entity2="PurchaseOrder" name2="Lines" 
              cardinality="M:1">
        <AttributeMatch attribute="PurchaseOrderId" attribute2="Id"/>
    </Relation>

    <Relation entity="PurchaseOrderLine" name="Product" 
              entity2="Product" navigate2="false" 
              cardinality="M:1">
        <AttributeMatch attribute="ProductId" attribute2="Id"/>
    </Relation>
</Model>