Overview

QCADOO MES system uses Entity.

The Model , which is an in-memory cache of data retrieved from Java Bean or coresonded view, is the major component of the data access architecture. The Model View consists of a collection of Entity objects (related to one another) to specify properities of each field. Entiety can be connected to a method (called hook) started under specified condition e.g. OnSave started after calling save method for an entity. Model is built after reading data to Java Bean.

You can also enforce data integrity by using validators.

back to top

Structure

All model entites used by system are defined in XML files. Every plugin has one directory model which contains xml files with definition of entities used by this plugin.

<model name="sampleModel"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://schema.qcadoo.org/model"
    xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">

    <fields>

        // HERE YOU PUT FIELD DEFINITIONS

    </fields>

    <hooks>

        // HERE YOU PUT HOOK DEFINITIONS

    </hooks>

    // HERE YOU PUT IDENTIFIER

</model>

Where:

- name - is a name of defined entity, it must be unique within the plugin scope

Structure of field definition

<fieldType options />

or

<fieldType options>

    // HERE YOU PUT VALIDATORS

</fieldType>

Where:

- fieldType - is a type of field
- options - options of field

Field types

BelongsTo Field — belongsTo - many-to-one relation.
Boolean field — boolean - true/false value.
Date field — date - date.
Datetime field — datetime - date with time.
Decimal field — decimal - decimal number.
Dictionary Field — dictionary - value from dictionary.
Enum Field — enum - predefined value.
HasMany Field — hasMany - one-to-many relation.
Integer field — integer - integer number.
ManyToMany Field — manyToMany - many-to-many relation.
Password Field — password - password.
Priority Field — priority - priority.
String field — string - short text.
Text field — text - long text.
Tree Field — tree - tree-structured one-to-many relation.

Structure of validator definition

Validators are attached to fields.

<validatorType validatorOptions />

Where:

- validatorType - type of validator

- validatorOptions - options of validator

Validator types

Entity identifier

Role of entity identifier is to convert entity defined in model to a simple text (see expressions overview). It is used for example when showing operation messages.

If not defined, system will use field 'number' of defined entity.

<identifierExpression value="#number + ' - ' + #name"/>

Structure of hook definition

You can create custom event hook and attach it to defined model. To do it first you must create custom method (see this link).

<eventName class="className" method="methodName" />

Where:

- eventName - name of event (see below)

- className - definies path and name to object with your custom method

- methodName - definies custom method name

Hook types

OnCopy Hook — onCopy - fired before copy.
OnCreate Hook — onCreate - fired before create.
OnDelete Hook — onDelete - fired before delete.
OnSave Hook — onSave - fired before save.
OnUpdate Hook — onUpdate - fired before update.
OnView Hook — onView - fired during loading entity from database.
ValidatesWith Hook — validatesWith - fired to validate entity or field.

Examples

These examples definies three simple entities.

<?xml version="1.0" encoding="UTF-8"?>
<model name="product" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://schema.qcadoo.org/model"
   xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
   
   <fields>
      <string name="number" required="true" unique="true">
         <validatesLength max="40" />
      </string>
      <string name="name" required="true" />
      <enum name="typeOfMaterial" values="01component,02intermediate,03product,04waste" required="true" />
      <string name="ean" />
      <dictionary name="category" dictionary="categories" />
      <dictionary name="unit" dictionary="units" required="true" />
      <string name="batch">
          <validatesLength max="255" />
      </string>
      <string name="lastUsedBatch">
          <validatesLength max="255" />
      </string>
      <boolean name="genealogyBatchReq" />
      <hasMany name="substitutes" model="substitute" joinField="product" cascade="delete" copyable="true" />
      <hasMany name="technologies" model="technology" joinField="product" />
      <hasMany name="orders" model="order" joinField="product" />
      <hasMany name="operationProductInComponents" model="operationProductInComponent" joinField="product" />
      <hasMany name="operationProductOutComponents" model="operationProductOutComponent" joinField="product" />
      <hasMany name="substituteComponents" model="substituteComponent" joinField="product" />
    </fields>

    <hooks />

    <identifier expression="#number + ' - ' + #name"/>

</model>

<?xml version="1.0" encoding="UTF-8"?>
<model name="substitute" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://schema.qcadoo.org/model"
    xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
    
    <fields>
        <string name="number" required="true" unique="true">
            <validatesLength max="40" />
        </string>
        <string name="name" required="true" />
        <belongsTo name="product" model="product" lazy="false" required="true" />
        <hasMany name="components" model="substituteComponent" joinField="substitute" cascade="delete" copyable="true" />
        <priority name="priority" scope="product" />
    </fields>

    <hooks>
        <validatesWith class="com.qcadoo.mes.products.ProductService" method="checkIfProductIsNotRemoved" />
    </hooks>

    <identifier expression="#number + ' - ' + #name" />

</model>

<?xml version="1.0" encoding="UTF-8"?>
<model name="substituteComponent" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://schema.qcadoo.org/model"
    xsi:schemaLocation="http://schema.qcadoo.org/model http://schema.qcadoo.org/model.xsd">
	
    <fields>
        <belongsTo name="product" model="product" lookupField="name" required="true" />
        <belongsTo name="substitute" model="substitute" required="true" />
        <decimal name="quantity" required="true">
            <validatesRange from="0" exclusively="true" />
            <validatesPrecision max="7" />
            <validatesScale max="3" />
        </decimal>
    </fields>
	
    <hooks>
        <validatesWith class="com.qcadoo.mes.products.ProductService" method="checkIfSubstituteIsNotRemoved" />
        <validatesWith class="com.qcadoo.mes.products.ProductService" method="checkSubstituteComponentUniqueness" />
    </hooks>

    <identifier expression="#product['number'] + ' - ' + #product['name']"/>
	
</model>

Model Definition Overview

Overview

Structure

Structure of field definition

Field types

Structure of validator definition

Validator types

Entity identifier

Structure of hook definition

Hook types

Examples