Listes d'objets (tech)

Version du 18 août 2009 à 17:08

Introduction

Utilisez un TObjectList pour manipuler une liste d'objets. TObjectList fournit des propriétés et méthodes pour ajouter, supprimer, réorganiser, trouver, trier et accéder aux objets contenus dans la liste.

Note : Les listes d'objets peuvent être utilisé comme attribut non persistant

Une liste d'objet charge ses objets en une seule requête et les conservent en mémoire. Ce fonctionnement à des avantages et des incovénients :

• Une fois l'ordre de chargement exécuté il ni a plus d'interactions base de données.
• Les objets sont maintenus en mémoire se qui interdit le traitement de grande quantité d'objet.

Note : Grande est une notion relative, vous pouvez charger des milliers d'objet dans une liste sans problèmes mais vous aurez certainement des problèmes si vous essayer de charger des centaines de milliers ou des millions d'objets dans une liste.

Déclaration d'une variable liste d'objet

Les listes d'objets doivent être déclarée avant d'être utilisées, lorsque la classe de la liste est connue au moment de la déclaration la forme préfixé du nom de la classe métier peut être utilisée :

var ls:NomDeClassList;

Cette forme de déclaration permet au compilateur de connaitre la classe des objets de la liste.

Création d'une liste d'objet

Utilisation du ClassManager

Le ClassManager expose une fonction pour créer des listes d'objets d'une classe donnée :

function CreateObjectList(const iClassName :string) :TObjectList;

iClassName représente le nom de la classe des objets contenus dans la liste.

Exemple

var ls:TEcritureList;
begin
  ls := ClassManager.CreateObjectList('TEcriture');
end;

Utilisation du constructeur de liste d'une classe métier

Les classes métiers exposent un constructeur de liste permettant de créer une liste d'objet de la classe :

class function TObjectClass.CreateList:TObjectClassList;

Exemple

var ls:TEcritureList;
begin
  ls := TEcriture.CreateList;
end;

Note : Les deux formes de code sont équivalentes, la seconde est plus claire et évite les erreurs de frappe du nom des classes

Propriétés

Nom	Type	Usage
aClassName	String	Nom de la classe des objets contenu dans la liste.
Count	Integer	Renvoie le nombre d'objets dans la liste.
OIDs [index]	property OIDs[index:Integer]:TOID;	Renvoie le oid de l'objet situé à la position indiquée par index dans la liste. Index spécifie la position de l'objet, 0 indique le premier objet, 1 le second, etc.
Refs [index] (itérateur)	property Refs[index:Integer]:TitObject;	Renvoie la référence de l'objet située à la position indiquée par index dans la liste. Index spécifie la position de l'objet, 0 indique le premier objet, 1 le second, etc.
OrderValues [index]	property OrderValues[index:Integer]:variant;	Renvoie la value de l'attribut triant la liste (ORDERBY) de l'objet situé à la position indiquée par Index dans la liste. Si la propriété ORDERBY est non spécifiée, ORDERVALUES renvoie OID. Index spécifie la position des attributs, 0 indique le premier attribut, 1 le second, etc.
OrderBy	String	Indique l'attribut triant la liste ; positionner OrderBy déclenche le tri des objets présents dans la liste et l’insertion triée des nouveaux objets.
Duplicates	Enum	Permet d'indiquer le comportement de la liste sur doublon : dupIgnore  : L'objet n'est pas inséré, aucune erreur. dupAccept  : L'objet est inséré. dupError  : Une exception est déclenchée. Par défaut Duplicates = dupAccept Note : Le changement de la propriété Duplicates n'a pas d'effet sur les éléments déjà présents dans la liste.
AnyWhere	Boolean	Ne pas filter les objets sur les périmètres de partage. Attention : Cette option n'est à utiliser que pour les dossiers multi-société dans les traitements de type inter-sociétés.

Méthodes

Exemples

Chargement d'une liste

procedure TExercice.doPeriodes;
var vListePeriode :TPeriodeList;
begin
  // Liste des périodes d'un exercice ordonnée par date de début de période.
  vlistePeriode := TPeriodeList.CreateList;
  vlistePeriode.AddWhere('oidExercice=%1','','dateDebut',FALSE,1000,[instanceOid]);
  ...
end;

Utilisation d'une condition objet

procedure TMyProcessus.doEcritures;
var EcritureList:TEcritureList; idx:Integer;
begin
  // Liste des 1000 premières écritures au débit d'une tranche de compte trié par libellé.
  //
  // Utilise un filtre objet pour estDebit qui est un attribut dérivé de la classe TEcriture
  //
  EcritureList := ClassManager.CreateObjectList('TEcriture');
  EcritureList.AddWhere('(CompteGeneral.Code >= %1) and (CompteGeneral.Code <= %2)','(estDebit = %3)', 'Caption',TRUE,1000,
[borne_inferieure,borne_superieure,True]);
  for idx :=0 to EcritureList.Count-1 do
   ProgressMessage(EcritureList.Refs[idx].Caption)
  end;
end;