1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
|
//-----------------------------------------------------------------------------)
(* SoLuTions is an Versatile Library for Delphi -
* -
* Copyright ou © ou Copr. "SLT Solutions", (2006) -
* contributeur : ShaiLeTroll (2007) - Passage en Classe d'un code procédural -
* contributeur : ShaiLeTroll (2011) - Préparation au passage Ansi vers Unicode sous Delphi XE2 (Support de C++Builder XE2 a prévoir)
* contributeur : ShaiLeTroll (2012) - Renommage Fichier et Correction XE2 -
* contributeur : ShaiLeTroll (2012) - Documentation Insight -
* -
* Ce logiciel est un programme informatique servant à aider les développeurs -
* Delphi avec une bibliothèque polyvalente, adaptable et fragmentable. -
* -
* Ce logiciel est régi par la licence CeCILL-C soumise au droit français et -
* respectant les principes de diffusion des logiciels libres. Vous pouvez -
* utiliser, modifier et/ou redistribuer ce programme sous les conditions -
* de la licence CeCILL-C telle que diffusée par le CEA, le CNRS et l'INRIA -
* sur le site "http://www.cecill.info". -
* -
* En contrepartie de l'accessibilité au code source et des droits de copie, -
* de modification et de redistribution accordés par cette licence, il n'est -
* offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons, -
* seule une responsabilité restreinte pèse sur l'auteur du programme, le -
* titulaire des droits patrimoniaux et les concédants successifs. -
* -
* A cet égard l'attention de l'utilisateur est attirée sur les risques -
* associés au chargement, à l'utilisation, à la modification et/ou au -
* développement et à la reproduction du logiciel par l'utilisateur étant -
* donné sa spécificité de logiciel libre, qui peut le rendre complexe à -
* manipuler et qui le réserve donc à des développeurs et des professionnels -
* avertis possédant des connaissances informatiques approfondies. Les -
* utilisateurs sont donc invités à charger et tester l'adéquation du -
* logiciel à leurs besoins dans des conditions permettant d'assurer la -
* sécurité de leurs systèmes et ou de leurs données et, plus généralement, -
* à l'utiliser et l'exploiter dans les mêmes conditions de sécurité. -
* -
* Le fait que vous puissiez accéder à cet en-tête signifie que vous avez -
* pris connaissance de la licence CeCILL-C, et que vous en avez accepté les -
* termes. -
* -
*----------------------------------------------------------------------------*)
unit SLT.ETL.Import_CSV;
interface
uses System.Classes, System.SysUtils, System.Types,
Generics.Collections,
SLT.ETL.Import,
SLT.Common.CSVUtils;
type
{ Forward class declarations }
TSLTETLImportCSV = class;
ISLTETLImportCSVSourceReader = interface;
TSLTETLImportCSVSourceReader = class;
TSLTETLImportCSVSourceChecker = class;
ISLTETLImportCSVSourceDispatcher = interface;
TSLTETLImportCSVSourceDispatcher = class;
ISLTETLImportCSVDestinationDispatcher = interface;
TSLTETLImportCSVDestinationDispatcher = class;
TSLTETLImportCSVColumns = class;
TSLTETLImportCSVColumn = class;
TSLTETLImportCSVHeader = class;
{ Aliases class declarations }
ISLTETLImportCSVFormatSpecification = ISLTCSVFormatSpecification;
TSLTETLImportCSVHeaderSpecification = TSLTETLImportCSVHeader;
TSLTETLImportCSVRawHeader = TStringDynArray;
TSLTETLImportCSVRawHeaders = array of TSLTETLImportCSVRawHeader;
/// <summary>Erreur de base liée à l'importation des données correspondant aux spécifications du format CSV</summary>
ESLTETLImportCSVError = class(Exception);
/// <summary>Importe des données correspondant aux spécifications du format CSV</summary>
TSLTETLImportCSV = class abstract(TSLTETLAbstractImportFromStream)
private
// Membres privés
FSourceReader: ISLTETLImportSourceReader;
FSourceChecker: ISLTETLImportSourceChecker;
FSourceDispatcher: ISLTETLImportSourceDispatcher;
FDestinationDispatcher: ISLTETLImportDestinationDispatcher;
protected
// Accesseurs Abstraits redéfinis
/// <summary>Fournit une implémentation de ISLTETLImportSourceReader chargée de lire le contenu de la Source</summary>
function GetSourceReader(): ISLTETLImportSourceReader; override;
/// <summary>Fournit une implémentation de ISLTETLImportSourceChecker chargée de vérifier le contenu de la Source</summary>
function GetSourceChecker(): ISLTETLImportSourceChecker; override;
/// <summary>Fournit une implémentation de ISLTETLImportDispatcher chargée de fournir les données à importer depuis de la Source</summary>
function GetSourceDispatcher(): ISLTETLImportSourceDispatcher; override;
/// <summary>Fournit une implémentation de ISLTETLImportDestinationDispatcher chargée d'intégrer les données</summary>
function GetDestinationDispatcher(): ISLTETLImportDestinationDispatcher; override;
/// <summary>Fournit une implémentation de ISLTETLImportSourceStreamReader chargée de lire le contenu de la Source à partir d'un flux générique</summary>
function GetStreamReader(): ISLTETLImportSourceStreamReader; override;
// Méthodes Abstraites
/// <summary>La redéfinition doit fournir le format du fichier CSV attendu</summary>
procedure InitializeCSVFormat(ASourceReader: ISLTETLImportCSVSourceReader); virtual; abstract;
/// <summary>La redéfinition doit fournir le traitement d'importation des données issu du fichier CSV</summary>
procedure ProcessCSVLine(const ACSVLine: TStringDynArray); virtual; abstract;
// Accesseurs
/// <summary>Fournit une implémentation de ISLTETLImportCSVSourceReader chargée de lire le contenu de la Source correspondant aux spécifications du format CSV</summary>
function GetCSVSourceReader(): ISLTETLImportCSVSourceReader;
/// <summary>Fournit une implémentation de ISLTETLImportCSVDestinationDispatcher chargée d'intégrer les données issues d'une source correspondant aux spécifications du format CSV</summary>
function GetCSVDestinationDispatcher(): ISLTETLImportCSVDestinationDispatcher;
// Gestionnaire d'Evenements
procedure DispatchLineEventHandler(Sender: TObject; const ALine: TStringDynArray);
public
// Constructeurs
constructor Create();
destructor Destroy(); override;
// Méthodes - Redéfinition de TSLTETLImport
function Import(): Boolean; override;
protected
// Propriétés protégées
/// <summary>Fournit l'interface responsable de la lecture de la source de données correspondant aux spécifications du format CSV</summary>
property CSVSourceReader: ISLTETLImportCSVSourceReader read GetCSVSourceReader;
/// <summary>Fournit l'interface responsable de fournir les données à importer depuis de la Source de données correspondant aux spécifications du format CSV</summary>
property CSVDestinationDispatcher: ISLTETLImportCSVDestinationDispatcher read GetCSVDestinationDispatcher;
end;
/// <summary>Cette interface permet de lire la source de données correspondant aux spécifications du format CSV</summary>
ISLTETLImportCSVSourceReader = interface
['{FD57280C-DEFE-49E4-8EE9-0EB67E3CEA58}']
// Accesseurs - Implémentation de ISLTETLImportSourceReader
function GetExpectedColumns(): TSLTETLImportCSVColumns;
function GetFoundColumns(): TSLTETLImportCSVColumns;
function GetExpectedHeader(): TSLTETLImportCSVHeader;
function GetFoundHeader(): TSLTETLImportCSVHeader;
function GetData(): ISLTCSVReader;
procedure SetData(const Value: ISLTCSVReader);
// Méthodes
/// <summary>Efface les paramètres attendues et trouvée</summary>
procedure Clear();
// Propriétés
/// <summary>Description des Colonnes attendues dans la source CSV</summary>
property ExpectedColumns: TSLTETLImportCSVColumns read GetExpectedColumns;
/// <summary>Description des Colonnes présentes dans la source CSV</summary>
property FoundColumns: TSLTETLImportCSVColumns read GetFoundColumns;
/// <summary>Indique si la source CSV doit contenir des lignes d'entête</summary>
property ExpectedHeader: TSLTETLImportCSVHeader read GetExpectedHeader;
/// <summary>Indique si la source CSV contient des lignes d'entête</summary>
property FoundHeader: TSLTETLImportCSVHeader read GetFoundHeader;
/// <summary>Accès au données du CSV</summary>
property Data: ISLTCSVReader read GetData write SetData;
end;
/// <summary>Lit les données correspondant aux spécifications du format CSV</summary>
TSLTETLImportCSVSourceReader = class(TInterfacedObject, ISLTETLImportSourceReader, ISLTETLImportSourceStreamReader, ISLTETLImportCSVSourceReader)
private
// Membres privés de Classe
class var
FDefaultCSVReaderClass: TClass;
private
// Membres privés
FReaderIntf: ISLTCSVReader;
FExpectedColumns: TSLTETLImportCSVColumns;
FFoundColumns: TSLTETLImportCSVColumns;
FExpectedHeader: TSLTETLImportCSVHeader;
FFoundHeader: TSLTETLImportCSVHeader;
// Méthodes Internes
function ReaderIntfFactory(): ISLTCSVReader;
protected
// Accesseurs - Implémentation de ISLTETLImportSourceStreamReader
function GetSource(): TStream;
procedure SetSource(const Value: TStream);
// Accesseurs - Implémentation de ISLTETLImportCSVSourceReader
function GetExpectedColumns(): TSLTETLImportCSVColumns;
function GetFoundColumns(): TSLTETLImportCSVColumns;
function GetExpectedHeader(): TSLTETLImportCSVHeader;
function GetFoundHeader(): TSLTETLImportCSVHeader;
function GetData(): ISLTCSVReader;
procedure SetData(const Value: ISLTCSVReader);
public
// Méhodes - Implémentation de ISLTETLImportCSVSourceReader
procedure Clear();
public
// Constructeurs
constructor Create();
destructor Destroy(); override;
public
// Constructeurs de Classe
class constructor Create();
// Propriétés de Classe
/// <summary>Indique la classe par défaut utilisée comme Implémentation de ISLTCSVReader</summary>
class property DefaultCSVReaderClass: TClass read FDefaultCSVReaderClass write FDefaultCSVReaderClass;
end;
/// <summary>Vérifie que la source correspondant aux spécifications du format CSV</summary>
TSLTETLImportCSVSourceChecker = class(TInterfacedObject, ISLTETLImportSourceChecker)
private
// Membres privés
FCheckMessages: TStrings;
// Méthodes
function ReadHeaders(ASourceReader: ISLTETLImportCSVSourceReader; out ARawHeaders: TSLTETLImportCSVRawHeaders): Boolean;
function CheckHeaders(ASourceReader: ISLTETLImportCSVSourceReader): Boolean;
protected
// Accesseurs - Implémentation de ISLTETLImportSourceChecker
function GetCheckMessages(): TStrings;
public
// Méthodes - Implémentation de ISLTETLImportSourceChecker
function CheckSource(ASourceReader: ISLTETLImportSourceReader): Boolean;
public
// Méthodes
class function IsCSVFile(ASourceReader: ISLTETLImportSourceReader): Boolean;
class function IsCSVFileName(AFileName: TFileName): Boolean;
class function IsCSVStream(AStream: TStream): Boolean;
public
// Constructeurs
constructor Create();
destructor Destroy(); override;
end;
/// <summary>Cette interface permet de récuperer les données prêtes à être importer</summary>
ISLTETLImportCSVSourceDispatcher = interface
['{8D425059-98E8-4377-8B4A-38CD6B0F4972}']
// Méthodes
/// <summary>Extrait les Données CSV</summary>
function DispacthCSVLine(ASourceReader: ISLTETLImportSourceReader; out ACSVLine: TStringDynArray): Boolean;
end;
/// <summary>Fourni les données à importer</summary>
TSLTETLImportCSVSourceDispatcher = class(TInterfacedObject, ISLTETLImportSourceDispatcher, ISLTETLImportCSVSourceDispatcher)
public
// Méthodes - Implémentation de ISLTETLImportDispatcher
function DispatchSourceToDestination(ASourceReader: ISLTETLImportSourceReader; ADestinationDispatcher: ISLTETLImportDestinationDispatcher): Boolean;
// Méthodes - Implémentation de ISLTETLImportCSVSourceDispatcher
function DispacthCSVLine(ASourceReader: ISLTETLImportSourceReader; out ACSVLine: TStringDynArray): Boolean;
end;
/// <summary>Evènement qui se produit pour chaque ligne du CSV</summary>
TSLTETLImportCSVDestinationDispatchEvent = procedure(Sender: TObject; const ACSVLine: TStringDynArray) of object;
/// <summary>Cette interface permet d'importer les données correspondant aux spécifications du format CSV</summary>
ISLTETLImportCSVDestinationDispatcher = interface
['{AEBB0F46-D11A-43B8-B1A4-580C7E0B081B}']
// Accesseurs
function GetOnDispatch(): TSLTETLImportCSVDestinationDispatchEvent;
procedure SetOnDispatch(const Value: TSLTETLImportCSVDestinationDispatchEvent);
// Méthodes
procedure DoDispatch(const ACSVLine: TStringDynArray);
// Propriétés
/// <summary>Evènement qui se produit pour chaque ligne du CSV</summary>
property OnDispatch: TSLTETLImportCSVDestinationDispatchEvent read GetOnDispatch write SetOnDispatch;
end;
/// <summary>Fourni les données à importer</summary>
TSLTETLImportCSVDestinationDispatcher = class(TInterfacedObject, ISLTETLImportDestinationDispatcher, ISLTETLImportCSVDestinationDispatcher)
private
// Membres privés
FOnDispatch: TSLTETLImportCSVDestinationDispatchEvent;
protected
// Accesseurs - Implémentation de ISLTETLImportCSVDestinationDispatcher
function GetOnDispatch(): TSLTETLImportCSVDestinationDispatchEvent;
procedure SetOnDispatch(const Value: TSLTETLImportCSVDestinationDispatchEvent);
public
// Méthodes - Implémentation de ISLTETLImportCSVDestinationDispatcher
procedure DoDispatch(const ACSVLine: TStringDynArray);
// Méthodes - Implémentation de ISLTETLImportDestinationDispatcher
function DispatchDestinationFromSource(ASourceReader: ISLTETLImportSourceReader; ASourceDispatcher: ISLTETLImportSourceDispatcher): Boolean;
end;
/// <summary>Description des Colonnes d'une source CSV</summary>
TSLTETLImportCSVColumns = class(TObject)
private
// Types internes
type
TColumnList = Generics.Collections.TObjectList<TSLTETLImportCSVColumn>;
private
// Membres privés
FColumnList: TColumnList;
FDuplicates: TDuplicates;
// Accesseurs
function GetCount: Integer;
function GetItems(Index: Integer): TSLTETLImportCSVColumn;
// Méthodes Privées
function IndexOfColumnName(const AColumnName: string): Integer;
public
// Constructeurs
constructor Create();
destructor Destroy(); override;
// Méthodes
/// <summary>Crée une nouvelle colonne nommée et utilise l'index dans la liste comme position par défaut dans la source CSV</summary>
function AddColumn(const AColumnName: string): TSLTETLImportCSVColumn; overload;
/// <summary>Crée une nouvelle colonne nommée et typée. Utilise l'index dans la liste comme position par défaut dans la source CSV</summary>
function AddColumn(const AColumnName: string; AColumnType: TVarType): TSLTETLImportCSVColumn; overload;
/// <summary>Recopie les colonnes depuis une autre liste</summary>
procedure CopyFrom(ASource: TSLTETLImportCSVColumns);
/// <summary>Efface les colonnes</summary>
procedure Clear();
// Propriétés
/// <summary>Description des Colonnes attendues dans la source CSV</summary>
property Count: Integer read GetCount;
/// <summary>Description des Colonnes présentes dans la source CSV</summary>
property Items[Index: Integer]: TSLTETLImportCSVColumn read GetItems; default;
/// <summary> Indique si l'ajout de colonnes dupliquées est autorisé</summary>
property Duplicates: TDuplicates read FDuplicates write FDuplicates;
end;
/// <summary>Description d'une Colonne CSV</summary>
TSLTETLImportCSVColumn = class(TObject)
private
// Membres privés
FColumnName: string;
FColumnType: TVarType;
FColumnPosition: Integer;
FColumnSizeMax: Integer;
FColumnSizeMin: Integer;
public
// Constructeurs
constructor Create(const AColumnName: string);
// Méthodes
/// <summary>Recopie les données d'une colonne depuis une autre colonne hormis son nom</summary>
procedure CopyFrom(ASource: TSLTETLImportCSVColumn);
// Propriétés
/// <summary>Nom de la Colonne CSV</summary>
property ColumnName: string read FColumnName;
/// <summary>Nom de la Colonne CSV</summary>
property ColumnType: TVarType read FColumnType write FColumnType;
/// <summary>Position de la Colonne CSV</summary>
property ColumnPosition: Integer read FColumnPosition write FColumnPosition;
/// <summary>Taille minimale de la Colonne CSV</summary>
property ColumnSizeMin: Integer read FColumnSizeMin write FColumnSizeMin;
/// <summary>Taille maximale dde la Colonne CSV</summary>
property ColumnSizeMax: Integer read FColumnSizeMax write FColumnSizeMax;
end;
/// <summary>Description des Entêtes d'une source CSV</summary>
TSLTETLImportCSVHeader = class(TObject)
public
// Types publiques
/// <summary>listes des options des Entêtes d'une source CSV</summary>
/// <remarks>Indique si l'Entête est autorisé sans être obligatoire, obligatoire, présent, ...</remarks>
type
THeaderState = (csvhsNone, csvhsAllowed, csvhsRequired, csvhsPotential, csvhsFound, csvhsMissing, csvhsIncomplete);
private
// Membres privés
FLineCount: Integer;
FLineOfColumnName: Integer;
FState: THeaderState;
public
// Constructeurs
constructor Create();
// Méthodes
/// <summary>Ajoute un contenu brut d'une ligne pouvant faire parti des entêtes</summary>
procedure Add(RawHeader: TSLTETLImportCSVRawHeader);
/// <summary>Efface le Nombre de Ligne et le contenu brut des entêtes</summary>
procedure Clear();
// Propriétés
/// <summary>Nombre de Ligne de l'Entête</summary>
property LineCount: Integer read FLineCount write FLineCount;
/// <summary>Indice de Ligne de l'Entête contenant les noms de Colonnes</summary>
property LineOfColumnName: Integer read FLineOfColumnName write FLineOfColumnName;
/// <summary>Indique si l'Entête est autorisé sans être obligatoire, obligatoire, présent, ...</summary>
property State: THeaderState read FState write FState;
end;
implementation
uses System.Math, System.StrUtils,
SLT.Common.SysUtilsEx;
const
ERR_EMPTY_COLUMN_NAME_NOT_ALLOWED = 'Le nom de la colonne d''une source CSV est obligatoire, il ne peut pas être vide';
ERR_DUPLICATED_COLUMN_NAME_NOT_ALLOWED_FMT = 'La colonne "%s" ne peut pas être ajoutée plusieurs fois pour une même source CSV';
ERR_NO_ENCODING = 'Le format d''encodage de la source CSV doit être défini';
{ TSLTETLImportCSV }
//--------------------------------------------
constructor TSLTETLImportCSV.Create();
begin
inherited Create();
// Les Interfaces sont gérées par compteur de référence.
FSourceReader := TSLTETLImportCSVSourceReader.Create();
FSourceChecker := TSLTETLImportCSVSourceChecker.Create();
FSourceDispatcher := TSLTETLImportCSVSourceDispatcher.Create();
FDestinationDispatcher := TSLTETLImportCSVDestinationDispatcher.Create();
end;
//--------------------------------------------
destructor TSLTETLImportCSV.Destroy();
begin
// Les Interfaces sont gérées par compteur de référence,
// L'affectation à nil doit les libérer (si plus aucun autre objet les utilises, ce qui DOIT être le cas)
FDestinationDispatcher := nil;
FSourceDispatcher := nil;
FSourceReader := nil;
FSourceChecker := nil;
inherited Destroy();
end;
//--------------------------------------------
procedure TSLTETLImportCSV.DispatchLineEventHandler(Sender: TObject; const ALine: TStringDynArray);
begin
ProcessCSVLine(ALine);
end;
//--------------------------------------------
function TSLTETLImportCSV.GetCSVDestinationDispatcher(): ISLTETLImportCSVDestinationDispatcher;
begin
// Même si l'on choisi de redéfinir DestinationDispatcher, il doit implémenter ISLTETLImportCSVDestinationDispatcher en plus de ISLTETLImportDestinationDispatcher
if not Supports(DestinationDispatcher, ISLTETLImportCSVDestinationDispatcher, Result) then
raise ESTLIntfCastError.Create(DestinationDispatcher, ISLTETLImportCSVDestinationDispatcher); // Pseudo-Assert Exception !
end;
//--------------------------------------------
function TSLTETLImportCSV.GetCSVSourceReader(): ISLTETLImportCSVSourceReader;
begin
// Même si l'on choisi de redéfinir SourceReader, il doit implémenter ISLTETLImportCSVSourceReader en plus de ISLTETLImportSourceReader
if not Supports(SourceReader, ISLTETLImportCSVSourceReader, Result) then
raise ESTLIntfCastError.Create(SourceReader, ISLTETLImportCSVSourceReader); // Pseudo-Assert Exception !
end;
//--------------------------------------------
function TSLTETLImportCSV.GetDestinationDispatcher: ISLTETLImportDestinationDispatcher;
begin
Result := FDestinationDispatcher;
end;
//--------------------------------------------
function TSLTETLImportCSV.GetSourceDispatcher(): ISLTETLImportSourceDispatcher;
begin
Result := FSourceDispatcher;
end;
//--------------------------------------------
function TSLTETLImportCSV.GetSourceChecker(): ISLTETLImportSourceChecker;
begin
Result := FSourceChecker;
end;
//--------------------------------------------
function TSLTETLImportCSV.GetSourceReader(): ISLTETLImportSourceReader;
begin
Result := FSourceReader;
end;
//--------------------------------------------
function TSLTETLImportCSV.GetStreamReader(): ISLTETLImportSourceStreamReader;
begin
// Même si l'on choisi de redéfinir SourceReader, il doit implémenter ISLTETLImportSourceStreamReader en plus de ISLTETLImportSourceReader
if not Supports(FSourceReader, ISLTETLImportSourceStreamReader, Result) then
raise ESTLIntfCastError.Create(SourceReader, ISLTETLImportSourceStreamReader); // Pseudo-Assert Exception !
end;
//--------------------------------------------
function TSLTETLImportCSV.Import(): Boolean;
begin
CSVSourceReader.Clear();
if not Supports(CSVSourceReader.Data, ISLTCSVReader) then
raise ESTLIntfCastError.Create(CSVSourceReader.Data, ISLTCSVReader); // Pseudo-Assert Exception !
InitializeCSVFormat(CSVSourceReader);
CSVDestinationDispatcher.OnDispatch := DispatchLineEventHandler;
Result := inherited Import();
end;
{ TSLTETLImportCSVSourceChecker }
//--------------------------------------------
function TSLTETLImportCSVSourceChecker.CheckHeaders(ASourceReader: ISLTETLImportCSVSourceReader): Boolean;
//--------------------------------------------------------------------------
function MakeRawHeaderFromColumns(AColumns: TSLTETLImportCSVColumns): TSLTETLImportCSVRawHeader;
var
I: Integer;
begin
SetLength(Result, AColumns.Count);
for I := 0 to AColumns.Count - 1 do
Result[I] := AColumns[I].ColumnName;
end;
//--------------------------------------------------------------------------
function FindColumnsDefinition(const ARawHeaders: TSLTETLImportCSVRawHeaders; AColumns: TSLTETLImportCSVColumns; out AColumnDefinitionIndex: Integer): Boolean;
var
iRH: Integer;
ColFoundCount, ColIgnoredCount: Integer;
iCol: Integer;
begin
// Cherche parmi les lignes d'entête, la ligne décrivant les colonnes
Result := False;
for iRH := Low(ARawHeaders) to High(ARawHeaders) do
begin
if Length(ARawHeaders[iRH]) > 0 then
begin
// Cherche les colonnes attendues dans les lignes d'entête
ColFoundCount := 0;
ColIgnoredCount := 0;
for iCol := 0 to AColumns.Count - 1 do
begin
// Seules les colonnes typées sont intéressantes, les autres sont considérées optionnelles
if AColumns[iCol].ColumnType <> varEmpty then
begin
if System.StrUtils.MatchText(AColumns[iCol].ColumnName, ARawHeaders[iRH]) then
Inc(ColFoundCount);
end
else
Inc(ColIgnoredCount);
end;
// Si l'on a trouvé des colonnes
if ColFoundCount > 0 then
begin
AColumnDefinitionIndex := iRH;
if (ColFoundCount + ColIgnoredCount) = AColumns.Count then
begin
Result := True;
AColumnDefinitionIndex := iRH;
Exit;
end;
end;
end;
end;
end;
//--------------------------------------------------------------------------
procedure MakeColumnsFromRawHeader(const ARawHeader: TSLTETLImportCSVRawHeader; AColumns: TSLTETLImportCSVColumns);
var
I: Integer;
ColName: string;
begin
for I := Low(ARawHeader) to High(ARawHeader) do
begin
ColName := ARawHeader[i];
if ColName = '' then
ColName := 'UNNAMED_COL_' + IntToStr(I);
with AColumns.AddColumn(ColName) do
begin
ColumnType := varUString;
end;
end;
end;
var
RawHeaders: TSLTETLImportCSVRawHeaders;
ColumnDefinitionFound: Boolean;
ColumnDefinitionAsExpected: Boolean;
ColumnDefinitionIndex: Integer;
begin
Result := False;
ColumnDefinitionAsExpected := False;
// Commence par lire l'entête (si il existe)
if ReadHeaders(ASourceReader, RawHeaders) then
begin
// Il y au moins autant de ligne que doit en contenir l'entête
// Soit c'est un entête
// Soit c'est les 1ères lignes de données
if ASourceReader.FoundHeader.State = csvhsPotential then
begin
// Cherche la ligne d'entête prévue
ColumnDefinitionIndex := ASourceReader.ExpectedHeader.LineOfColumnName;
ColumnDefinitionFound := FindColumnsDefinition(RawHeaders, ASourceReader.ExpectedColumns, ColumnDefinitionIndex);
ASourceReader.FoundHeader.LineOfColumnName := ColumnDefinitionIndex;
if (ASourceReader.ExpectedHeader.LineOfColumnName >= 0) and (ASourceReader.FoundHeader.LineOfColumnName <> ASourceReader.ExpectedHeader.LineOfColumnName) then
FCheckMessages.Add(Format('La description des colonnes a été trouvée en ligne (%d) au lieu de la ligne prévue (%d)', [ASourceReader.FoundHeader.LineOfColumnName, ASourceReader.ExpectedHeader.LineOfColumnName]));
// Si la ligne de description des colonnes est trouvée, on charge ces colonnes depuis cette description
if ColumnDefinitionFound then
begin
MakeColumnsFromRawHeader(RawHeaders[ColumnDefinitionIndex], ASourceReader.FoundColumns);
ASourceReader.FoundHeader.State := csvhsFound;
Result := True;
end
else
begin
// Si l'entête est obligatoire, c'est une erreur
// Soit on a eu une correspondance partielle et donc l'entête est incomplet
// Soit on a aucune correspondance, c'est que l'entête est manquant
// Si l'entête est optionnel, c'est soit normal soit une erreur
// Soit on a eu une correspondance partielle et donc l'entête est incomplet
// Soit on a aucune correspondance, c'est que l'entête n'est pas présent
if ColumnDefinitionIndex >= 0 then
begin
ASourceReader.FoundHeader.State := csvhsIncomplete;
end
else
begin
if ASourceReader.ExpectedHeader.State = csvhsRequired then
ASourceReader.FoundHeader.State := csvhsMissing
else
begin
ASourceReader.FoundHeader.State := csvhsNone;
ColumnDefinitionAsExpected := True;
end;
end;
end;
end
else
end
else
// Pas d'entête, si aucun n'était attendu, ce n'est pas un problème
// On considère les colonnes prévues comme des colonnes présentes dans l'ordre prévue
if ASourceReader.FoundHeader.State = csvhsNone then
ColumnDefinitionAsExpected := True;
if ColumnDefinitionAsExpected then
begin
ASourceReader.FoundColumns.CopyFrom(ASourceReader.ExpectedColumns);
Result := True;
end;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceChecker.CheckSource(ASourceReader: ISLTETLImportSourceReader): Boolean;
var
lSourceReader: ISLTETLImportCSVSourceReader;
begin
// TODO -oSPT -cImplémentation : Ecrire TSLTETLImportCSVSourceChecker.CheckSource
Result := False;
if IsCSVFile(ASourceReader) then
begin
if Supports(ASourceReader, ISLTETLImportCSVSourceReader, lSourceReader) then
begin
lSourceReader.FoundHeader.Clear();
lSourceReader.FoundColumns.Clear();
if not Assigned(lSourceReader.Data.FormatSpecification.Encoding) then
begin
FCheckMessages.Add(ERR_NO_ENCODING);
Exit;
end;
Result := CheckHeaders(lSourceReader);
// ??
end;
end;
end;
//--------------------------------------------
constructor TSLTETLImportCSVSourceChecker.Create();
begin
inherited Create();
FCheckMessages := TStringList.Create();
end;
//--------------------------------------------
destructor TSLTETLImportCSVSourceChecker.Destroy();
begin
FreeAndNil(FCheckMessages);
inherited Destroy();
end;
//--------------------------------------------
function TSLTETLImportCSVSourceChecker.GetCheckMessages: TStrings;
begin
Result := FCheckMessages;
end;
//--------------------------------------------
class function TSLTETLImportCSVSourceChecker.IsCSVFile(ASourceReader: ISLTETLImportSourceReader): Boolean;
var
StreamReaderIntf: ISLTETLImportSourceStreamReader;
begin
Result := Assigned(ASourceReader)
and Supports(ASourceReader, ISLTETLImportSourceStreamReader, StreamReaderIntf)
and IsCSVStream(StreamReaderIntf.Source);
end;
//--------------------------------------------
class function TSLTETLImportCSVSourceChecker.IsCSVFileName(AFileName: TFileName): Boolean;
begin
Result := SameText(ExtractFileExt(AFileName), '.CSV');
end;
//--------------------------------------------
class function TSLTETLImportCSVSourceChecker.IsCSVStream(AStream: TStream): Boolean;
begin
Result := ((AStream is TFileStream) and IsCSVFileName(TFileStream(AStream).FileName))
or (AStream is TMemoryStream);
end;
//--------------------------------------------
function TSLTETLImportCSVSourceChecker.ReadHeaders(ASourceReader: ISLTETLImportCSVSourceReader; out ARawHeaders: TSLTETLImportCSVRawHeaders): Boolean;
var
I: Integer;
L: Integer;
CSVLine: TStringDynArray;
begin
Result := False;
SetLength(ARawHeaders, 0);
if (ASourceReader.ExpectedHeader.State in [csvhsAllowed, csvhsRequired]) then
begin
L := ASourceReader.ExpectedHeader.LineCount;
if L > 0 then
begin
SetLength(ARawHeaders, L);
with ASourceReader.Data do
begin
Open();
try
I := 0;
while not EOF and (I < L) do
begin
if ReadNextLine(CSVLine) then
begin
ARawHeaders[I] := CSVLine;
ASourceReader.FoundHeader.Add(CSVLine);
end;
Inc(I);
end;
finally
Close();
end;
if ASourceReader.FoundHeader.LineCount > 0 then
begin
if ASourceReader.FoundHeader.LineCount = ASourceReader.ExpectedHeader.LineCount then
begin
case ASourceReader.ExpectedHeader.State of
csvhsRequired : ASourceReader.FoundHeader.State := csvhsPotential;
csvhsAllowed : ASourceReader.FoundHeader.State := csvhsPotential;
end
end
else
ASourceReader.FoundHeader.State := csvhsIncomplete;
Result := True;
end
else
if ASourceReader.ExpectedHeader.State = csvhsRequired then
ASourceReader.FoundHeader.State := csvhsMissing;
end;
end;
end;
end;
{ TSLTETLImportCSVSourceReader }
//--------------------------------------------
constructor TSLTETLImportCSVSourceReader.Create();
begin
inherited Create();
FExpectedColumns := TSLTETLImportCSVColumns.Create();
FExpectedColumns.Duplicates := dupError; // Pas de colonne en double dans celle attendue
FExpectedHeader := TSLTETLImportCSVHeader.Create();
FFoundColumns := TSLTETLImportCSVColumns.Create();
FFoundColumns.Duplicates := dupAccept; // Une colonne en double dans les colonnes trouvées est possible et doit être gérée comme une anomalie du CSV
FFoundHeader := TSLTETLImportCSVHeader.Create();
end;
//--------------------------------------------
procedure TSLTETLImportCSVSourceReader.Clear();
begin
FExpectedColumns.Clear();
FExpectedHeader.Clear();
FFoundColumns.Clear();
FFoundHeader.Clear();
end;
//--------------------------------------------
class constructor TSLTETLImportCSVSourceReader.Create();
begin
// Par défaut, on utilise l'implémentation naturelle du ISLTCSVReader : le TSLTCSVReader
DefaultCSVReaderClass := TSLTCSVReader;
end;
//--------------------------------------------
destructor TSLTETLImportCSVSourceReader.Destroy();
begin
FreeAndNil(FFoundHeader);
FreeAndNil(FFoundColumns);
FreeAndNil(FExpectedHeader);
FreeAndNil(FExpectedColumns);
// Les Interfaces sont gérées par compteur de référence
// Peu importe si il a été créé en interne ou fourni par la propriété Data,
// la libération sera faite dès que la référence ne sera plus utilisé
FReaderIntf := nil;
inherited Destroy();
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.GetData(): ISLTCSVReader;
begin
if not Assigned(FReaderIntf) then
FReaderIntf := ReaderIntfFactory();
Result := FReaderIntf;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.GetExpectedColumns(): TSLTETLImportCSVColumns;
begin
Result := FExpectedColumns;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.GetExpectedHeader(): TSLTETLImportCSVHeader;
begin
Result := FExpectedHeader;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.GetFoundColumns(): TSLTETLImportCSVColumns;
begin
Result := FFoundColumns;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.GetFoundHeader(): TSLTETLImportCSVHeader;
begin
Result := FFoundHeader;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.GetSource(): TStream;
begin
Result := FReaderIntf.Stream;
end;
//--------------------------------------------
function TSLTETLImportCSVSourceReader.ReaderIntfFactory(): ISLTCSVReader;
var
Impl: TObject;
begin
// Attention, cette pseudo-factory n'est pas thread safe,
// Veillez à gérer l'instance avec un verrou si cela s'avère nécessaire dans une version redéfinie de GetData qui appel ReaderIntfFactory
Impl := DefaultCSVReaderClass.Create();
// La classe par défaut utilisée comme Implémentation de ISLTCSVReader doit évidemment fourni son support !
// L'utilisation d'une TClass est très ouverte mais nécessite que l'on cast l'instance vers son interface
if not Supports(Impl, ISLTCSVReader, Result) then
raise ESTLIntfCastError.Create(Impl, ISLTCSVReader); // Pseudo-Assert Exception !
end;
//--------------------------------------------
procedure TSLTETLImportCSVSourceReader.SetData(const Value: ISLTCSVReader);
begin
// Les Interfaces sont gérées par compteur de référence
// Si l'on substitue une implémentation par une autre,
// cela gère naturellement les libérations dès que les références ne sont plus utilisées
if FReaderIntf <> Value then
FReaderIntf := Value;
end;
//--------------------------------------------
procedure TSLTETLImportCSVSourceReader.SetSource(const Value: TStream);
begin
FReaderIntf.Stream := Value;
end;
{ TSLTETLImportCSVColumns }
//--------------------------------------------
function TSLTETLImportCSVColumns.AddColumn(const AColumnName: string): TSLTETLImportCSVColumn;
var
ResultIndex: Integer;
begin
if AColumnName = '' then
raise ESLTETLImportCSVError.Create(ERR_EMPTY_COLUMN_NAME_NOT_ALLOWED);
// Colonne en double :
// - Interdite pour les Expected
// - Autorisée pour les Found
if Duplicates <> dupAccept then
begin
ResultIndex := IndexOfColumnName(AColumnName);
if ResultIndex >= 0 then
begin
if Duplicates = dupIgnore then
begin
Result := Items[ResultIndex];
Exit; // On ignore l'ajout !
end
else
raise ESLTETLImportCSVError.CreateFmt(ERR_DUPLICATED_COLUMN_NAME_NOT_ALLOWED_FMT, [AColumnName])
end;
end;
// Crée une nouvelle colonne nommée et utilise l'index dans la liste comme position par défaut
Result := TSLTETLImportCSVColumn.Create(AColumnName);
Result.ColumnPosition := FColumnList.Add(Result);
end;
//--------------------------------------------
function TSLTETLImportCSVColumns.AddColumn(const AColumnName: string; AColumnType: TVarType): TSLTETLImportCSVColumn;
begin
Result := AddColumn(AColumnName);
Result.ColumnType := AColumnType;
end;
//--------------------------------------------
procedure TSLTETLImportCSVColumns.Clear();
begin
FColumnList.Clear();
end;
//--------------------------------------------
procedure TSLTETLImportCSVColumns.CopyFrom(ASource: TSLTETLImportCSVColumns);
var
I: Integer;
S: TSLTETLImportCSVColumn;
begin
for I := 0 to ASource.Count - 1 do
begin
S := ASource[I];
AddColumn(S.ColumnName).CopyFrom(S);
end;
end;
//--------------------------------------------
constructor TSLTETLImportCSVColumns.Create();
begin
inherited Create();
// Les Items de FColumnList seront libérés implicitement par FColumnList
FColumnList := TColumnList.Create(True);
FDuplicates := dupAccept;
end;
//--------------------------------------------
destructor TSLTETLImportCSVColumns.Destroy();
begin
FreeAndNil(FColumnList);
inherited Destroy();
end;
//--------------------------------------------
function TSLTETLImportCSVColumns.GetCount(): Integer;
begin
Result := FColumnList.Count;
end;
//--------------------------------------------
function TSLTETLImportCSVColumns.GetItems(Index: Integer): TSLTETLImportCSVColumn;
begin
Result := FColumnList.Items[Index];
end;
//--------------------------------------------
function TSLTETLImportCSVColumns.IndexOfColumnName(const AColumnName: string): Integer;
begin
for Result := 0 to Count - 1 do
if SameText(Items[Result].ColumnName, AColumnName) then
Exit;
Result := -1;
end;
{ TSLTETLImportCSVColumn }
//--------------------------------------------
procedure TSLTETLImportCSVColumn.CopyFrom(ASource: TSLTETLImportCSVColumn);
begin
// Tout sauf ColumnName !
FColumnType := ASource.ColumnType;
FColumnPosition := ASource.ColumnPosition;
FColumnSizeMax := ASource.ColumnSizeMax;
FColumnSizeMin := ASource.ColumnSizeMin;
end;
//--------------------------------------------
constructor TSLTETLImportCSVColumn.Create(const AColumnName: string);
begin
inherited Create();
FColumnName := AColumnName;
FColumnPosition := -1; // Indique une position indéterminée !
FColumnSizeMin := 0; // Vide autorisé
FColumnSizeMax := MaxInt; // Pas de limite par défaut (presque)
end;
{ TSLTETLImportCSVHeader }
//--------------------------------------------
procedure TSLTETLImportCSVHeader.Add(RawHeader: TSLTETLImportCSVRawHeader);
begin
{ TODO -oSPT -cSécurité Donnée : Gestion des entêtes CSV }
Inc(FLineCount);
end;
//--------------------------------------------
procedure TSLTETLImportCSVHeader.Clear();
begin
State := csvhsNone;
FLineCount := 0;
FLineOfColumnName := -1;
end;
//--------------------------------------------
constructor TSLTETLImportCSVHeader.Create();
begin
inherited Create();
Clear();
end;
{ TSLTETLImportCSVDispatcher }
//--------------------------------------------
function TSLTETLImportCSVSourceDispatcher.DispacthCSVLine(ASourceReader: ISLTETLImportSourceReader; out ACSVLine: TStringDynArray): Boolean;
var
lSourceReader: ISLTETLImportCSVSourceReader;
begin
Result := False;
if Supports(ASourceReader, ISLTETLImportCSVSourceReader, lSourceReader) then
Result := lSourceReader.Data.ReadNextLine(ACSVLine);
end;
//--------------------------------------------
function TSLTETLImportCSVSourceDispatcher.DispatchSourceToDestination(ASourceReader: ISLTETLImportSourceReader; ADestinationDispatcher: ISLTETLImportDestinationDispatcher): Boolean;
var
lSourceReader: ISLTETLImportCSVSourceReader;
HeaderCount: Integer;
begin
Result := False;
// La boucle qui lit le CSV
if Supports(ASourceReader, ISLTETLImportCSVSourceReader, lSourceReader) then
begin
with lSourceReader.Data do
begin
Open();
try
if lSourceReader.FoundHeader.State = csvhsFound then
begin
HeaderCount := lSourceReader.FoundHeader.LineCount;
while not EOF and (HeaderCount > 0) do
begin
Next();
Dec(HeaderCount);
end;
end;
FormatSpecification.ExpectedColumnCount := lSourceReader.ExpectedColumns.Count;
while not EOF do
begin
if not ADestinationDispatcher.DispatchDestinationFromSource(ASourceReader, Self) then
Exit;
end;
Result := True;
finally
Close();
end;
end;
end;
end;
{ TSLTETLImportCSVDestinationDispatcher }
//--------------------------------------------
function TSLTETLImportCSVDestinationDispatcher.DispatchDestinationFromSource(ASourceReader: ISLTETLImportSourceReader; ASourceDispatcher: ISLTETLImportSourceDispatcher): Boolean;
var
lSourceDispatcher: ISLTETLImportCSVSourceDispatcher;
CSVLine: TStringDynArray;
begin
Result := False;
if Supports(ASourceDispatcher, ISLTETLImportCSVSourceDispatcher, lSourceDispatcher) then
begin
if lSourceDispatcher.DispacthCSVLine(ASourceReader, CSVLine) then
begin
// Exclusion des lignes vides
if Length(CSVLine) > 0 then
DoDispatch(CSVLine);
Result := True;
end;
end;
end;
//--------------------------------------------
procedure TSLTETLImportCSVDestinationDispatcher.DoDispatch(const ACSVLine: TStringDynArray);
begin
if Assigned(FOnDispatch) then
FOnDispatch(Self, ACSVLine);
end;
//--------------------------------------------
function TSLTETLImportCSVDestinationDispatcher.GetOnDispatch: TSLTETLImportCSVDestinationDispatchEvent;
begin
Result := FOnDispatch;
end;
//--------------------------------------------
procedure TSLTETLImportCSVDestinationDispatcher.SetOnDispatch(const Value: TSLTETLImportCSVDestinationDispatchEvent);
begin
FOnDispatch := Value;
end;
end. |
Partager