Voir la source de Guide de Référence de DfgUml

{{IntroductionDFG}}
{{parW|
{{Modèle:EnConstruction}}
}}
[[Catégorie:dfg1RefManual]]
== Notations et abréviations ==
{{:Les paragraphes tagués et/ou numérotés - bases}}
{{:Les paragraphes tagués et/ou numérotés - généraux}}
{{:Les paragraphes tagués et/ou numérotés - d'informatique}}

== Les prérequis pour lire ce document ==
{{proj_p|Le meta-modèle utilise le langage {{m|XML}} ([http://www.w3schools.com/xml/ Lien vers un tutoriel sur XML]).}}
{{proj_p|Au dessus du langage XML le méta-modèle décrit des diagrammes de classes du langage {{m|UML}} ([http://www.sparxsystems.com/uml-tutorial.html Lien vers un tutoriel sur UML]).}}
{{proj_p|Il faut donc connaître les langages {{m|XML}} et {{m|UML}} pour lire ce document.}}

== Le langage XML == 
{{proj_p|Même si la connaissance du langage XML est un prérequis pour lire ce document, il est utile de rappeler ici quelques notions. Le but étant de préciser le vocabulaire et les notations que nous utiliserons dans la suite.}}
{{proj_p|La langage XML permet de définir des langages et ce pourquoi il est un métalangage. Ces langages permettent de créer des documents au format texte structurés à l'aide de {{m|balises}}({{m|tags}}). 
}}
=== Balise ouvrante ===
{{Def
|1=
Une balise dite ouvrante est un texte commençant le symbole {{m|<}}(plus petit), suivi du nom de balise puis des attributs de la balise. Elle se termine par le symbole {{m|>}}(plus grand). 

Les attributs suivent la syntaxe suivante :
{{code|lang=xml|code=attributeName2="AttributeValue2"}}
par exemple :
{{code|lang=xml|code=color="green"}}
Et la structure générale d'une balise ouvrante est :
{{code|lang=xml|code=
<baliseName attributeName1="AttributeValue1"  
            attributeName2="AttributeValue2" 
            … 
            attributeNamen="AttributeValuen">
}}
|2=|3=balise ouvrante}}
{{Ex|1={{code|lang=xml|code=<city name="Paris">}}|2=|3=}}

=== Balise fermante ===
{{Def
|1=
Une balise dite fermante est un texte commençant le symbole {{m|<}}, puis {{m|/}}, suivi du nom de balise et se terminant par le symbole {{m|>}}(plus grand).
<source lang="xml"></baliseName></source>
|2=
|3=balise fermante}}
{{Ex|1=<source lang="xml"></city></source>|2=|3=}}

=== Balise ouvrante et fermante ===
{{Def
|1=Une balise ouvrante et fermante est une balise ouvrante qui ne se termine pas par {{m|>}} mais par {{m|/>}}.
<source lang="xml">
<baliseName attributeName1="AttributeValue1"  attributeName2="AttributeValue2" … attributeNamen="AttributeValuen"/>
</source>
|2=
|3=balise ouvrante et fermante}}
{{Ex|1=<source lang="xml"><city name="Paris"/></source>|2=|3=}}

=== Nœud ===
{{Def|Un nœud XML est l'ensemble du texte commençant par une balise ouvrante et se terminant par la balise correspondante fermante. Le nom du nœud est le nom de la balise correspondante
|Nœud XML|Nœud XML}}
{{Ex|1=Un nœud XML appelé city : <source lang="xml"><city id="AR32"> <name>Paris</name> … </city></source>|2=|3=}}
{{Def|L'en-tête d'un nœud est l'ensemble des attributs de la balise.
|En-tête de nœud|En-tête de nœud}}
{{Def|Le corps d'un nœud est la partie du texte qui se trouve entre la balise ouvrante et la balise fermante correspondante.
|Corps de nœud|Corps de nœud}}
{{Rq|Le corps d'un nœud où la balise est ouvrante et fermante possède un corps vide.}}
{{Rq|Le corps de nœud peut aussi contenir d'autres nœuds. L'en-tête et le corps d'un nœud définissent sa structure. Cette  structure est arborescente. }}
{{Ex|1=<source lang="xml">    <russian_doll name="Galina">
        <russian_doll name=" Anastasiya">
            <russian_doll name=" Marta"/>
        </russian_doll>
    </russian_doll>
</source>|2=|3=Les poupées russes}}
{{Rq|Dans certains cas un élément d'un nœud peut se mettre sous la forme d'un attribut ou sous la forme d'un nœud. Cela peut être le cas par exemple pour nommer un nœud.}}
{{Ex|1=<source lang="xml"><city name="Paris"> … </city></source> ou <source lang="xml"><city> <name>Paris</name> … </city></source>|2=|3=}}

== Le modèle vide ==
{{proj_p|Le modèle minimal de Data Flow Generator est donné par l'exemple {{clink|empty_model_ref}}
}}
{{ex|
<source lang="xml">
<?xml version="1.0" encoding="UTF8"?>
<grammar type="xml" version="2.0.0" fileFormatVersion="1.0.0">
</grammar>
</source>|empty_model_ref}}
{{proj_p|Ce modèle est composé de deux éléments XML; {{m|?xml}}{{clink|par_xml_ref}} et {{m|grammar}}{{clink|par_grammar_ref}}.}} 
{{proj_p|Le document DfgUml doit comporter un unique nœud racine nommé {{m|grammar}}{{clink|par_grammar_ref}}.}}
{{proj_p|Le diagramme de classes de ce modèle est le diagramme vide.}}

== Le modèle minimal ==
{{proj_p|Tout modèle doit définir un unique nœud racine à l'aide du nœud nommé {{m|clDefInst}}.}} 
{{proj_p|Dans les exemples {{clink|dfguml_minimal_model}} et {{clink|dfg_ex_minimal}}, qui illustrent le modèle minimal, la racine a pour nom «model» et nous avons nommé sa classe «CModel».}}
{{ex|
<source lang="xml">
<?xml version="1.0" encoding="UTF8"?>
<grammar type="xml" version="2.0.0" fileFormatVersion="1.0.0">
    <clDefInst type='CModel' name="model" >
    </clDefInst>
</grammar> 
</source>
|dfguml_minimal_model}}
{{figuml|UML diagramme équivalent|class CModel {
}
|dfg_ex_minimal}}

== Les nœuds, associations et héritages du méta-modèle ==
=== Liste des nœuds ===
{{proj_p|Pour commencer nous donnons seulement la liste des nœuds utilisés dans le méta-modèle, chaque nœud sera plus loin étudié de près : {{m|bool}}, {{m|int}}, {{m|flt}}, {{m|str}}, {{m|date}}, {{m|clDefInst}}, {{m|clInst}}, {{m|clRef}}, {{m|clDef}}, {{m|method}}, {{m|arg}}. Les types primitives sont {{m|bool}} (booléen), {{m|int}}(entier), {{m|flt}}(réel), {{m|str}}(chaîne de caractères), {{m|date}}(date).}}

=== Association entre classes ===
{{proj_p|L'association entre classes est définie par l'inclusion d'un nœud (enfant) dans un autre nœud (parent). Côté parent la cardinalité est toujours {{m|1}} et côté enfant l'attribut {{m|card}} permet de le définir avec la convention suivante :

Soient n, n1, n2 des entiers
{{tab|Notation de cardinalité|| 
{{line| {{col_t|notation dans les doubles quottes}} {{col_t|description}} }} 
{{line| {{col|"n1:n2"}} {{col|de n1 à n2}} }} 
{{line| {{col|"?" or "0:1"}} {{col|de 0 à 1, optionnel}} }} 
{{line| {{col|"*" or "0:*"}} {{col|de 0 à l'infini}} }} 
{{line| {{col|"+" or "1:*"}} {{col|de 1 à l'infini}} }} 
{{line| {{col|"n:" or "n:*"}} {{col|de n à l'infini}} }} 
{{line| {{col|"n" or "n:n"}} {{col|de n à n, exactement n}} }} 
{{line| {{col|si non présent}} {{col|valeur de défaut : exactement 1 }} }} 
}}
}}
{{Ex|Voici un exemple d'associations entre la classe A et les classes B,C,D,E,F,G.
<source lang="xml">
<?xml version="1.0" encoding="UTF8"?>
<grammar type="xml" version="2.0.0" fileFormatVersion="1.0.0">
    <clDefInst type='A' name="a" >
        <clDefInst type='B' name="b"/>
        <clDefInst type='C' name="c" card="4"/>
        <clDefInst type='D' name="d" card="?"/>
        <clDefInst type='E' name="e" card="*"/>
        <clDefInst type='F' name="f" card="+"/>
        <clDefInst type='G' name="g" card="3:45"/>
    </clDefInst>
</grammar>
</source>
Le diagramme UML équivalent est le suivant :
{{figuml|Association|
class A {
}
A  *-- "1" B : b
class B {
}
A  *-- "4" C : c
class C {
}
A  *-- "0..1" D : d
class D {
}
A  *-- "0..*" E : e
class E {
}
A  *-- "1..*" F : f
class F {
}
A  *-- "3..45" G : g
class G {
}
}}
Et une instance persitante possible de ce modèle utilisant le format XML peut être le fichier suivant :
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<grammar driverName="DataFlowGenerator_XML_DOM_MINIDOOM" driverVersion="1.0.0" fileFormatVersion="1.0.0" type="xml" version="2.0.0">
    <a>
        <b/>
        <c/>
        <c/>
        <c/>
        <c/>
        <f/>
        <g/>
        <g/>
        <g/>
    </a>
</grammar>
</source>
}}

=== Héritage ===
{{Ex|Prenons le cas d'une classe CRoot qui est associée (agrégation) à un classe C qui hérite de la classe B qui hérite de la classe A. Ce cas est décrit par diagramme {{clink|Héritage simple}}.
{{figuml|Héritage simple|class CRoot {
}
abstract class A {
}
A : CInt a
abstract class B {
}
B --{{!}}> A
B : CInt b
CRoot  *-- "3" C : c
class C {
}
C --{{!}}> B
C : CInt c
|Héritage simple}}
L'équivalent en modèle DFGUML sécrira :
<source lang="xml">
<?xml version="1.0" encoding="UTF8"?>
<grammar type="xml" version="2.0.0" fileFormatVersion="1.0.0">
    <clDefInst type='CRoot' name="root" >
        <clDef type='A' name="a">
            <int name="a" defVal="1"/>
        </clDef>
        <clDef type='B' name="b" her="A">
            <int name="b"  defVal="2"/>
        </clDef>
        <clDefInst type='C' name="c" her="B" card="3">
            <int name="c"  defVal="3"/>
        </clDefInst>
    </clDefInst>
</grammar>
</source>
Et une instance possible de ce modèle est la suivante :
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<grammar driverName="DataFlowGenerator_XML_DOM_MINIDOOM" driverVersion="1.0.0" fileFormatVersion="1.0.0" type="xml" version="2.0.0">
    <root>
        <c>
            <a>1</a>
            <b>2</b>
            <c>3</c>
        </c>
        <c>
            <a>1</a>
            <b>2</b>
            <c>3</c>
        </c>
        <c>
            <a>1</a>
            <b>2</b>
            <c>3</c>
        </c>
    </root>
</grammar>
</source>
}}
{{proj_p|L'héritage est définie avec l'attribut {{m|her}} dont la valeur est la classe parente. Afin de ne pas associer une définition de classe, qui est un nœud donné avec la classe parent qui lui-même est le nœud parent associé on utilise la balise {{m|clDef}} comme c'est le cas des classes A et B dans notre cas précédent.}}

== Les éléments ==


=== {{fr§en|Le nœud «?xml»|The «?xml» node}} ===
{{:dfg1 reference manual - xml - dfguml}}
{{ex|  
<source lang="xml">
<?xml version="1.0" encoding="UTF8"?>
<grammar  type="xml" version="2.0.0" fileFormatVersion="1.0.0"> 
    <clDefInst name="root" type="CRoot">
    </clDefInst>
</grammar>
</source>   
|dfgumlr_xml
}}
{{:dfg1 reference manual - xml - plantuml}}  
{{figuml
|
|class CRoot {
}
@enduml
|plantumlr_xml}}

=== {{fr§en|L'attribut «version» du nœud «?xml»|The attribute named «version» of the «?xml» node| -◊- }} ===
{{:dfg1 reference manual - xmlVersion - dfguml}}

=== {{fr§en|L'attribut «encoding» du nœud «?xml»|The attribute named «encoding» of the «?xml» node| -◊- }} ===
{{:dfg1 reference manual - xmlEncoding - dfguml}}

=== {{fr§en|Le nœud «grammar»|The «grammar» node}} ===
{{:dfg1 reference manual - grammar - dfguml}}
{{ex|  
<source lang="xml">
<?xml version="1.0" encoding="UTF8"?>
<grammar driverName="DataFlowGenerator_XML_DOM_MINIDOOM" driverVersion="1.0.0" fileFormatVersion="1.0.0" type="xml" version="2.0.0"> 
    <clDefInst name="root" type="CRoot">
    </clDefInst>
</grammar>
</source>   
|dfgumlr_grammar
}}

== Annexe ==
=== Description du mét-modèle par lui-même ===
{{parW|1=
{{code|lang=xml|code=
<dfg dfgDrvName="DataFlowGenerator_XML_DOM_MINIDOOM" dfgDrvVer="3.0.0" dfgModelVer="3.0.0" dfgMetaModelVer="3.0.0" type="CDfg">
    <!--
    the root node must have the following attributes :
    dfgDrvName      (driver_name) example  dfgDrvName="DataFlowGenerator_XML_DOM_MINIDOOM"
    dfgDrvVer       (driverVersion) example  dfgDrvVer="1.0.0"
    dfgModelVer     (fileformatVersion)
    dfgMetaModelVer (grammarVersion)

    those attributes are herited from a base root node.
    -->
    <clDef type="CEl">
        <str name="help"  card="?" isAttr="True"  />
        <str name="shortHelp" card="?" />
        <str name="longHelp" card="?" />
    </clDef>
    <clDef type="CAss">
        <str name="name" help="python_re_pattern='^[a-zA-Z_][a-zA-Z0-9_]*$'" isAttr="True" />
        <str name="card" card="?" isAttr="True" />
    </clDef>
    <clDef type="CLeave" her="CEl:CAss" >
        <str name="defVal"  card="?" isAttr="True" />
        <str name="admVals" card="?" isAttr="True" />
        <bool name="isAttr"  card="?" isAttr="True" />
    </clDef>
    <clDef type="CScalarLeave" her="CLeave">
        <str name="unit" card="?" isAttr="True" />
    </clDef>
    <clDef type="CClBase" her="CEl" >
        <str name="type" isAttr="True" />
        <str name="accept" card="?" isAttr="True" />
        
        <!-- added by dfg <str name="dfgId" card="?" isAttr="True" help="in order to be linked"/> -->
        <!-- added by dfg <str name="dfgClName" card="?" isAttr="True" help="in order to set polymorphism class type associated with 'accept'"/> -->
        <!-- Experimental 
        <str name="dfgClConstructor" card="?" isAttr="True" help="in order to set polymorphism class type"/>
        -->
    </clDef>
    <clDef type="CClass" her="CClBase" >
        <str name="her"    card="?" isAttr="True" />
        
        <clDefInst name="str"    type="CStr"    her="CLeave"       card="*"/>
        <clDefInst name="int"    type="CInt"    her="CScalarLeave" card="*"/>
        <clDefInst name="bool"   type="CBool"   her="CLeave" card="*"/>
        <clDefInst name="date"   type="CDate"   her="CLeave" card="*"/>
        <clDefInst name="flt"    type="CFlt"    her="CScalarLeave" card="*"/>
        
        <clDefInst name="clDef"  type="CClDef"  her="CClass"       card="*"/>
        <clDefInst name="clInst"  type="CClInst"  her="CClBase:CAss" card="*"/>
        <clDefInst name="clDefInst" type="CClDefInst" her="CClDef:CAss"  card="*"/>
        <clDefInst name="clRef"  type="CClRef"    her="CClBase:CAss" card="*"/>
        
        <!-- new start -->
        <clDefInst name="map"  type="CMap"  her="CEl:CAss" card="*">
        <!--
	  
	model :  
        <clDef type="CAgent">
              <str name="name"  card="?" />
              <int name="age"  card="?" />
        </clDef>        
        <map name="agent" keyType="str" valType='CAgent'/>
	  
	instance :  
        -->
                <str name="valType" isAttr="True" />
                <str name="keyType" isAttr="True" />
        </clDefInst>
        <!-- new end -->    
        
        <!-- Experimental 
        
        <clDefInst name="constructor" type="CConstructor" card="*">
            <str name="name" isAttr="True" />
            <clInst name="args" type="CClass" card="*"/>
        </clDefInst>
        
        <!- - ************************************** - ->
        <!- - model - ->
        <clDef type="CMateriau">
              <int name="protegee"  card="?" />
              <int name="densite"  card="?" />
        </clDef>

        <map name= "myDico" keyType="int" valType="CMateriau"/>
        <!- - ************************************** - ->                                    
        <!- - instance - ->
        <myDico key="512">
            <!- - <materieau> no need because we know the type - ->
            <protegee>1</protegee>
            <densite>1.3</densite>
            <!- - </materieau> - ->
        </myDico>
        <!- - ************************************** - ->        
        -->
        <clDefInst name="method" type="CMethod" card="*">
            <str name="name" isAttr="True" />
            <clDefInst name="arg" type="CArg" card="*">
                <str name="type" isAttr="True" help="python_re_pattern='^[a-zA-Z_][a-zA-Z0-9_]*$'"/>
                <str name="dir"  isAttr="True" admVals="in:out:inout"/>
                <str name="name" isAttr="True" />
                <str name="unit" isAttr="True" card="?"/>
            </clDefInst>
        </clDefInst>
    </clDef>
    <clDefInst name="dfg" type="CDfg" her="CClass" >
        <!-- added by dfg <str name="dfgVer"              isAttr="True" defVal="2.0.0"/> -->
        <!-- added by dfg <str name="dfgModelVer"          isAttr="True" defVal="1.0.0"/> -->
        <!-- added by dfg <str name="dfgDrvName" card="?" isAttr="True"  defVal="dfgPyXmlMiniDom"/> -->
        <!-- added by dfg <str name="dfgDrvVer"  card="?" isAttr="True" defVal="1.0.0"/> -->
                
        <!-- Experimental  
        <clDefInst name="primTypeAlias"  type="CPrimTypeAlias"  card="*">
            <str name="name" isAttr="True" />
            <str name="primTypeName" isAttr="True" />  
        </clDefInst>
        <clDefInst name="enum"  type="CEnum"  card="*">
            <str name="typeName" isAttr="True" />
            <str name="val" card="*"/>  
        </clDefInst>
        -->        
    </clDefInst>
</dfg>
}}
Sous forme texte:
{{code|lang=text|code=
   CEl 
.   ? help : CStr
.   ? longHelp : CStr
.   ? shortHelp : CStr
   CAss 
.   ? card : CStr
.     name : CStr
   CLeave  (CEl,CAss,)
.   ? admVals : CStr
.   ? defVal : CStr
.   ? isAttr : CBool
   CScalarLeave  (CLeave,)
.   ? unit : CStr
   CClBase  (CEl,)
.   ? accept : CStr
.     type : CStr
   CClass  (CClBase,)
.   ? her : CStr
.   * bool :  CBool  (CLeave,)
.   * clDef :  CClDef  (CClass,)
.   * clDefInst :  CClDefInst  (CClDef,CAss,)
.   * clInst :  CClInst  (CClBase,CAss,)
.   * clRef :  CClRef  (CClBase,CAss,)
.   * date :  CDate  (CLeave,)
.   * flt :  CFlt  (CScalarLeave,)
.   * int :  CInt  (CScalarLeave,)
.   * map :  CMap  (CEl,CAss,)
.   .     keyType : CStr
.   .     valType : CStr
.   * method :  CMethod 
.   .     name : CStr
.   .   * arg :  CArg 
.   .   .     dir : CStr
.   .   .     name : CStr
.   .   .     type : CStr
.   .   .   ? unit : CStr
.   * str :  CStr  (CLeave,)
 dfg :  CDfg  (CClass,)
}}
}}
{{:DataFlowGenerator:Versionnement}}

=== Liens externes ===
* Structure d'un document XML
: http://www.commentcamarche.net/contents/xml/xmlstruc.php3