Class Connect


  • public class Connect
    extends java.lang.Object

    Überschrift: Connect.

    Beschreibung: Zielunabhängige Verbindung zum Archiv. Diese Klasse wird als Singleton realisiert.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Schließt die Verbindung, z.B. für die Abmeldung am Client.
      java.lang.String getBarcodes​(java.io.File file)
      Liefert einen String mit den vorhandenen Barcodes der angegebenen Datei zurück.
      boolean getBooleanConfig​(java.lang.String key)
      Liest einen benannten booleschen Wert aus.
      java.lang.String getConfig​(java.lang.String key)
      Liest einen benannten Konfigurationswert aus.
      java.lang.String getGroupConfig​(java.lang.String groupKey)
      Liefert den angegebenen Gruppenkonfigurationswert aus.
      java.lang.String[] getGroupInfo​(java.lang.String groupName, java.lang.String userInput, java.lang.String sqlCommand, java.lang.String sqlChannel)
      Ruft die Registered Function zur Ermittlung der Gruppeninformationen auf.
      java.lang.String getGroups()
      Liefert einen String mit den vorhandenen Gruppen zurück.
      java.util.Map<java.lang.String,​java.lang.String> getGroupsConfig()
      Liefert eine HashMap mit den Konfigurationseinträgen für die Gruppennamen zurück.
      java.util.List<IndexLine> getIndexLines​(java.lang.String maskName)
      Liefert die Namen aller Indexzeilen zu einer Maske.
      static Connect getInstance()
      Instanzobjekt des Singleton holen.
      IXconnect getIxConnect()
      Liefert die zugehörige Index Server Verbindung zurück.
      java.util.List<java.lang.String> getMaskNames()
      Holt eine Liste aller Ablage-Verschlagwortungsmasken.
      int getMaxFulltextPages()
      Liefert die maximale Anzahl an Volltextseiten zurück.
      java.util.Map<java.lang.String,​java.lang.String> getRegExConfig()
      Liefert alle Konfigurationseinträge zurück die mit "Title." oder "File."
      java.util.List<java.lang.String> getSearchMaskNames()
      Holt eine Liste aller Such-Verschlagwortungsmasken.
      boolean isAdministrator()
      Meldet, ob der aktuelle Anwender die globalen Kacheln bearbeiten darf.
      boolean isInitOk()
      Prüft, ob die Initialisierung korrekt abgeschlossen werden konnte.
      java.util.Map<java.lang.String,​java.lang.String> loadTile​(java.lang.String tileName)
      Liefert die Eigenschaften der angegebenen Kachel zurück.
      java.util.Map<java.lang.String,​java.lang.String>[] loadTiles()
      Liefert eine Map mit den Definitionen aller vorhandenen Kacheln zurück.
      java.util.Map<java.lang.String,​java.lang.String> mapFromString​(java.lang.String data)
      Wandelt den Memo-Text in die Map Darstellung zur Erzeugung einer neuen Kachel um.
      java.lang.String mapToString​(java.util.Map<java.lang.String,​java.lang.String> map)
      Wandelt die Kachel-Map Darstellung in einen String zur Speicherung im Memo Feld um.
      void setGroups​(java.lang.String groups)
      Setzt die angegebenen Gruppen.
      void setObjKeyData​(de.elo.ix.client.Sord sord, TileData tileData)
      Setzt die Verschlagwortung aus der angegebenen Kachel im Sord-Objekt.
      boolean storeDocument​(TileData data, java.io.File file)
      Speichert ein neues Dokument im Archiv.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getInstance

        public static Connect getInstance()
                                   throws java.lang.Exception
        Instanzobjekt des Singleton holen.
        Returns:
        Instanzobjekt
        Throws:
        java.lang.Exception
      • isInitOk

        public boolean isInitOk()
        Prüft, ob die Initialisierung korrekt abgeschlossen werden konnte.
        Returns:
        Initialisierung erfolgreich
      • getConfig

        public java.lang.String getConfig​(java.lang.String key)
        Liest einen benannten Konfigurationswert aus.
        Parameters:
        key - Schlüssel
        Returns:
        Konfigurationswert
      • getGroupConfig

        public java.lang.String getGroupConfig​(java.lang.String groupKey)
        Liefert den angegebenen Gruppenkonfigurationswert aus.
        Parameters:
        groupKey - Gruppenname
        Returns:
        Gruppenkonfigurationswert
      • getGroupInfo

        public java.lang.String[] getGroupInfo​(java.lang.String groupName,
                                               java.lang.String userInput,
                                               java.lang.String sqlCommand,
                                               java.lang.String sqlChannel)
        Ruft die Registered Function zur Ermittlung der Gruppeninformationen auf.
        Parameters:
        groupName - Gruppenname
        userInput - Benutzereingabe
        sqlCommand - SQL Anfrage
        sqlChannel - SQL Channel
        Returns:
        Liste mit Informationen für die Gruppen
      • getGroups

        public java.lang.String getGroups()
                                   throws java.lang.Exception
        Liefert einen String mit den vorhandenen Gruppen zurück.
        Returns:
        String mit den vorhandenen Gruppen
        Throws:
        java.lang.Exception
      • setGroups

        public void setGroups​(java.lang.String groups)
        Setzt die angegebenen Gruppen.
        Parameters:
        groups - Vorhandene Gruppen
      • getMaxFulltextPages

        public int getMaxFulltextPages()
        Liefert die maximale Anzahl an Volltextseiten zurück.
        Returns:
        Maximale Anzahl an Volltextseiten
      • getRegExConfig

        public java.util.Map<java.lang.String,​java.lang.String> getRegExConfig()
        Liefert alle Konfigurationseinträge zurück die mit "Title." oder "File." beginnen. Diese werden für die Window Title und Dateipfad-Auswertung verwendet.
        Returns:
        Konfigurationseinträge
      • getGroupsConfig

        public java.util.Map<java.lang.String,​java.lang.String> getGroupsConfig()
        Liefert eine HashMap mit den Konfigurationseinträgen für die Gruppennamen zurück.
        Returns:
        HashMap mit Konfigurationseinträgen
      • getBooleanConfig

        public boolean getBooleanConfig​(java.lang.String key)
        Liest einen benannten booleschen Wert aus.
        Parameters:
        key - Schlüssel
        Returns:
        Boolean Konfiguration
      • close

        public void close()
        Schließt die Verbindung, z.B. für die Abmeldung am Client.
      • getMaskNames

        public java.util.List<java.lang.String> getMaskNames()
                                                      throws java.lang.Exception
        Holt eine Liste aller Ablage-Verschlagwortungsmasken.
        Returns:
        Liste aller Verschlagwortungsmasken
        Throws:
        java.lang.Exception
      • getSearchMaskNames

        public java.util.List<java.lang.String> getSearchMaskNames()
                                                            throws java.lang.Exception
        Holt eine Liste aller Such-Verschlagwortungsmasken.
        Returns:
        Liste mit Such-Verschlagwortungsmasken
        Throws:
        java.lang.Exception
      • getBarcodes

        public java.lang.String getBarcodes​(java.io.File file)
                                     throws java.lang.Exception
        Liefert einen String mit den vorhandenen Barcodes der angegebenen Datei zurück.
        Parameters:
        file - Lokale Datei
        Returns:
        String mit den Barcodes
        Throws:
        java.lang.Exception
      • getIndexLines

        public java.util.List<IndexLine> getIndexLines​(java.lang.String maskName)
                                                throws java.lang.Exception
        Liefert die Namen aller Indexzeilen zu einer Maske.
        Parameters:
        maskName - Maskenbezeichnung
        Returns:
        Liste mit Indexzeilen
        Throws:
        java.lang.Exception
      • isAdministrator

        public boolean isAdministrator()
        Meldet, ob der aktuelle Anwender die globalen Kacheln bearbeiten darf.
        Returns:
        aktueller Benutzer darf Kacheln bearbeiten
      • getIxConnect

        public IXconnect getIxConnect()
        Liefert die zugehörige Index Server Verbindung zurück.
        Returns:
        Index Server Verbindung
      • loadTiles

        public java.util.Map<java.lang.String,​java.lang.String>[] loadTiles()
                                                                           throws java.lang.Exception
        Liefert eine Map mit den Definitionen aller vorhandenen Kacheln zurück.
        Returns:
        Map mit den Kacheln Eigenschaften
        Throws:
        java.lang.Exception
      • loadTile

        public java.util.Map<java.lang.String,​java.lang.String> loadTile​(java.lang.String tileName)
        Liefert die Eigenschaften der angegebenen Kachel zurück.
        Parameters:
        tileName - Kachelname
        Returns:
        Map mit den Kacheleigenschaften
      • mapToString

        public java.lang.String mapToString​(java.util.Map<java.lang.String,​java.lang.String> map)
        Wandelt die Kachel-Map Darstellung in einen String zur Speicherung im Memo Feld um.
        Parameters:
        map - Map mit Eigenschaften
        Returns:
        Eigenschaften als String
      • mapFromString

        public java.util.Map<java.lang.String,​java.lang.String> mapFromString​(java.lang.String data)
        Wandelt den Memo-Text in die Map Darstellung zur Erzeugung einer neuen Kachel um.
        Parameters:
        data - Eigenschaften als String
        Returns:
        Map mit Eigenschaften
      • storeDocument

        public boolean storeDocument​(TileData data,
                                     java.io.File file)
                              throws java.lang.Exception
        Speichert ein neues Dokument im Archiv.
        Parameters:
        data - Daten der Kachel
        file - lokale Datei
        Returns:
        Ergebnis der Archivierung
        Throws:
        java.lang.Exception
      • setObjKeyData

        public void setObjKeyData​(de.elo.ix.client.Sord sord,
                                  TileData tileData)
        Setzt die Verschlagwortung aus der angegebenen Kachel im Sord-Objekt.
        Parameters:
        sord - Sord Objekt
        tileData - Daten der Kachel