Package de.elo.mover.main.helper

Class SordHelper

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

Überschrift: SordHelper.

Beschreibung: Hilfsklasse für die Metadaten von Einträgen.

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

  • Constructor Summary

    Constructors
    Constructor Description
    SordHelper()  

  • Method Summary

    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 boolean deleteEmptyFolder​(IXconnect ixConnect, java.lang.String folderId, java.lang.String parentId)
    Löscht den angegebenen leeren Repository-Ordner.
    static java.lang.String formatObjKeyData​(de.elo.ix.client.ObjKey objKey)
    Wandelt die Felddaten in einen String um.
    static java.lang.String formatObjKeyData2​(java.lang.String[] objKeyData)
    Wandelt die angegebenen "ObjKey"-Daten 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 die Standard-Metadaten für ein Dokument mit der angegebenen Maske.
    static java.lang.String getDocumentExtension​(IXconnect ixConnect, int objId)
    Liefert die Dateiendung des angegebenen Dokuments zurück.
    static de.elo.ix.client.Sord[] getDocuments​(de.elo.ix.client.Sord[] sords)
    Liefert eine Liste mit den Dokumenten aus den angegebenen Einträgen zurück.
    static java.lang.String getFileNameFromSord​(de.elo.ix.client.Sord sord)
    Liefert den Dateinamen aus den angegebenen Metadaten zurück.
    static int getMaxUsedIndex​(de.elo.ix.client.Sord sord, boolean withInvisible)
    Gibt die Nummer des letzten genutzten Feldes zurück.
    static de.elo.ix.client.Sord[] getNewerThan​(de.elo.ix.client.Sord[] sords, long time)
    Liefert die Einträ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 des angegebenen Feldes zurück.
    static java.lang.String[] getObjKeyData​(de.elo.ix.client.Sord sord, java.lang.String objKeyGroupName)
    Liefert den Inhalt des angegebenen Feldes zurück.
    static de.elo.ix.client.Sord[] getStructures​(de.elo.ix.client.Sord[] sords)
    Liefert eine Liste mit den Strukturelementen aus den angegebenen Einträ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 Eintrag ein Dokument ist.
    static boolean isDynamicRegister​(de.elo.ix.client.Sord sord)
    Meldet zurück, ob der angegebene Eintrag ein dynamisches Register ist.
    static boolean isEmptyStructure​(de.elo.ix.client.Sord sord)
    Meldet zurück, ob der angegebene Eintrag ein Ordner ist und keine Untereinträge enthält.
    static boolean isLocked​(de.elo.ix.client.Sord sord)
    Gibt an, ob der Eintrag 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 Eintrag eine Referenz ist.
    static boolean isReference​(IXconnect ixConnect, de.elo.ix.client.Sord sord, int currParentId)
    Meldet zurück, ob der angegebene Eintrag 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 Eintrag ein Ordner ist.
    static boolean removeReference​(IXconnect ixConnect, int objId, int referNr)
    Löscht die Referenz des angegebenen Eintrags und liefert das Löschergebnis zurück.
    static boolean removeReferences​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
    Entfernt alle vorhandenen Referenzen des angegebenen Eintrags.
    static void setDeletionPeriodDate​(de.elo.ix.client.Sord sord, java.lang.String delPeriodIsoDate)
    Setzt das Ende der Löschfrist im angegebenen Eintrag.
    static void setExifData​(IXconnect ixConnect, de.elo.ix.client.Sord sord, java.io.File file)
    Setzt die EXIF-Daten aus der Bilddatei im angegebenen Metadaten-Objekt.
    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 Eintrags.
    static void setObjKeyData​(de.elo.ix.client.Sord sord, int objKeyId, java.lang.String[] data)
    Setzt den Inhalt des angegebenen Feldes zurück.
    static void setObjKeyData​(de.elo.ix.client.Sord sord, java.lang.String objKeyGroupName, java.lang.String[] data)
    Setzt den Inhalt des angegebenen Feldes.
    static void setReadOnly​(IXconnect ixConnect, int objId)
    Setzt die "ReadOnly"-Eigenschaft für den angegebenen Eintrag.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SordHelper

      public SordHelper()

  • Method Details

    • getFileNameFromSord

      public static java.lang.String getFileNameFromSord​(de.elo.ix.client.Sord sord) throws java.lang.Exception
      Liefert den Dateinamen aus den angegebenen Metadaten zurück.
      Parameters:
      sord - Metadaten des Eintrags
      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 - Metadaten des Eintrags
      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 - Metadaten des Eintrags
      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 Dokuments zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Dokuments
      Returns:
      Dateiendung des Dokuments
      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 Eintrag ein Dokument ist.
      Parameters:
      sord - Metadaten des Eintrags
      Returns:
      Eintrag 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 Eintrag ein Ordner ist.
      Parameters:
      sord - Metadaten des Eintrags
      Returns:
      Eintrag 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 Eintrag ein Ordner ist und keine Untereinträge enthält.
      Parameters:
      sord - Metadaten des Eintrags
      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 Eintrag ein dynamisches Register ist.
      Parameters:
      sord - Metadaten des Eintrags
      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 Eintrag gesperrt ist.
      Parameters:
      sord - Metadaten des Eintrags
      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 Eintrags.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Objekt-ID des Eintrags
      locked - Eintrag sperren bzw. 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 - Metadaten des Eintrags
      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 dürfen die Metadaten unabhängig von den Rechten nicht geändert werden, ein Schreibrecht bezieht sich nur auf das Ändern der ACL.
      Parameters:
      sord - Metadaten des Eintrags
      Returns:
      Revisionssicheren Eintrag
      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 Eintrag.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Objekt-ID des Eintrags
      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 Eintrag eine Referenz ist.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Eintrags
      currParentId - Id des aktuellen übergeordneten Ordners
      Returns:
      Eintrag 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 Eintrag eine Referenz ist.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sord - Metadaten des Eintrags
      currParentId - Id des aktuellen übergeordneten Ordners
      Returns:
      Eintrag 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 - Indexserver-Verbindung
      maskName - Bezeichnung der Maske
      Returns:
      Default-Metadaten
      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 des angegebenen Feldes zurück.
      Parameters:
      sord - Metadaten des Eintrags
      objKeyId - Feld-ID
      Returns:
      Felddaten 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 des angegebenen Feldes zurück.
      Parameters:
      sord - Metadaten eines Eintrags
      objKeyGroupName - Gruppenbezeichnung des Feldes
      Returns:
      Felddaten 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 des angegebenen Feldes zurück.
      Parameters:
      sord - Metadaten eines Eintrags
      objKeyId - Feld-ID
      data - Feld-Inhalt
      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 des angegebenen Feldes.
      Parameters:
      sord - Metadaten eines Eintrags
      objKeyGroupName - Gruppenbezeichnung des Feldes
      data - Feld-Inhalt
      Throws:
      java.lang.Exception

    • formatObjKeyData

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

    • formatObjKeyData2

      public static java.lang.String formatObjKeyData2​(java.lang.String[] objKeyData) throws java.lang.Exception
      Wandelt die angegebenen "ObjKey"-Daten in einen String um. Die einzelnen Inhalte werden durch ein Pilcrow-Zeichen voneinader getrennt.
      Parameters:
      objKeyData - Feldinhalt als Liste
      Returns:
      Feldinhalt 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 Dokumenten aus den angegebenen Einträgen zurück.
      Parameters:
      sords - Liste mit Einträgen
      Returns:
      Liste mit Dokumenten
      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 Einträgen zurück.
      Parameters:
      sords - Liste mit Einträ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 die Standard-Metadaten für ein Dokument mit der angegebenen Maske.
      Parameters:
      ixConnect - Indexserver-Verbindung
      maskId - Maske zu der die Metadaten benötigt werden
      Returns:
      Standard-Metadaten 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 Feldes zurück.
      Parameters:
      sord - Metadaten des Eintrags
      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 Metadaten-Objekt.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sord - Metadaten eines Eintrags
      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 Eintrags.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sord - Metadaten eines Eintrags
      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 Eintrags und liefert das Löschergebnis zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      referNr - Referenznummer
      Returns:
      Löschergebnis
      Throws:
      java.lang.Exception

    • deleteEmptyFolder

      public static boolean deleteEmptyFolder​(IXconnect ixConnect, java.lang.String folderId, java.lang.String parentId) throws java.lang.Exception
      Löscht den angegebenen leeren Repository-Ordner.
      Parameters:
      ixConnect - Indexserver-Verbindung
      folderId - ID des zu löschenden Ordners
      parentId - ID des übergeordneten Ordners
      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 - Indexserver-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 - Indexserver-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 Einträge zurück, deren Zeitstempel neuer als das angegebene Datum ist.
      Parameters:
      sords - Liste mit Einträgen
      time - Datum
      Returns:
      Liste mit Einträ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

    • setDeletionPeriodDate

      public static void setDeletionPeriodDate​(de.elo.ix.client.Sord sord, java.lang.String delPeriodIsoDate) throws java.lang.Exception
      Setzt das Ende der Löschfrist im angegebenen Eintrag.
      Parameters:
      sord - Eintrag
      delPeriodIsoDate - Ende der Löschfrist
      Throws:
      java.lang.Exception