|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationFileManager
Dieses Interface stellt eine Verwaltung für alle Konfigurationsdateien dar und ermöglicht den Zugriff auf diese. Die beschriebenen get-Methoden beziehen sich immer auf alle Konfigurationsdateien, die sich im Zugriff der Verwaltung befinden. Aus diesem Grund speichert die Verwaltung die aktiven Objekte zentral in einer Datenstruktur und deligiert nötige Zugriffe auf die Datei an das jeweilige ConfigurationAreaFile-Objekt.
Method Summary | |
---|---|
ConfigurationAreaFile |
addAreaFile(String configurationAreaPid,
File configurationAreaDir,
short activeVersion,
List<VersionInfo> localVersionTimes)
Der aktuellen Konfiguration wird der angegebene Konfigurationsbereich hinzugefügt. |
void |
close()
Diese Methode wird aufgerufen, wenn ein System heruntegefahren werden soll. |
ConfigurationAreaFile |
createAreaFile(String configurationAreaPid,
File configurationAreaDir)
Diese Methode erstellt zu einem neuen Konfigurationsbereich eine Konfigurationsdatei und fügt den Bereich mit addAreaFile(java.lang.String, java.io.File, short, java.util.List den bestehenden Bereichen
hinzu. |
SystemObjectInformationInterface |
getActiveObject(String pid)
Diese Methode gibt ein Objekt zurück, das derzeit in einem Konfigurationsbereich aktiv ist. |
ConfigurationAreaFile |
getAreaFile(String configurationAreaPid)
Diese Methode gibt ein Objekt zurück, das den Konfigurationsbereich darstellt. |
ConfigurationAreaFile[] |
getConfigurationAreas()
Diese Methode gibt alle Konfigurationsbereiche zurück, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List eingefügt wurden. |
SystemObjectInformationInterface[] |
getNewObjects(String pid)
Diese Methode gibt alle Objekte zurück, die derzeit in einem Konfigurationsbereich weder aktiv noch als ungültig markiert sind. |
SystemObjectInformationInterface |
getObject(long id)
Gibt ein Objekt zurück, das über die Id identifiziert wird. |
List<DynamicObjectInfo> |
getObjects(short simulationVariant)
Diese Methode gibt alle dynamischen Objekte zurück, die zu einer Simulationsvariante gehören. |
SystemObjectInformationInterface[] |
getOldObjects(String pid,
long startTime,
long endTime)
Diese Methode gibt alle Objekte zurück, die in einem Konfigurationsbereich als ungültig markiert sind und die im angegebnen Zeitbereich ungültig geworden sind. |
void |
saveConfigurationAreaFiles()
Diese Methode sichert alle Konfigurationsbereiche, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List übergeben wurden. |
Method Detail |
---|
ConfigurationAreaFile createAreaFile(String configurationAreaPid, File configurationAreaDir) throws IllegalArgumentException, IOException, NoSuchVersionException
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
den bestehenden Bereichen
hinzu. Der neue Konfigurationsbereich erhält den Zustand inaktiv. Soll er von der Konfiguration genutzt werden können, so muss er aktiviert werden.
configurationAreaPid
- die Pid des neuen KonfigurationsbereichsconfigurationAreaDir
- das Verzeichnis, in dem die Konfigurationsdatei angelegt werden soll
IllegalArgumentException
- Falls die Argumente ungültig sind.
IOException
- Falls Fehler im Zusammenhang mit der Datei des Konfigurationsbereichs auftreten.
NoSuchVersionException
- TBDConfigurationAreaFile addAreaFile(String configurationAreaPid, File configurationAreaDir, short activeVersion, List<VersionInfo> localVersionTimes) throws IllegalArgumentException, IOException, NoSuchVersionException
configurationAreaPid
- die Pid des KonfigurationsbereichsconfigurationAreaDir
- Verzeichnis, in dem die Konfigurationsdatei gespeichert wurdeactiveVersion
- die aktuelle Version des KonfigurationsbereichslocalVersionTimes
- Diese Liste speichert zu jeder Version, die jemals aktiviert wurde, den Zeitpunkt an dem die Version aktiviert wurde. Die
Zeitpunkte beziehen sich auf die Zeit, an dem sie auf der Konfiguration, die diese Methode aufruft, aktiviert wurden.
IllegalArgumentException
- Falls der Konfigurationsbereich mit der Pid bereits zur Konfiguration hinzugefügt wurde.
IllegalStateException
- Die Datei, die den Konfigurationsbereich enthält, existiert nicht.
IOException
- TBD
NoSuchVersionException
- TBDConfigurationAreaFile getAreaFile(String configurationAreaPid)
configurationAreaPid
- Pid des Konfigurationsbereichs
null
zurückgegeben.SystemObjectInformationInterface getObject(long id)
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
hinzugefügt
wurden.
id
- Id des Objekts
null
falls kein Objekt gefunden werden konnteSystemObjectInformationInterface getActiveObject(String pid)
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
hinzugefügt wurden.
pid
- Pid des Objekts, das gesucht werden soll
null
falls kein Objekt existiertSystemObjectInformationInterface[] getNewObjects(String pid) throws IllegalArgumentException
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
hinzugefügt wurden.
pid
- pid der gesuchten Objekte
IllegalArgumentException
SystemObjectInformationInterface[] getOldObjects(String pid, long startTime, long endTime) throws IllegalArgumentException
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
hinzugefügt wurden.
pid
- pid des gesuchten ObjektsstartTime
- Startzeitpunkt des BereichsendTime
- Endzeitpunkt des Bereichs
IllegalArgumentException
- Zur angegebenen Pid konnte kein Objekt gefunden werdenConfigurationAreaFile[] getConfigurationAreas()
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
eingefügt wurden.
List<DynamicObjectInfo> getObjects(short simulationVariant) throws IllegalArgumentException
simulationVariant
- Simulationsvariante, für die alle dynamischen Objekte zurückgegeben werden sollen. (Wertebereich 1...999)
IllegalStateException
- Der Wert der Simulationsvariante ist nicht 1...999
IllegalArgumentException
void saveConfigurationAreaFiles() throws IOException
addAreaFile(java.lang.String, java.io.File, short, java.util.List)
übergeben wurden. In den einzelnen Konfigurationsbereichen werden alle
Änderungen, die an Objekten eines Konfigurationsbereichs vorgenommen wurden, persistent in die dafür vorgesehene Datei gespeichert.
IOException
- Es ist beim speichern der Versorgungsdateien zu einem Fehler gekommen. Es wurde trotz des Fehlers bei jeder Datei ConfigurationAreaFile.flush()
aufgerufen. Die zuletzt aufgetretene IOException
wird zurückgegeben.void close()
saveConfigurationAreaFiles()
und stellt einen Zustand her in dem das System wieder gestartet werden kann.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |