Package de.elo.mover.main.helper

Class SordHelper

  • public class SordHelper
extends java.lang.Object

    Überschrift: SordHelper.

    Beschreibung: Hilfsklasse für die Verschlagwortung von Archiveinträgen.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      SordHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static de.elo.ix.client.ObjKey[] addObjKey​(de.elo.ix.client.ObjKey[] objKeys, de.elo.ix.client.ObjKey objKey)
      Fügt das angegebene ObjKey-Objekt in der Liste mit den ObjKeys ein.
      static de.elo.ix.client.Sord createNewSord​(IXconnect ixConnect, java.lang.String maskName)
      Liefert ein neues Sord-Objekt mit Hilfe der IX-Methode "createDoc".
      static java.lang.String formatObjKeyData​(de.elo.ix.client.ObjKey objKey)
      Wandelt die Daten des ObjKey in einen String um.
      static java.util.ArrayList<de.elo.ix.client.SordType> getAllSordTypes​(IXconnect ixConnect)
      Liefert eine Liste mit allen vorhandenen SordType Objekten zurück.
      static java.util.ArrayList<de.elo.ix.client.Sord> getChildren​(IXconnect ixConnect, int folderId)
      Liefert eine Liste mit den Untereinträgen des angegebenen Ordners zurück.
      static de.elo.ix.client.Sord getDefaultIndexing​(IXconnect ixConnect, int maskId)
      Liefert eine Standardverschlagwortung für ein Dokument mit der angegebenen Maske.
      static java.lang.String getDocumentExtension​(IXconnect ixConnect, int objId)
      Liefert die Dateiendung des angegebenen Archivdokuments zurück.
      static de.elo.ix.client.Sord[] getDocuments​(de.elo.ix.client.Sord[] sords)
      Liefert eine Liste mit den Archivdokumenten aus den angegebenen Archiveinträgen zurück.
      static java.lang.String getFileNameFromSord​(de.elo.ix.client.Sord sord)
      Liefert den Dateinamen aus der angegebenen Verschlagwortung zurück.
      static int getMaxUsedIndex​(de.elo.ix.client.Sord sord, boolean withInvisible)
      Gibt die Nummer des letzten genutzten Indexfeldes zurück.
      static de.elo.ix.client.Sord[] getNewerThan​(de.elo.ix.client.Sord[] sords, long time)
      Liefert die Archiveinträge zurück, deren Zeitstempel neuer als das angegebene Datum ist.
      static java.lang.String[] getObjKeyData​(de.elo.ix.client.Sord sord, int objKeyId)
      Liefert den Inhalt der angegebenen Indexzeile zurück.
      static java.lang.String[] getObjKeyData​(de.elo.ix.client.Sord sord, java.lang.String objKeyGroupName)
      Liefert den Inhalt der angegebenen Indexzeile zurück.
      static de.elo.ix.client.Sord[] getStructures​(de.elo.ix.client.Sord[] sords)
      Liefert eine Liste mit den Strukturelementen aus den angegebenen Archiveinträgen zurück.
      static boolean isCrypted​(de.elo.ix.client.Sord sord)
      Prüft, ob das Dokument verschlüsselt ist.
      static boolean isDocument​(int objType)
      Meldet zurück, ob der angegebene Objekttyp ein Dokumenttyp ist.
      static boolean isDocument​(de.elo.ix.client.Sord sord)
      Meldet zurück, ob der angegebene Archiveintrag ein Dokument ist.
      static boolean isDynamicRegister​(de.elo.ix.client.Sord sord)
      Meldet zurück, ob der angegebene Archiveintrag ein dynamisches Register ist.
      static boolean isEmptyStructure​(de.elo.ix.client.Sord sord)
      Meldet zurück, ob der angegebene Archiveintrag ein Ordner ist und keine Untereinträge enthält.
      static boolean isLocked​(de.elo.ix.client.Sord sord)
      Gibt an, ob der Archiveintrag gesperrt ist.
      static boolean isReadOnly​(de.elo.ix.client.Sord sord)
      True, wenn das Sord-Objekt ein revisionssicher abgelegtes Dokument ist.
      static boolean isReference​(IXconnect ixConnect, int objId, int currParentId)
      Meldet zurück, ob der angegebene Archiveintrag eine Referenz ist.
      static boolean isReference​(IXconnect ixConnect, de.elo.ix.client.Sord sord, int currParentId)
      Meldet zurück, ob der angegebene Archiveintrag eine Referenz ist.
      static boolean isStructure​(int objType)
      Meldet zurück, ob der angegebene Objekttyp kein Dokumententyp ist.
      static boolean isStructure​(de.elo.ix.client.Sord sord)
      Meldet zurück, ob der angegebene Archiveintrag ein Ordner ist.
      static boolean removeReference​(IXconnect ixConnect, int objId, int referNr)
      Löscht die Referenz des angegebenen Archiveintrags und liefert das Löschergebnis zurück.
      static boolean removeReferences​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
      Entfernt alle vorhandenen Referenzen des angegebenen Archiveintrags.
      static void setExifData​(IXconnect ixConnect, de.elo.ix.client.Sord sord, java.io.File file)
      Setzt die EXIF-Daten aus der Bilddatei im angegebenen Verschlagwortungsobjekt.
      static void setFileExtInSord​(de.elo.ix.client.Sord sord, de.elo.ix.client.SordType[] sordTypes, java.lang.String fileName)
      Setzt die Dateiendung im angegebenen Sord-Objekt.
      static void setFileNameInSord​(de.elo.ix.client.Sord sord, java.lang.String fileName)
      Setzt den Dateinamen im angegebenen Sord-Objekt ein.
      static void setLockState​(IXconnect ixConnect, int objId, boolean locked)
      Setzt den Status des angegebenen Archiveintrags.
      static void setObjKeyData​(de.elo.ix.client.Sord sord, int objKeyId, java.lang.String[] data)
      Setzt den Inhalt der angegebenen Indexzeile.
      static void setObjKeyData​(de.elo.ix.client.Sord sord, java.lang.String objKeyGroupName, java.lang.String[] data)
      Setzt den Inhalt der angegebenen Indexzeile.
      static void setReadOnly​(IXconnect ixConnect, int objId)
      Setzt die ReadOnly Eigenschaft für den angegebenen Archiveintrag.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SordHelper

        public SordHelper()

    • Method Detail

      • getFileNameFromSord

        public static java.lang.String getFileNameFromSord​(de.elo.ix.client.Sord sord)
                                            throws java.lang.Exception
        Liefert den Dateinamen aus der angegebenen Verschlagwortung zurück.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        Dateinamen oder null
        Throws:
        java.lang.Exception

      • setFileNameInSord

        public static void setFileNameInSord​(de.elo.ix.client.Sord sord,
                                     java.lang.String fileName)
                              throws java.lang.Exception
        Setzt den Dateinamen im angegebenen Sord-Objekt ein.
        Parameters:
        sord - Archivelement
        fileName - Dateiname
        Throws:
        java.lang.Exception

      • setFileExtInSord

        public static void setFileExtInSord​(de.elo.ix.client.Sord sord,
                                    de.elo.ix.client.SordType[] sordTypes,
                                    java.lang.String fileName)
                             throws java.lang.Exception
        Setzt die Dateiendung im angegebenen Sord-Objekt.
        Parameters:
        sord - Verschlagwortung eines Archiveintrags
        sordTypes - Liste mit Dateiendungen
        fileName - Dateiname
        Throws:
        java.lang.Exception

      • getDocumentExtension

        public static java.lang.String getDocumentExtension​(IXconnect ixConnect,
                                                    int objId)
                                             throws java.lang.Exception
        Liefert die Dateiendung des angegebenen Archivdokuments zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archivdokuments
        Returns:
        Dateiendung des Archivdokuments
        Throws:
        java.lang.Exception

      • isDocument

        public static boolean isDocument​(de.elo.ix.client.Sord sord)
                          throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag ein Dokument ist.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        Archiveintrag ist ein Dokument
        Throws:
        java.lang.Exception

      • isDocument

        public static boolean isDocument​(int objType)
                          throws java.lang.Exception
        Meldet zurück, ob der angegebene Objekttyp ein Dokumenttyp ist.
        Parameters:
        objType - Zu prüfenden Dokumententyp
        Returns:
        Dokumententyp
        Throws:
        java.lang.Exception

      • isStructure

        public static boolean isStructure​(de.elo.ix.client.Sord sord)
                           throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag ein Ordner ist.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        Archiveintrag ist ein Ordner
        Throws:
        java.lang.Exception

      • isStructure

        public static boolean isStructure​(int objType)
                           throws java.lang.Exception
        Meldet zurück, ob der angegebene Objekttyp kein Dokumententyp ist.
        Parameters:
        objType - Objekttyp
        Returns:
        Objekttyp ist kein Dokumenttyp
        Throws:
        java.lang.Exception

      • isEmptyStructure

        public static boolean isEmptyStructure​(de.elo.ix.client.Sord sord)
                                throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag ein Ordner ist und keine Untereinträge enthält.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        Ordner ohne Unterelemente
        Throws:
        java.lang.Exception

      • isDynamicRegister

        public static boolean isDynamicRegister​(de.elo.ix.client.Sord sord)
                                 throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag ein dynamisches Register ist.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        True, falls das Sord Objekt ein dynamisches Register ist
        Throws:
        java.lang.Exception

      • isLocked

        public static boolean isLocked​(de.elo.ix.client.Sord sord)
                        throws java.lang.Exception
        Gibt an, ob der Archiveintrag gesperrt ist.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        True bei einer gesetzten Sperre, sonst False
        Throws:
        java.lang.Exception

      • setLockState

        public static void setLockState​(IXconnect ixConnect,
                                int objId,
                                boolean locked)
                         throws java.lang.Exception
        Setzt den Status des angegebenen Archiveintrags.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Objekt ID des Archiveintrags
        locked - Sperren/Entsperren
        Throws:
        java.lang.Exception

      • isCrypted

        public static boolean isCrypted​(de.elo.ix.client.Sord sord)
                         throws java.lang.Exception
        Prüft, ob das Dokument verschlüsselt ist.
        Parameters:
        sord - Verschlagwortung eines Archivelements
        Returns:
        True, wenn verschlüsselt
        Throws:
        java.lang.Exception

      • isReadOnly

        public static boolean isReadOnly​(de.elo.ix.client.Sord sord)
                          throws java.lang.Exception
        True, wenn das Sord-Objekt ein revisionssicher abgelegtes Dokument ist. Dann darf die Verschlagwortung unabhängig von den Rechten nicht geändert werden, ein Schreibrecht bezieht sich nur auf das Ändern der ACL.
        Parameters:
        sord - Verschlagwortung des Archiveintrags
        Returns:
        Revisionssicheren Archiveintrag
        Throws:
        java.lang.Exception

      • setReadOnly

        public static void setReadOnly​(IXconnect ixConnect,
                               int objId)
                        throws java.lang.Exception
        Setzt die ReadOnly Eigenschaft für den angegebenen Archiveintrag.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Objekt ID des Archiveintrags
        Throws:
        java.lang.Exception

      • isReference

        public static boolean isReference​(IXconnect ixConnect,
                                  int objId,
                                  int currParentId)
                           throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag eine Referenz ist.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        currParentId - Id des aktuellen übergeordneten Ordners
        Returns:
        Archiveintrag ist eine Referenz
        Throws:
        java.lang.Exception

      • isReference

        public static boolean isReference​(IXconnect ixConnect,
                                  de.elo.ix.client.Sord sord,
                                  int currParentId)
                           throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag eine Referenz ist.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung des Archiveintrags
        currParentId - Id des aktuellen übergeordneten Ordners
        Returns:
        Archiveintrag ist eine Referenz
        Throws:
        java.lang.Exception

      • createNewSord

        public static de.elo.ix.client.Sord createNewSord​(IXconnect ixConnect,
                                                  java.lang.String maskName)
                                           throws java.rmi.RemoteException,
                                                  java.lang.Exception
        Liefert ein neues Sord-Objekt mit Hilfe der IX-Methode "createDoc".
        Parameters:
        ixConnect - Index Server Verbindung
        maskName - Bezeichnung der Verschlagwortungsmaske
        Returns:
        Default-Verschlagwortung
        Throws:
        java.rmi.RemoteException
        java.lang.Exception

      • getObjKeyData

        public static java.lang.String[] getObjKeyData​(de.elo.ix.client.Sord sord,
                                               int objKeyId)
                                        throws java.lang.Exception
        Liefert den Inhalt der angegebenen Indexzeile zurück.
        Parameters:
        sord - Verschlagwortung eines Archiveintrags
        objKeyId - Id der Indexzeile
        Returns:
        Daten der Indexzeile oder null
        Throws:
        java.lang.Exception

      • getObjKeyData

        public static java.lang.String[] getObjKeyData​(de.elo.ix.client.Sord sord,
                                               java.lang.String objKeyGroupName)
                                        throws java.lang.Exception
        Liefert den Inhalt der angegebenen Indexzeile zurück.
        Parameters:
        sord - Verschlagwortung eines Archiveintrags
        objKeyGroupName - Gruppenbezeichnung der Indexzeile
        Returns:
        Daten der Indexzeile oder null
        Throws:
        java.lang.Exception

      • setObjKeyData

        public static void setObjKeyData​(de.elo.ix.client.Sord sord,
                                 int objKeyId,
                                 java.lang.String[] data)
                          throws java.lang.Exception
        Setzt den Inhalt der angegebenen Indexzeile.
        Parameters:
        sord - Verschlagwortung eines Archiveintrags
        objKeyId - Id der Indexzeilen
        data - Inhalt der Indexzeile
        Throws:
        java.lang.Exception

      • setObjKeyData

        public static void setObjKeyData​(de.elo.ix.client.Sord sord,
                                 java.lang.String objKeyGroupName,
                                 java.lang.String[] data)
                          throws java.lang.Exception
        Setzt den Inhalt der angegebenen Indexzeile.
        Parameters:
        sord - Verschlagwortung eines Archiveintrags
        objKeyGroupName - Gruppenbezeichnung der Indexzeile
        data - Inhalt der Indexzeile
        Throws:
        java.lang.Exception

      • formatObjKeyData

        public static java.lang.String formatObjKeyData​(de.elo.ix.client.ObjKey objKey)
                                         throws java.lang.Exception
        Wandelt die Daten des ObjKey in einen String um. Falls ein Spaltenindex verwendet ist, werden die dafür notwendigen Pilcrow zwischen den Spalten eingefügt.
        Parameters:
        objKey - Indexzeile
        Returns:
        Inhalt der Indexzeile als String
        Throws:
        java.lang.Exception

      • getDocuments

        public static de.elo.ix.client.Sord[] getDocuments​(de.elo.ix.client.Sord[] sords)
                                            throws java.lang.Exception
        Liefert eine Liste mit den Archivdokumenten aus den angegebenen Archiveinträgen zurück.
        Parameters:
        sords - Liste mit Archiveinträgen
        Returns:
        Liste mit Archivdokumenten
        Throws:
        java.lang.Exception

      • getStructures

        public static de.elo.ix.client.Sord[] getStructures​(de.elo.ix.client.Sord[] sords)
                                             throws java.lang.Exception
        Liefert eine Liste mit den Strukturelementen aus den angegebenen Archiveinträgen zurück.
        Parameters:
        sords - Liste mit Archiveinträgen
        Returns:
        Liste mit Strukturelementen
        Throws:
        java.lang.Exception

      • getDefaultIndexing

        public static de.elo.ix.client.Sord getDefaultIndexing​(IXconnect ixConnect,
                                                       int maskId)
                                                throws java.lang.Exception
        Liefert eine Standardverschlagwortung für ein Dokument mit der angegebenen Maske.
        Parameters:
        ixConnect - Index Server Verbindung
        maskId - Maske zu der eine Verschlagwortung benötigt wird.
        Returns:
        Standardverschlagwortung mit den Eigenschaften der Maske
        Throws:
        java.lang.Exception

      • getMaxUsedIndex

        public static int getMaxUsedIndex​(de.elo.ix.client.Sord sord,
                                  boolean withInvisible)
                           throws java.lang.Exception
        Gibt die Nummer des letzten genutzten Indexfeldes zurück.
        Parameters:
        sord - Sord zu prüfendes Objekt
        withInvisible - unsichtbare Zeilen berücksichtigen
        Returns:
        Letzter Index
        Throws:
        java.lang.Exception

      • setExifData

        public static void setExifData​(IXconnect ixConnect,
                               de.elo.ix.client.Sord sord,
                               java.io.File file)
                        throws java.lang.Exception
        Setzt die EXIF-Daten aus der Bilddatei im angegebenen Verschlagwortungsobjekt.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung eines Archiveintrags
        file - Bild-Datei
        Throws:
        java.lang.Exception

      • removeReferences

        public static boolean removeReferences​(IXconnect ixConnect,
                                       de.elo.ix.client.Sord sord)
                                throws java.lang.Exception
        Entfernt alle vorhandenen Referenzen des angegebenen Archiveintrags.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung eines Archiveintrags
        Returns:
        Ergebnis des Löschvorgangs
        Throws:
        java.lang.Exception

      • removeReference

        public static boolean removeReference​(IXconnect ixConnect,
                                      int objId,
                                      int referNr)
                               throws java.lang.Exception
        Löscht die Referenz des angegebenen Archiveintrags und liefert das Löschergebnis zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        referNr - Referenznummer
        Returns:
        Löschergebnis
        Throws:
        java.lang.Exception

      • getChildren

        public static java.util.ArrayList<de.elo.ix.client.Sord> getChildren​(IXconnect ixConnect,
                                                                     int folderId)
                                                              throws java.lang.Exception
        Liefert eine Liste mit den Untereinträgen des angegebenen Ordners zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        folderId - ID des Ordners
        Returns:
        Liste mit Untereinträgen
        Throws:
        java.lang.Exception

      • getAllSordTypes

        public static java.util.ArrayList<de.elo.ix.client.SordType> getAllSordTypes​(IXconnect ixConnect)
                                                                      throws java.lang.Exception
        Liefert eine Liste mit allen vorhandenen SordType Objekten zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit allen SordType Objekten
        Throws:
        java.lang.Exception

      • getNewerThan

        public static de.elo.ix.client.Sord[] getNewerThan​(de.elo.ix.client.Sord[] sords,
                                                   long time)
                                            throws java.lang.Exception
        Liefert die Archiveinträge zurück, deren Zeitstempel neuer als das angegebene Datum ist.
        Parameters:
        sords - Liste mit Archiveinträgen
        time - Datum
        Returns:
        Liste mit Archiveinträgen, die neuer als das angegebene Datum sind
        Throws:
        java.lang.Exception

      • addObjKey

        public static de.elo.ix.client.ObjKey[] addObjKey​(de.elo.ix.client.ObjKey[] objKeys,
                                                  de.elo.ix.client.ObjKey objKey)
                                           throws java.lang.Exception
        Fügt das angegebene ObjKey-Objekt in der Liste mit den ObjKeys ein.
        Parameters:
        objKeys - Liste mit ObjKeys
        objKey - ObjKey
        Returns:
        Neue Liste mit ObjKeys
        Throws:
        java.lang.Exception