Manipulation des donn�es stock�es

=================================

Les classes `Entity` et `AnyEntity`

-----------------------------------

Pour fournir un comportement sp�cifique � un type d'entit�, il suffit de d�finir

une classe h�ritant de la class `cubicweb.entities.AnyEntity`. En g�n�ral il faut

d�finir ces classes dans un module du package `entities` d'une application pour 

qu'elle soit disponible � la fois cot� serveur et cot� client.

La classe `AnyEntity` est une classe charg�e dynamiquement h�ritant de la classe

de base `Entity` (`cubicweb.common.entity`). On d�finit une sous-classe pour

ajouter des m�thodes ou sp�cialiser les comportements d'un type d'entit� donn�.

Des descripteurs sont ajout�s � l'enregistrement pour initialiser la classe en

fonction du sch�ma :

* on peut acc�der aux attributs d�finis dans le sch�ma via les attributs de m�me

  nom sur les instances (valeur typ�e)

* on peut acc�der aux relations d�finies dans le sch�ma via les attributs de m�me

  nom sur les instances (liste d'instances d'entit�)

Les m�thodes d�finies sur la classe `AnyEntity` ou `Entity` sont les suivantes :

* `has_eid()`, retourne vrai si l'entit� � un eid affect� (i.e. pas en cours de

  cr�ation) 

* `check_perm(action)`, v�rifie que l'utilisateur � le droit d'effectuer

  l'action demand�e sur l'entit�

:Formattage et g�n�ration de la sortie:

  * `view(vid, **kwargs)`, applique la vue donn�e � l'entit�

  * `absolute_url(**kwargs)`, retourne une URL absolue permettant d'acc�der � la

    vue primaire d'une entit�

  * `format(attr)`, retourne le format (type MIME) du champ pass� en argument

  * `printable_value(attr, value=_marker, attrtype=None, format='text/html')`, 

    retourne une chaine permettant l'affichage dans un format donn� de la valeur

    d'un attribut (la valeur est automatiquement r�cup�r�e au besoin)

  * `display_name(form='')`, retourne une cha�ne pour afficher le type de

    l'entit�, en sp�cifiant �ventuellement la forme d�sir�e ('plural' pour la

    forme plurielle) 

:Gestion de donn�es:

  * `complete(skip_bytes=True)`, effectue une requ�te permettant de r�cup�rer d'un

    coup toutes les valeurs d'attributs manquant sur l'entit�

  * `get_value(name)`, r�cupere la valeur associ�e � l'attribut pass� en argument

  * `related(rtype, x='subject', limit=None, entities=False)`, retourne une liste

    des entit�s li�es � l'entit� courant par la relation donn�e en argument

  * `unrelated(rtype, targettype, x='subject', limit=None)`, retourne un result set

    des entit�s not li�es � l'entit� courante par la relation donn�e en argument

    et satisfaisants les contraintes de celle-ci

  * `copy_relations(ceid)`, copie les relations de l'entit� ayant l'eid pass� en

    argument sur l'entit� courante

  * `last_modified(view)`, retourne la date � laquelle on doit consid�rer

    l'objet comme modifi� (utiliser par la gestion de cache HTTP)

:Meta-donn�es standard (Dublin Core):

  * `dc_title()`, retourne une chaine unicode correspondant � la m�ta-donn�e

    'Title' (utilise par d�faut le premier attribut non 'meta' du sch�ma de

    l'entit�) 

  * `dc_long_title()`, comme dc_title mais peut retourner un titre plus d�taill�

  * `dc_description(format='text/plain')`, retourne une chaine unicode

     correspondant � la m�ta-donn�e 'Description' (cherche un attribut

     'description' par d�faut)

  * `dc_authors()`, retourne une chaine unicode correspondant � la m�ta-donn�e

    'Authors' (propri�taires par d�faut)

  * `dc_date(date_format=None)`, retourne une chaine unicode

     correspondant � la m�ta-donn�e 'Date' (date de modification par d�faut)

:Contr�le du vocabulaire pour les relations:

  * `vocabulary(rtype, x='subject', limit=None)`

  * `subject_relation_vocabulary(rtype, limit=None)`

  * `object_relation_vocabulary(rtype, limit=None)`

  * `relation_vocabulary(rtype, targettype, x, limit=None)`

Les *rtags*

-----------

Les *rtags* permettent de sp�cifier certains comportements propres aux relations

d'un type d'entit� donn� (voir plus loin). Ils sont d�finis sur la classe 

d'entit� via l'attribut `rtags` qui est un dictionnaire dont les cl�s sont un 

triplet ::

  <type de relation>, <type d'entit� cible>, <position du contexte ("subject" ou "object"

et les valeurs un `set` ou un tuple de marqueurs d�finissant des propri�t�s 

s'appliquant � cette relation. 

Il est possible de simplifier ce dictionnaire :

* si l'on veut sp�cifier un seul marqueur, il n'est pas n�cessaire d'utiliser

  un tuple comme valeur, le marqueur seul (chaine de caract�res) suffit

* si l'on s'int�resse uniquement � un type de relation et non � la cible et � la

  position du contexte (ou que celui-ci n'est pas ambig�e), on peut simplement

  utiliser le nom du type de relation comme cl�

* si l'on veut qu'un marqueur s'applique quelque soit le type d'entit� cible, il

  faut utiliser la chaine `*` comme type d'entit� cible

A noter �galement que ce dictionnaire est *trait� � la cr�ation de la classe*. 

Il est automatiquement fusionn� avec celui de la ou des classe(s) parentes (pas

besoin de copier celui de la classe parent pour le modifier). De m�me modifier

celui-ci apr�s cr�ation de la classe n'aura aucun effet...

.. include:: sect_definition_entites.txt