Package de.elo.mover.main.helper

Class SordHelper

java.lang.Object

de.elo.mover.main.helper.SordHelper

public class SordHelper
extends Object

Überschrift: SordHelper.

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

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

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, String maskName)	Liefert ein neues "Sord"-Objekt mit Hilfe der IX-Methode "createDoc".
static boolean	deleteEmptyFolder(IXconnect ixConnect, String folderId, String parentId)	Löscht den angegebenen leeren Repository-Ordner.
static String	formatObjKeyData(de.elo.ix.client.ObjKey objKey)	Wandelt die Felddaten in einen String um.
static String	formatObjKeyData2(String[] objKeyData)	Wandelt die angegebenen "ObjKey"-Daten in einen String um.
static ArrayList<de.elo.ix.client.SordType>	getAllSordTypes(IXconnect ixConnect)	Liefert eine Liste mit allen vorhandenen "SordType"-Objekten zurück.
static ArrayList<de.elo.ix.client.Sord>	getChildren(IXconnect ixConnect, int folderId)	Liefert eine Liste mit den Untereinträgen des angegebenen Ordners zurück.
static ArrayList<de.elo.ix.client.Sord>	getChildren2(IXconnect ixConnect, int folderId, de.elo.ix.client.SordZ sordZ)	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 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 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 String[]	getObjKeyData(de.elo.ix.client.Sord sord, int objKeyId)	Liefert den Inhalt des angegebenen Feldes zurück.
static String[]	getObjKeyData(de.elo.ix.client.Sord sord, 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, String delPeriodIsoDate)	Setzt das Ende der Löschfrist im angegebenen Eintrag.
static void	setExifData(IXconnect ixConnect, de.elo.ix.client.Sord sord, 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, String fileName)	Setzt die Dateiendung im angegebenen Sord-Objekt.
static void	setFileNameInSord(de.elo.ix.client.Sord sord, 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, String[] data)	Setzt den Inhalt des angegebenen Feldes zurück.
static void	setObjKeyData(de.elo.ix.client.Sord sord, String objKeyGroupName, 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 String getFileNameFromSord(de.elo.ix.client.Sord sord)
                                  throws Exception

Liefert den Dateinamen aus den angegebenen Metadaten zurück.

Parameters:

sord - Metadaten des Eintrags

Returns:

Dateinamen oder null

Throws:

Exception

setFileNameInSord

public static void setFileNameInSord(de.elo.ix.client.Sord sord,
 String fileName)
                              throws Exception

Setzt den Dateinamen im angegebenen "Sord"-Objekt ein.

Parameters:

sord - Metadaten des Eintrags

fileName - Dateiname

Throws:

Exception

setFileExtInSord

public static void setFileExtInSord(de.elo.ix.client.Sord sord,
 de.elo.ix.client.SordType[] sordTypes,
 String fileName)
                             throws Exception

Setzt die Dateiendung im angegebenen Sord-Objekt.

Parameters:

sord - Metadaten des Eintrags

sordTypes - Liste mit Dateiendungen

fileName - Dateiname

Throws:

Exception

getDocumentExtension

public static String getDocumentExtension(IXconnect ixConnect,
 int objId)
                                   throws Exception

Liefert die Dateiendung des angegebenen Dokuments zurück.

Parameters:

ixConnect - Indexserver-Verbindung

objId - ID des Dokuments

Returns:

Dateiendung des Dokuments

Throws:

Exception

isDocument

public static boolean isDocument(de.elo.ix.client.Sord sord)
                          throws Exception

Meldet zurück, ob der angegebene Eintrag ein Dokument ist.

Parameters:

sord - Metadaten des Eintrags

Returns:

Eintrag ist ein Dokument

Throws:

Exception

isDocument

public static boolean isDocument(int objType)
                          throws Exception

Meldet zurück, ob der angegebene Objekttyp ein Dokumenttyp ist.

Parameters:

objType - Zu prüfenden Dokumententyp

Returns:

Dokumententyp

Throws:

Exception

isStructure

public static boolean isStructure(de.elo.ix.client.Sord sord)
                           throws Exception

Meldet zurück, ob der angegebene Eintrag ein Ordner ist.

Parameters:

sord - Metadaten des Eintrags

Returns:

Eintrag ist ein Ordner

Throws:

Exception

isStructure

public static boolean isStructure(int objType)
                           throws Exception

Meldet zurück, ob der angegebene Objekttyp kein Dokumententyp ist.

Parameters:

objType - Objekttyp

Returns:

Objekttyp ist kein Dokumenttyp

Throws:

Exception

isEmptyStructure

public static boolean isEmptyStructure(de.elo.ix.client.Sord sord)
                                throws 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:

Exception

isDynamicRegister

public static boolean isDynamicRegister(de.elo.ix.client.Sord sord)
                                 throws 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:

Exception

isLocked

public static boolean isLocked(de.elo.ix.client.Sord sord)
                        throws Exception

Gibt an, ob der Eintrag gesperrt ist.

Parameters:

sord - Metadaten des Eintrags

Returns:

True bei einer gesetzten Sperre, sonst False

Throws:

Exception

setLockState

public static void setLockState(IXconnect ixConnect,
 int objId,
 boolean locked)
                         throws Exception

Setzt den Status des angegebenen Eintrags.

Parameters:

ixConnect - Indexserver-Verbindung

objId - Objekt-ID des Eintrags

locked - Eintrag sperren bzw. entsperren

Throws:

Exception

isCrypted

public static boolean isCrypted(de.elo.ix.client.Sord sord)
                         throws Exception

Prüft, ob das Dokument verschlüsselt ist.

Parameters:

sord - Metadaten des Eintrags

Returns:

True, wenn verschlüsselt

Throws:

Exception

isReadOnly

public static boolean isReadOnly(de.elo.ix.client.Sord sord)
                          throws 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:

Exception

setReadOnly

public static void setReadOnly(IXconnect ixConnect,
 int objId)
                        throws Exception

Setzt die "ReadOnly"-Eigenschaft für den angegebenen Eintrag.

Parameters:

ixConnect - Indexserver-Verbindung

objId - Objekt-ID des Eintrags

Throws:

Exception

isReference

public static boolean isReference(IXconnect ixConnect,
 int objId,
 int currParentId)
                           throws 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:

Exception

isReference

public static boolean isReference(IXconnect ixConnect,
 de.elo.ix.client.Sord sord,
 int currParentId)
                           throws 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:

Exception

createNewSord

public static de.elo.ix.client.Sord createNewSord(IXconnect ixConnect,
 String maskName)
                                           throws RemoteException,
Exception

Liefert ein neues "Sord"-Objekt mit Hilfe der IX-Methode "createDoc".

Parameters:

ixConnect - Indexserver-Verbindung

maskName - Bezeichnung der Maske

Returns:

Default-Metadaten

Throws:

RemoteException

Exception

getObjKeyData

public static String[] getObjKeyData(de.elo.ix.client.Sord sord,
 int objKeyId)
                              throws Exception

Liefert den Inhalt des angegebenen Feldes zurück.

Parameters:

sord - Metadaten des Eintrags

objKeyId - Feld-ID

Returns:

Felddaten oder null

Throws:

Exception

getObjKeyData

public static String[] getObjKeyData(de.elo.ix.client.Sord sord,
 String objKeyGroupName)
                              throws Exception

Liefert den Inhalt des angegebenen Feldes zurück.

Parameters:

sord - Metadaten eines Eintrags

objKeyGroupName - Gruppenbezeichnung des Feldes

Returns:

Felddaten oder null

Throws:

Exception

setObjKeyData

public static void setObjKeyData(de.elo.ix.client.Sord sord,
 int objKeyId,
 String[] data)
                          throws Exception

Setzt den Inhalt des angegebenen Feldes zurück.

Parameters:

sord - Metadaten eines Eintrags

objKeyId - Feld-ID

data - Feld-Inhalt

Throws:

Exception

setObjKeyData

public static void setObjKeyData(de.elo.ix.client.Sord sord,
 String objKeyGroupName,
 String[] data)
                          throws Exception

Setzt den Inhalt des angegebenen Feldes.

Parameters:

sord - Metadaten eines Eintrags

objKeyGroupName - Gruppenbezeichnung des Feldes

data - Feld-Inhalt

Throws:

Exception

formatObjKeyData

public static String formatObjKeyData(de.elo.ix.client.ObjKey objKey)
                               throws 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:

Exception

formatObjKeyData2

public static String formatObjKeyData2(String[] objKeyData)
                                throws 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:

Exception

getDocuments

public static de.elo.ix.client.Sord[] getDocuments(de.elo.ix.client.Sord[] sords)
                                            throws 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:

Exception

getStructures

public static de.elo.ix.client.Sord[] getStructures(de.elo.ix.client.Sord[] sords)
                                             throws 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:

Exception

getDefaultIndexing

public static de.elo.ix.client.Sord getDefaultIndexing(IXconnect ixConnect,
 int maskId)
                                                throws 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:

Exception

getMaxUsedIndex

public static int getMaxUsedIndex(de.elo.ix.client.Sord sord,
 boolean withInvisible)
                           throws Exception

Gibt die Nummer des letzten genutzten Feldes zurück.

Parameters:

sord - Metadaten des Eintrags

withInvisible - Unsichtbare Zeilen berücksichtigen

Returns:

Letzter Index

Throws:

Exception

setExifData

public static void setExifData(IXconnect ixConnect,
 de.elo.ix.client.Sord sord,
 File file)
                        throws Exception

Setzt die EXIF-Daten aus der Bilddatei im angegebenen Metadaten-Objekt.

Parameters:

ixConnect - Indexserver-Verbindung

sord - Metadaten eines Eintrags

file - Bild-Datei

Throws:

Exception

removeReferences

public static boolean removeReferences(IXconnect ixConnect,
 de.elo.ix.client.Sord sord)
                                throws Exception

Entfernt alle vorhandenen Referenzen des angegebenen Eintrags.

Parameters:

ixConnect - Indexserver-Verbindung

sord - Metadaten eines Eintrags

Returns:

Ergebnis des Löschvorgangs

Throws:

Exception

removeReference

public static boolean removeReference(IXconnect ixConnect,
 int objId,
 int referNr)
                               throws 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:

Exception

deleteEmptyFolder

public static boolean deleteEmptyFolder(IXconnect ixConnect,
 String folderId,
 String parentId)
                                 throws 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:

Exception

getChildren

public static ArrayList<de.elo.ix.client.Sord> getChildren(IXconnect ixConnect,
 int folderId)
                                                    throws 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:

Exception

getChildren2

public static ArrayList<de.elo.ix.client.Sord> getChildren2(IXconnect ixConnect,
 int folderId,
 de.elo.ix.client.SordZ sordZ)
                                                     throws Exception

Liefert eine Liste mit den Untereinträgen des angegebenen Ordners zurück.

Parameters:

ixConnect - Indexserver-Verbindung

folderId - ID des Ordners

sordZ - Selektor für die "Sord"-Eigenschaften

Returns:

Liste mit Untereinträgen

Throws:

Exception

getAllSordTypes

public static ArrayList<de.elo.ix.client.SordType> getAllSordTypes(IXconnect ixConnect)
                                                            throws Exception

Liefert eine Liste mit allen vorhandenen "SordType"-Objekten zurück.

Parameters:

ixConnect - Indexserver-Verbindung

Returns:

Liste mit allen "SordType"-Objekten

Throws:

Exception

getNewerThan

public static de.elo.ix.client.Sord[] getNewerThan(de.elo.ix.client.Sord[] sords,
 long time)
                                            throws 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:

Exception

addObjKey

public static de.elo.ix.client.ObjKey[] addObjKey(de.elo.ix.client.ObjKey[] objKeys,
 de.elo.ix.client.ObjKey objKey)
                                           throws 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:

Exception

setDeletionPeriodDate

public static void setDeletionPeriodDate(de.elo.ix.client.Sord sord,
 String delPeriodIsoDate)
                                  throws Exception

Setzt das Ende der Löschfrist im angegebenen Eintrag.

Parameters:

sord - Eintrag

delPeriodIsoDate - Ende der Löschfrist

Throws:

Exception