Package de.elo.mover.main.helper

Class FileHelper

java.lang.Object
de.elo.mover.main.helper.FileHelper
public class FileHelper extends Object

Überschrift: FileHelper.

Beschreibung: Hilfsmethoden für Dateioperationen.

Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2021

  • Constructor Details

    • FileHelper

      public FileHelper()

  • Method Details

    • getUniqueFile

      public static File getUniqueFile(File dir, String nameWithExt) throws Exception
      Sucht im Zielverzeichnis nach einem unbenutzten Dateinamen nach einer Namensvorgabe. Falls die Namensvorgabe noch nicht vorhanden ist, wird sie direkt verwendet. Wenn sie vorhanden ist, dann wird sie um einen Zähler ergänzt. Nicht erlaubte Zeichen im Namen werden durch einen Unterstrich ersetzt.
      Parameters:
      dir - Verzeichnis in dem die Datei erstellt werden soll
      nameWithExt - Name der Datei ohne den Dateipfad
      Returns:
      eindeutige Datei
      Throws:
      Exception

    • replaceIllegalChars

      public static String replaceIllegalChars(String input, char replaceChar) throws Exception
      Ersetzt die Zeichen, die nicht in einem Dateinamen vorhanden sein dürfen, durch das angegebene Zeichen. Bei der Angabe von '0' wird der Unterstrich als Ersatzzeichen verwendet.
      Parameters:
      input - Ursprüngliche Zeichenkette
      replaceChar - Zeichen, durch das die ungültigen Zeichen ersetzt werden
      Returns:
      bereinigte Zeichenkette
      Throws:
      Exception

    • deleteIllegalChars

      public static String deleteIllegalChars(String input)
      Löscht Zeichen, die nicht in einem Dateinamen vorhanden sein dürfen.
      Parameters:
      input - Ursprüngliche Zeichenkette
      Returns:
      bereinigte Zeichenkette

    • getNextFile

      public static File getNextFile(File originalFile, int counter) throws Exception
      Liefert für die angegebene Datei eine neue Datei, deren Namen den angegebenen Zähler enthält.
      Parameters:
      originalFile - Datei
      counter - Zähler
      Returns:
      Neue Datei
      Throws:
      Exception

    • stripPath

      public static String stripPath(String fileName) throws Exception
      Gibt den Dateinamen ohne den Pfad zurück. Wenn kein Pfad-Separator vorhanden ist, dann wird der ganze Ausdruck als Dateiname angesehen (und nicht als Pfad ohne Dateiname).
      Parameters:
      fileName - Kompletter Dateipfad
      Returns:
      Dateiname ohne Pfad
      Throws:
      Exception

    • getPath

      public static String getPath(String fileName) throws Exception
      Gibt den Pfadanteil eines kompletten Dateinamens zurück. Wenn kein Pfad-Separator vorhanden ist, dann wird der komplette Ausdruck als Pfad angesehen.
      Parameters:
      fileName - Kompletter Dateipfad
      Returns:
      Dateipfad
      Throws:
      Exception

    • getExt

      public static String getExt(File file) throws Exception
      Gibt die Extension eines Dateinamens ohne führenden Punkt zurück. Wenn keine Extension vorhanden ist, dann wird ein Leerstring und keine Null geliefert. Wenn der Dateiname null ist, dann wird eine null zurückgegeben.
      Parameters:
      file - Datei
      Returns:
      Dateiendung ohne führenden Punkt
      Throws:
      Exception

    • getExt

      public static String getExt(String fileName) throws Exception
      Gibt die Extension eines Dateinamens ohne führenden Punkt zurück. Wenn keine Extension vorhanden ist, dann wird ein Leerstring und keine Null geliefert. Wenn der Dateiname null ist, dann wird eine null zurückgegeben.
      Parameters:
      fileName - Dateiname
      Returns:
      String Dateiendung ohne führenden Punkt
      Throws:
      Exception

    • changeExt

      public static File changeExt(File file, String newExt) throws Exception
      Ändert die Extension einer Datei auf eine neue Extension um. Falls die Datei noch keine Extension hatte, wird die neue einfach angefügt.
      Parameters:
      file - Originaldatei mit oder ohne Dateindung
      newExt - Neue Dateiendung, mit oder ohne führenden Punkt
      Returns:
      Neue Datei mit der neuen Dateiendung
      Throws:
      Exception

    • changeExt

      public static String changeExt(String fileName, String newExt) throws Exception
      Ändert die Extension einer Datei auf eine neue Extension um. Falls die Datei noch keine Extension hatte, wird die neue einfach angefügt.
      Parameters:
      fileName - Originalname mit oder ohne Dateiendung
      newExt - Neue Dateiendung, mit oder ohne führenden Punkt
      Returns:
      Neuer Name mit der neuen Dateiendung
      Throws:
      Exception

    • hasExtension

      public static boolean hasExtension(File file, String fileExtension) throws Exception
      True, falls die angegebene Datei die angegebene Dateiendung besitzt.
      Parameters:
      file - Datei
      fileExtension - Dateiendung
      Returns:
      Datei besitzt die Dateiendung
      Throws:
      Exception

    • createEcdFile

      public static File createEcdFile(String repositoryName, de.elo.ix.client.Sord sord) throws Exception
      Erzeugt eine ECD-Datei für den angegebenen Eintrag im temporären JAVA-Verzeichnis.
      Parameters:
      repositoryName - Repository Bezeichnung
      sord - Metadaten des Eintrags
      Returns:
      ECD-Datei
      Throws:
      Exception

    • createEcdFile

      public static File createEcdFile(String repositoryName, de.elo.ix.client.Sord sord, File targetDir) throws Exception
      Erzeugt eine ECD-Datei für den angegebenen Eintrag im angegebenen Verzeichnis.
      Parameters:
      repositoryName - Repository Bezeichnung
      sord - Metadaten des Eintrags
      targetDir - Zielverzeichnis
      Returns:
      ECD-Datei
      Throws:
      Exception

    • createEcdFileForWorkflow

      public static File createEcdFileForWorkflow(IXconnect ixConnect, int flowId, int nodeId, File targetDir) throws Exception
      Erzeugt eine ECD-Datei für den angegebenen Workflow im angegebenen Verzeichnis. Die Navigation zum Workflow erfolgt über den ELO DMS Handler.
      Parameters:
      ixConnect - Indexserver-Verbindung
      flowId - Workflow-ID
      nodeId - Workflowknoten-ID
      targetDir - Zielverzeichnis
      Returns:
      ECD-Datei
      Throws:
      Exception

    • createEcdFileForEntries

      public static File createEcdFileForEntries(String repositoryName, de.elo.ix.client.Sord[] sords, File targetDir) throws Exception
      Liefert eine ECD-Datei für die angegebenen Einträge zurück.
      Parameters:
      repositoryName - Repository Bezeichnung
      sords - Liste mit Einträgen
      targetDir - Zielverzeichnis
      Returns:
      ECD-Datei
      Throws:
      Exception

    • createEcdFile

      public static File createEcdFile(IXconnect ixConnect, int objId, File targetDir) throws Exception
      Erzeugt eine ECD-Datei für die angegebene Objekt-ID im angegebenen Zielverzeichnis.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      targetDir - Zielverzeichnis oder null für das temporäre Java Verzeichnis
      Returns:
      ECD-Datei
      Throws:
      Exception

    • getLegalArchiveElementName

      public static String getLegalArchiveElementName(IXconnect ixConnect, String elemName) throws byps.RemoteException, Exception
      Liefert einen gültigen Namen für Elemente zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      elemName - Bezeichnung des Elements
      Returns:
      Bezeichnung ohne die ungültigen Zeichen
      Throws:
      byps.RemoteException
      Exception

    • getLegalFileName

      public static String getLegalFileName(IXconnect ixConnect, String fileName) throws Exception
      Liefert einen gültigen Dateinamen aus dem übergebenen Dateinamen zurück. Wenn der Dateiname länger als die maximal erlaubte Länge ist dann wird der Name abgeschnitten.
      Parameters:
      ixConnect - Indexserver-Verbindung
      fileName - Dateinamen
      Returns:
      Gültiger Dateiname
      Throws:
      Exception

    • getNameWithoutExtension

      public static String getNameWithoutExtension(String filePath) throws Exception
      Liefert zu einem kompletten Dateipfad wie "C:\temp\Testfiles\Test.txt" den Dateinamen ohne Dateiendung, im Beispiel also "Test".
      Parameters:
      filePath - Kompletter Dateipfad
      Returns:
      Dateiname ohne Endung
      Throws:
      Exception

    • getLegalAttachmentFileName

      public static String getLegalAttachmentFileName(IXconnect ixConnect, String attachFileName) throws Exception
      Liefert eine falls notwendig abgekürzte Dateibezeichnung zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      attachFileName - Dateiname
      Returns:
      Bezeichnung der Dateianbindung
      Throws:
      Exception

    • getEswFile

      public static File getEswFile(File file) throws Exception
      Liefert die es8-Datei für die angegebene Datei zurück.
      Parameters:
      file - Datei
      Returns:
      es8-Datei
      Throws:
      Exception

    • getIndexFile

      public static File getIndexFile(File file) throws Exception
      Liefert die Index-Datei für die angegebene Datei zurück.
      Parameters:
      file - Dokumentendatei
      Returns:
      Indexdatei
      Throws:
      Exception

    • getEtfFile

      public static File getEtfFile(File file) throws Exception
      Liefert die ETF-Datei zu der angegebenen Datei zurück.
      Parameters:
      file - Datei
      Returns:
      File ETF-Datei
      Throws:
      Exception

    • getEwfFile

      public static File getEwfFile(File file) throws Exception
      Liefert die ewf-Datei zur angegebenen Datei zurück.
      Parameters:
      file - normale Datei
      Returns:
      File ewf-Datei
      Throws:
      Exception

    • getLockFile

      public static File getLockFile(File file) throws Exception
      Liefert die lock-Datei zur angegebenen Datei zurück.
      Parameters:
      file - normale Datei
      Returns:
      lock-Datei
      Throws:
      Exception

    • getTempDir

      public static File getTempDir()
      Liefert das temporäre Java Verzeichnis zurück.
      Returns:
      Temporäres Java Verzeichnis

    • getFileContentMap

      public static HashMap<String,String> getFileContentMap(File file) throws Exception
      Liefert eine HashMap mit dem Dateiinhalt zurück.
      Parameters:
      file - Datei mit den Textbegriffen (z.B. ini-Datei)
      Returns:
      HashMap mit dem Dateiinhalt
      Throws:
      Exception

    • getFileLines

      public static ArrayList<String> getFileLines(File file) throws Exception
      Liefert eine Liste mit den Zeilen der angegebenen Datei zurück. Die Datei soll in UTF-8 Format vorliegen und kann mit einem BOM anfangen. Leere Zeilen und Kommentarzeilen werden ignoriert.
      Parameters:
      file - Zu lesende Datei
      Returns:
      Liste mit den Zeilen der Datei
      Throws:
      Exception

    • getValue

      public static String getValue(File iniFile, String key) throws Exception
      Liefert den Wert des angegebenen Schlüssels zurück.
      Parameters:
      iniFile - INI-Datei
      key - Schlüssel
      Returns:
      Wert oder null
      Throws:
      Exception

    • deleteFiles

      public static void deleteFiles(List<File> files) throws Exception
      Löscht die angegebenen Dateien.
      Parameters:
      files - Liste mit Dateien
      Throws:
      Exception

    • deleteDirectoryFiles

      public static boolean deleteDirectoryFiles(File directory) throws Exception
      Löscht die vorhandenen Elemente im angegebenen Verzeichnis und meldet zurück, ob alle Elemente gelöscht wurden.
      Parameters:
      directory - Verzeichnis
      Returns:
      alle Unterelemente wurden gelöscht
      Throws:
      Exception

    • deleteTempFileAndFolder

      public static boolean deleteTempFileAndFolder(File tempFile) throws Exception
      Löscht die angegebene temporäre Datei mit dem übergeordneten Ordner.
      Parameters:
      tempFile - temporäre Datei
      Returns:
      Beide Dateien wurden gelöscht
      Throws:
      Exception

    • getRootFiles

      public static ArrayList<File> getRootFiles()
      Liefert eine Liste mit den Hauptverzeichnissen auf dem System zurück.
      Returns:
      Liste mit Hauptverzeichnissen

    • hasFullAccess

      public static boolean hasFullAccess(File file) throws Exception
      Meldet zurück, ob auf die angegebene Datei normal zugegriffen werden kann.
      Parameters:
      file - Datei
      Returns:
      Datei kann verwendet werden
      Throws:
      Exception

    • getReadableFilesize

      public static String getReadableFilesize(File file) throws Exception
      Liefert die Dateigröße als einen gut für Menschen lesbaren String zurück.
      Parameters:
      file - Datei
      Returns:
      Dateigröße
      Throws:
      Exception

    • addIllegalChar

      public static void addIllegalChar(char c)
      Fügt das angegebene ungültige Zeichen in der internen Liste mit den ungültigen Zeichen ein.
      Parameters:
      c - ungültiges Zeichen

    • getParentFolderByName

      public static File getParentFolderByName(File file, String parentName) throws Exception
      Liefert den übergeordneten Ordner mit dem angegebenen Namen zurück.
      Parameters:
      file - Datei
      parentName - Name des übergeordneten Ordners
      Returns:
      Übergeordneten Ordner
      Throws:
      Exception