ComposantsComponents

ComposantsComponents › Fichier › GestionFile › Management

tFileDelete

tFileDelete

Fichier › GestionFile › Management

Supprime un fichier, ou un dossier avec tout son contenu. Une variable globale indique si la suppression a eu lieu. Relié à un tFileList par un lien Iterate, il supprime les fichiers d'un dossier qui correspondent à un masque : fichiers de travail, fichiers déjà traités. Deletes a file, or a folder with all its content. A global variable tells whether the deletion took place. Connected to a tFileList with an Iterate link, it deletes the files of a folder that match a mask: work files, files already processed.

EntréeInput

Aucune : il peut commencer un sous-job. Sinon un lien Iterate (une suppression par itération) ou Main (une suppression par ligne). None: it can start a subjob. Otherwise one Iterate link (one deletion per iteration) or Main link (one deletion per row).

SortieOutput

Facultative : un lien Main, avec les lignes reçues, inchangées. Optional: one Main link, with the rows received, unchanged.

Déclencheurs en sortieOutput triggers

On Subjob Ok On Subjob Error On Component Ok On Component Error Run if

On Subjob : seulement quand il commence son sous-job. On Subjob: only when it starts its subjob.

UtilisationUsage

Supprimer un fichier ou un dossierDelete a file or a folder

OnSubjobOk tFileDelete_1 tJava_1

Un fichier de travail, ou tout un dossier temporaire. CURRENT_STATUS dit ensuite ce qui s'est passé. A work file, or a whole temporary folder. CURRENT_STATUS then tells what happened.

Les fichiers d'un dossierThe files of a folder

Iterate tFileList_1 tFileDelete_1

Le nom de fichier est le fichier courant du tFileList : ((String) globalMap.get("tFileList_1_CURRENT_FILEPATH")). Le masque du tFileList choisit les fichiers supprimés. Voir l'exemple. The file name is the current file of the tFileList: ((String) globalMap.get("tFileList_1_CURRENT_FILEPATH")). The mask of the tFileList chooses the deleted files. See the example.

Suppression définitivePermanent deletion

Les fichiers ne passent pas par la corbeille. Avec Supprimer le dossier, tout ce qu'il contient disparaît, à toute profondeur et sans filtre. Vérifiez le chemin, surtout s'il vient d'une variable : avec un contexte vide, context.folder + "/tmp" devient "/tmp", un dossier à la racine du disque. The files do not go through the recycle bin. With Delete Folder, everything it holds disappears, at any depth and without a filter. Check the path, especially if it comes from a variable: with an empty context, context.folder + "/tmp" becomes "/tmp", a folder at the root of the drive.

  1. Déposez le tFileDelete depuis la famille Fichier › Gestion de la palette. Drop the tFileDelete from the File › Management family of the palette.
  2. Pour un fichier, indiquez son Nom de fichier. Pour un dossier, cochez Supprimer le dossier et indiquez le Répertoire. Si le chemin peut être l'un ou l'autre, cochez Supprimer le fichier ou le dossier. For a file, set its File Name. For a folder, check Delete Folder and set the Directory. If the path can be either, check Delete File Or Folder.
  3. Pour supprimer un fichier « s'il existe », décochez Échec sur erreur : sinon un fichier absent arrête le job. To delete a file "if it exists", uncheck Fail on error: otherwise a missing file stops the job.

Paramètres simplesBasic settings

Les libellés sont ceux de l'onglet Composant ; le nom technique, en gris, est celui du paramètre dans le fichier du job. Les chemins sont des expressions Java, entre guillemets. Le composant n'a pas de paramètres avancés propres. Labels are those of the Component tab; the technical name, in grey, is the parameter name in the job file. Paths are Java expressions, in quotes. The component has no advanced settings of its own.

ParamètreSetting DéfautDefault VisibleShown Description
Nom de fichierFile NameFILENAME in.csv dans le chemin par défaut des composantsin.csv in the component default path Les deux cases Supprimer… décochéesBoth Delete… boxes unchecked Le fichier à supprimer. Un dossier n'est pas accepté : il est traité comme un fichier absent. The file to delete. A folder is not accepted: it is handled as a missing file.
RépertoireDirectoryDIRECTORY delete_folder dans le chemin par défaut des composantsdelete_folder in the component default path Supprimer le dossier cochéDelete Folder checked Le dossier à supprimer, avec ses fichiers et sous-dossiers. Un fichier n'est pas accepté. The folder to delete, with its files and subfolders. A file is not accepted.
Fichier ou répertoire à supprimerFile or Directory to deletePATH delete_folder or delete_file dans le chemin par défaut des composantsdelete_folder or delete_file in the component default path Supprimer le fichier ou le dossier cochéDelete File Or Folder checked Un fichier ou un dossier : le composant supprime ce qu'il trouve, un dossier avec tout son contenu. A file or a folder: the component deletes what it finds, a folder with all its content.
Échec sur erreurFail on errorFAILON OuiYes ToujoursAlways Coché, un chemin absent (ou du mauvais type) et une suppression impossible arrêtent le composant par une exception. Décoché, rien n'est écrit et le job continue : seul CURRENT_STATUS le dit. Voir les erreurs. Checked, a missing path (or of the wrong type) and a deletion that fails stop the component with an exception. Unchecked, nothing is written and the job goes on: only CURRENT_STATUS tells it. See the errors.
Supprimer le dossierDelete FolderFOLDER NonNo Supprimer le fichier ou le dossier décochéDelete File Or Folder unchecked Supprime le Répertoire au lieu d'un fichier. Deletes the Directory instead of a file.
Supprimer le fichier ou le dossierDelete File Or FolderFOLDER_FILE NonNo ToujoursAlways Accepte un fichier ou un dossier (Fichier ou répertoire à supprimer) ; masque Supprimer le dossier. Accepts a file or a folder (File or Directory to delete); hides Delete Folder.

Variables globales et étatsGlobal variables and statuses

CURRENT_STATUS String
Ce qui s'est passé (voir le tableau). Mis à jour à chaque suppression : dans un flux, ligne par ligne.What happened (see the table). Updated at each deletion: in a flow, row by row.
DELETE_PATH String
Le chemin demandé, tel qu'écrit dans le paramètre (pas forcément absolu). Disponible après le composant.The requested path, as written in the setting (not always absolute). Available after the component.
ERROR_MESSAGE String
Le message de l'exception, quand Échec sur erreur arrête le composant. Case décochée, il reste null ; d'après le code du composant, il est aussi rempli quand Log4j est activé dans le projet.The message of the exception, when Fail on error stops the component. Box unchecked, it stays null; according to the component code, it is also filled when Log4j is activated in the project.
((String) globalMap.get("tFileDelete_1_CURRENT_STATUS"))
((String) globalMap.get("tFileDelete_1_DELETE_PATH"))

Valeurs de CURRENT_STATUSCURRENT_STATUS values

Reprises du code du composant (une note de l'onglet Composant les résume) : Taken from the component code (a note in the Component tab sums them up):

ModeMode SuppriméDeleted Pas suppriméNot deleted Absent ou mauvais typeMissing or wrong type
FichierFileFile deleted.No file deleted.File does not exist or is invalid.
DossierFolderPath deleted.No path deleted.Path does not exist or is invalid.
Fichier ou dossierFile or folderFile deleted. / Path deleted.No file deleted. / No path deleted.File or path does not exist or is invalid.

ExemplesExamples

Les chemins sont écrits à partir de la variable de contexte folder, raccourcie ici en C:/work, comme dans les sorties. Sauf mention contraire, un tJava relié par On Subjob Ok affiche les variables ; les sorties sont celles de la console, copiées depuis une exécution du job sous Windows. Paths are written from the folder context variable, shortened here to C:/work, as in the outputs. Unless stated otherwise, a tJava connected with On Subjob Ok prints the variables; the outputs are the console ones, copied from a run of the job on Windows.

System.out.println("CURRENT_STATUS: " + globalMap.get("tFileDelete_1_CURRENT_STATUS"));
System.out.println("DELETE_PATH: " + globalMap.get("tFileDelete_1_DELETE_PATH"));
System.out.println("ERROR_MESSAGE: " + globalMap.get("tFileDelete_1_ERROR_MESSAGE"));

Supprimer un fichierDelete a file

Nom de fichier : context.folder + "/in/old.csv", réglages par défaut. File Name: context.folder + "/in/old.csv", default settings.

CURRENT_STATUS: File deleted.
DELETE_PATH: C:/work/in/old.csv
ERROR_MESSAGE: null

Fichier absent, sans échecMissing file, without failing

Nom de fichier : context.folder + "/in/missing.csv", Échec sur erreur décoché. File Name: context.folder + "/in/missing.csv", Fail on error unchecked.

CURRENT_STATUS: File does not exist or is invalid.
DELETE_PATH: C:/work/in/missing.csv
ERROR_MESSAGE: null

Aucun message du composant ; le job se termine avec le code 0. Même état si le chemin est un dossier. No message from the component; the job ends with code 0. Same status if the path is a folder.

Supprimer un dossierDelete a folder

Supprimer le dossier coché, Répertoire : context.folder + "/tmp". Avant et après : Delete Folder checked, Directory: context.folder + "/tmp". Before and after:

keep.txt
tmp/
  a.txt
  empty/
  sub/
    b.txt
    deeper/
      c.txt
keep.txt
CURRENT_STATUS: Path deleted.
DELETE_PATH: C:/work/tmp
ERROR_MESSAGE: null

Fichier ou dossierFile or folder

OnSubjobOk OnSubjobOk tFileDelete_1 tFileDelete_2 tJava_1

Les deux avec Supprimer le fichier ou le dossier coché ; tFileDelete_1 sur context.folder + "/in/old.csv", un fichier, tFileDelete_2 sur context.folder + "/tmp", un dossier non vide. Both with Delete File Or Folder checked; tFileDelete_1 on context.folder + "/in/old.csv", a file, tFileDelete_2 on context.folder + "/tmp", a folder that is not empty.

System.out.println("tFileDelete_1: " + globalMap.get("tFileDelete_1_CURRENT_STATUS"));
System.out.println("tFileDelete_2: " + globalMap.get("tFileDelete_2_CURRENT_STATUS"));
tFileDelete_1: File deleted.
tFileDelete_2: Path deleted.

Les fichiers *.tmp d'un dossierThe *.tmp files of a folder

Iterate OnComponentOk tFileList_1 tFileDelete_1 tJava_1

in contient a.tmp, b.tmp et keep.csv. tFileList : Répertoire context.folder + "/in", masque "*.tmp". tFileDelete : Nom de fichier ((String) globalMap.get("tFileList_1_CURRENT_FILEPATH")). in holds a.tmp, b.tmp and keep.csv. tFileList: Directory context.folder + "/in", mask "*.tmp". tFileDelete: File Name ((String) globalMap.get("tFileList_1_CURRENT_FILEPATH")).

System.out.println(globalMap.get("tFileList_1_CURRENT_FILE") + ": "
    + globalMap.get("tFileDelete_1_CURRENT_STATUS"));
a.tmp: File deleted.
b.tmp: File deleted.

Il ne reste que keep.csv. Only keep.csv is left.

Une suppression par ligne d'un fluxOne deletion per row of a flow

row1 (Main) row2 (Main) tFixedFlowInput_1 tFileDelete_1 tJavaRow_1

Trois lignes, colonne name : a.tmp, missing.tmp (absent), b.tmp. Nom de fichier : context.folder + "/in/" + row1.name, Échec sur erreur décoché. Three rows, column name: a.tmp, missing.tmp (missing), b.tmp. File Name: context.folder + "/in/" + row1.name, Fail on error unchecked.

// tJavaRow_1
System.out.println(input_row.name + ": " + globalMap.get("tFileDelete_1_CURRENT_STATUS"));
a.tmp: File deleted.
missing.tmp: File does not exist or is invalid.
b.tmp: File deleted.

ErreursErrors

Avec Échec sur erreur coché (défaut). Le nom du job est remplacé par MyJob, les chemins sont raccourcis en C:/work et les traces d'exception abrégées. Le message donne le chemin absolu, avec des \ sous Windows. With Fail on error checked (default). The job name is replaced with MyJob, the paths are shortened to C:/work and the exception traces are shortened. The message gives the absolute path, with \ on Windows.

Fichier absentMissing file

Nom de fichier : context.folder + "/in/missing.csv". File Name: context.folder + "/in/missing.csv".

Exception in component tFileDelete_1 (MyJob)
java.lang.RuntimeException: File C:\work\in\missing.csv does not exist or is invalid or is not a file.
	at demo.myjob_0_1.MyJob.tFileDelete_1Process(MyJob.java:469)
	…

Le job s'arrête avec le code 1 ; le sous-job suivant ne s'exécute pas. The job stops with code 1; the next subjob does not run.

Erreur traitée par On Component ErrorError handled by On Component Error

OnComponentError tFileDelete_1 tJava_1
System.out.println("Error caught: " + globalMap.get("tFileDelete_1_ERROR_MESSAGE"));
System.out.println("CURRENT_STATUS: " + globalMap.get("tFileDelete_1_CURRENT_STATUS"));
Exception in component tFileDelete_1 (MyJob)
java.lang.RuntimeException: File C:\work\in\missing.csv does not exist or is invalid or is not a file.
	…
Error caught: File C:\work\in\missing.csv does not exist or is invalid or is not a file.
CURRENT_STATUS: File does not exist or is invalid.

L'exception est écrite, puis le job continue par le lien d'erreur et se termine avec le code 0. The exception is written, then the job goes on through the error link and ends with code 0.

Fichier ouvertOpen file

Un tJava, relié par On Subjob Ok, ouvre d'abord in/locked.csv en lecture (new java.io.FileInputStream(…)) et le garde ouvert. A tJava, connected with On Subjob Ok, first opens in/locked.csv for reading (new java.io.FileInputStream(…)) and keeps it open.

in/locked.csv is open
Exception in component tFileDelete_1 (MyJob)
java.lang.RuntimeException: File C:\work\in\locked.csv can not be deleted.
	…

Sous Windows, un fichier ouvert par un programme ne se supprime pas. Échec sur erreur décoché, le job continue sans message : On Windows, a file open in a program cannot be deleted. Fail on error unchecked, the job goes on without a message:

in/locked.csv is open
CURRENT_STATUS: No file deleted.
DELETE_PATH: C:/work/in/locked.csv
ERROR_MESSAGE: null

Dossier avec un fichier ouvertFolder with an open file

Supprimer le dossier sur tmp, qui contient a.txt, locked.txt (ouvert par un tJava) et sub/b.txt ; Échec sur erreur décoché. Delete Folder on tmp, which holds a.txt, locked.txt (open in a tJava) and sub/b.txt; Fail on error unchecked.

tmp/locked.txt is open
CURRENT_STATUS: No path deleted.
DELETE_PATH: C:/work/tmp
ERROR_MESSAGE: null

La suppression est partielle : a.txt et sub ont disparu, il reste tmp/locked.txt. Le composant ne revient pas en arrière. The deletion is partial: a.txt and sub are gone, tmp/locked.txt is left. The component does not roll back.

Un fichier en mode dossierA file in folder mode

Supprimer le dossier coché, Répertoire : context.folder + "/in/old.csv", un fichier. Delete Folder checked, Directory: context.folder + "/in/old.csv", a file.

Exception in component tFileDelete_1 (MyJob)
java.lang.RuntimeException: Directory C:\work\in\old.csv does not exist or is invalid or is not a directory.
	…

Le fichier n'est pas supprimé. Pour accepter les deux, cochez Supprimer le fichier ou le dossier. The file is not deleted. To accept both, check Delete File Or Folder.

Fichier ou dossier absentMissing file or folder

Supprimer le fichier ou le dossier coché, chemin context.folder + "/nothing". Delete File Or Folder checked, path context.folder + "/nothing".

Exception in component tFileDelete_1 (MyJob)
java.lang.RuntimeException: File or path does not exist or is invalid.
	…

Dans ce mode, le message ne donne pas le chemin : affichez DELETE_PATH dans le traitement de l'erreur. In this mode, the message does not give the path: print DELETE_PATH in the error handling.

Conseils et limitesTips and limits

Échec sur erreur, coché par défautFail on error, checked by default

Contrairement au tFileCopy, un fichier absent arrête le job. Pour un nettoyage qui ne doit pas échouer (le fichier n'existe pas toujours), décochez la case. Unlike the tFileCopy, a missing file stops the job. For a clean-up that must not fail (the file does not always exist), uncheck the box.

Case décochée : rien n'est écritBox unchecked: nothing is written

Sans Échec sur erreur, une suppression impossible ne laisse ni message ni ERROR_MESSAGE. Testez l'état dans un Run if : "File deleted.".equals(globalMap.get("tFileDelete_1_CURRENT_STATUS")). Without Fail on error, a deletion that fails leaves neither a message nor ERROR_MESSAGE. Test the status in a Run if: "File deleted.".equals(globalMap.get("tFileDelete_1_CURRENT_STATUS")).

Supprimer selon un masqueDelete by mask

Le tFileDelete ne connaît pas les masques : "*.tmp" est pris comme un nom de fichier. Pour supprimer une partie des fichiers d'un dossier, faites-le parcourir par un tFileList. The tFileDelete does not know masks: "*.tmp" is taken as a file name. To delete some of the files of a folder, have a tFileList go through it.

Fichiers temporairesTemporary files

Pour un fichier de travail qui doit disparaître à la fin du job, un tCreateTemporaryFile le supprime de lui-même, même quand le job échoue. For a work file that must disappear at the end of the job, a tCreateTemporaryFile deletes it on its own, even when the job fails.

Voir aussiSee also