Package de.bsvrz.ars.ars.persistence
Klasse StandaloneContainerFileHandle
java.lang.Object
de.bsvrz.ars.ars.persistence.StandaloneContainerFileHandle
- Alle implementierten Schnittstellen:
ContainerManagementData
,DataSequence
,AutoCloseable
- Bekannte direkte Unterklassen:
BasicContainerFileHandle
public class StandaloneContainerFileHandle
extends Object
implements AutoCloseable, ContainerManagementData, DataSequence
Referenz auf eine unabhängige Containerdatei außerhalb des Persistenzverzeichnisses
-
Konstruktorübersicht
KonstruktorenModifiziererKonstruktorBeschreibungprotected
Interner Konstruktor, der von abgeleiteten Klassen verwendet wird.StandaloneContainerFileHandle
(Path containerFile) Haupt-Konstruktor -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoid
close()
Die Methode beendet den Zugriff auf den Container (der Container wird nicht abgeschlossen), wird benötigt für dasAutoCloseable
-interface.void
Stellt sicher, dass der Header eingelesen wurde.final ContainerFile
Gibt containerFile von diesem BasicContainerFileHandle-Objekt zurück.de.bsvrz.dav.daf.main.archive.ArchiveDataKind
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.boolean
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.boolean
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.int
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.int
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.long
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.long
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden.long
Gibt die Container-ID zurückgetFile()
Gibt die Datei zurückGibt den Ort des Containers zurückGibt den Ort des Containers zurückboolean
Prüft, ob der Container geschlossen ist, ohne den Zugriff auf denDataIdentNode
zu prüfen.boolean
Prüft ob der Container bereits abgeschlossen ist.iterator()
Erzeugt einen Iterator über Containerdaten.void
Beendet das Arbeiten mit dem zuvor über eine deraccessContainer()
-Methoden definierten Container.void
Liest den Header der Container-Datei ein und springt im Eingabestrom an die Stelle hinter dem Header.toString()
-
Konstruktordetails
-
StandaloneContainerFileHandle
protected StandaloneContainerFileHandle()Interner Konstruktor, der von abgeleiteten Klassen verwendet wird. -
StandaloneContainerFileHandle
Haupt-Konstruktor- Parameter:
containerFile
- Zu öffnende Containerdatei- Löst aus:
PersistenceException
- Fehler beim Lesen (Datei korrupt?)
-
-
Methodendetails
-
getContainerFile
Gibt containerFile von diesem BasicContainerFileHandle-Objekt zurück.- Gibt zurück:
- containerFile (Typ ContainerFile)
-
leaveContainer
public void leaveContainer()Beendet das Arbeiten mit dem zuvor über eine deraccessContainer()
-Methoden definierten Container. -
getContainerHeaderParamAsString
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde. Liefert den Wert des Parameters unabhaengig von dessen Typ immer als String zurück.- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Parameter-Wert als String
- Löst aus:
PersistenceException
- Lesefehler- Siehe auch:
-
getContainerHeaderParamAsArchiveDataKind
public de.bsvrz.dav.daf.main.archive.ArchiveDataKind getContainerHeaderParamAsArchiveDataKind(KeyValParam param) throws PersistenceException Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als Datensatzart zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den TypArchiveDataKind
umgeformt werden kann.- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Datensatzart
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerHeaderParamAsBoolean
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als boolschen Wert zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den Typboolean
umgeformt werden kann.- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
true
oderfalse
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerHeaderParamAsLong
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als numerischen Wert vom Typlong
zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den Typlong
umgeformt werden kann.- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Ganzzahl als
long
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerHeaderParamAsInt
Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als numerischen Wert vom Typlong
zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den Typlong
umgeformt werden kann.- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Ganzzahl als
long
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerHeaderParamAsString
public String getContainerHeaderParamAsString(ContainerManagementInformation param) throws PersistenceException Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde. Liefert den Wert des Parameters unabhaengig von dessen Typ immer als String zurück.- Angegeben von:
getContainerHeaderParamAsString
in SchnittstelleContainerManagementData
- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Parameter-Wert als String
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis- Siehe auch:
-
getContainerHeaderParamAsBoolean
public boolean getContainerHeaderParamAsBoolean(ContainerManagementInformation param) throws PersistenceException Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als boolschen Wert zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den Typboolean
umgeformt werden kann.- Angegeben von:
getContainerHeaderParamAsBoolean
in SchnittstelleContainerManagementData
- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
true
oderfalse
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerHeaderParamAsLong
public long getContainerHeaderParamAsLong(ContainerManagementInformation param) throws PersistenceException Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als numerischen Wert vom Typlong
zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den Typlong
umgeformt werden kann.- Angegeben von:
getContainerHeaderParamAsLong
in SchnittstelleContainerManagementData
- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Ganzzahl als
long
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerHeaderParamAsInt
public int getContainerHeaderParamAsInt(ContainerManagementInformation param) throws PersistenceException Nachdem mitreadContainerHeader()
der Header einer Container-Datei eingelesen worden ist, kann mit dieser Methode der Wert eines Header-Parameters ermittelt werden. Liefert den Wert des Parameters als numerischen Wert vom Typint
zurück. Wirft einePersistenceException
, falls der Parameter nicht gefunden wurde oder nicht in den Typint
umgeformt werden kann.- Angegeben von:
getContainerHeaderParamAsInt
in SchnittstelleContainerManagementData
- Parameter:
param
- Container-Header-Parameter- Gibt zurück:
- Ganzzahl als
int
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getLocation
Beschreibung aus Schnittstelle kopiert:ContainerManagementData
Gibt den Ort des Containers zurück- Angegeben von:
getLocation
in SchnittstelleContainerManagementData
- Gibt zurück:
- den Ort des Containers
- Löst aus:
PersistenceException
-
getLocationFromHeader
Gibt den Ort des Containers zurück- Gibt zurück:
- den Ort des Containers
- Löst aus:
PersistenceException
-
close
public void close()Die Methode beendet den Zugriff auf den Container (der Container wird nicht abgeschlossen), wird benötigt für dasAutoCloseable
-interface.Die Methode ruft nur
leaveContainer()
auf.- Angegeben von:
close
in SchnittstelleAutoCloseable
-
readContainerHeader
Liest den Header der Container-Datei ein und springt im Eingabestrom an die Stelle hinter dem Header. Die Container-Header Parameter stehen dann als Key/Value-Paare zur Verfuegung und können mitgetContainerHeaderParamAsString(KeyValParam)
abgefragt werden.- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
iterator
Erzeugt einen Iterator über Containerdaten. Falls der Container nach der alten Methode gelöscht ist (und nur aus Header und Datensatzbereich besteht) werden nur die Datenindexe zurückgegeben.Dieses Verhalten wird nur für die Migration zu einem
DeletedContainerFile
verwendet. In der Regel ist ein BasicContainerFileHandle nicht gelöscht.- Angegeben von:
iterator
in SchnittstelleDataSequence
- Gibt zurück:
- Iterator
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getContainerId
public long getContainerId()Gibt die Container-ID zurück- Gibt zurück:
- Container-ID
-
isContainerClosed
Prüft ob der Container bereits abgeschlossen ist.- Gibt zurück:
- Kennzeichen, ob Container abgeschlossen ist
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
isClosedInternal
Prüft, ob der Container geschlossen ist, ohne den Zugriff auf denDataIdentNode
zu prüfen.- Gibt zurück:
- Kennzeichen, ob Container abgeschlossen ist
- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-
getFile
Gibt die Datei zurück- Gibt zurück:
- die Datei
-
toString
-
ensureHeaderRead
Stellt sicher, dass der Header eingelesen wurde. Liest ihn ein, falls noch nicht geschehen.- Löst aus:
PersistenceException
- Lesefehler im Persistenzverzeichnis
-