|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationAreaFile
Method Summary | |
---|---|
void |
close()
Diese Methode wird aufgerufen, wenn das System heruntergefahren soll. |
ConfigurationObjectInfo |
createConfigurationObject(long objectID,
long typeID,
String pid,
String name)
Diese Methode erzeugt ein Konfigurationsobjekt. |
DynamicObjectInfo |
createDynamicObject(long objectID,
long typeID,
String pid,
short simulationVariant,
String name,
DynamicObjectType.PersistenceMode persistenceMode)
Diese Methode erzeugt ein dynamisches Objekt, das sofort gültig ist. |
void |
flush()
Diese Methode wird aufgerufen, wenn alle modifizierten Objekte des Konfigurationsbereichs persistent gespeichert werden sollen. |
SystemObjectInformationInterface[] |
getActualObjects(long typeId)
Gibt alle aktuellen Objekte zurück, die als TypeId die übergebene TypeId besitzen. |
ConfigurationObjectInfo |
getConfigurationAreaInfo()
Diese Methode gibt Informationen über das Konfigurationsobjekt zurück, das den Konfigurationsbereich darstellt. |
SystemObjectInformationInterface[] |
getCurrentObjects()
Diese Methode gibt alle dynamischen Objekte und Konfigurationsobjekte zurück, die in der aktuellen Version aktuell sind. |
long |
getGreatestId()
Diese Methode gibt die größte vergebene laufende Nummer einer Id des Konfigurationsbereichs zurück. |
SystemObjectInformationInterface[] |
getNewObjects()
Diese Methode gibt alle Konfigurationsobjekte zurück, die in einer zukünftigen Version aktuell werden. |
short |
getNextActiveVersion()
Liefert die Version, ab der neu erstellte Konfigurationsobjekte gültig werden. |
SystemObjectInformationInterface[] |
getObjects(long startTime,
long endTime,
ConfigurationAreaTime kindOfTime,
TimeSpecificationType timeSpecificationType,
Collection<Long> typeIds)
Diese Methode gibt alle dynamischen Objekte und Konfigurationsobjekte zurück, die innerhalb des angegebenen Zeitbereichs gültig waren und deren TypeId gleich einer der übergebenen TypeId´s ist. |
SystemObjectInformationInterface[] |
getObjects(String pid,
long startTime,
long endTime,
ConfigurationAreaTime kindOfTime)
Diese Methode gibt Objekte zurück, die in dem angegebenen Zeibereich gültig waren. |
SystemObjectInformationInterface |
getOldObject(long id)
Diese Methode gibt ein Objekt zurück, das als ungültig markiert wurde. |
int |
getSerializerVersion()
Alle Daten, die als Byte-Array gespeichert werden müssen, werden mit einem Serializer Serializer erstellt. |
boolean |
initialVersionRestructure()
Diese Methode wird aufgerufen, wenn der Konfigurationsverantwortliche eine neue Version aktiviert. |
Iterator<SystemObjectInformationInterface> |
iterator()
Stellt alle dynamischen Objekte und Konfigurationsobjekte zur Verfügung. |
boolean |
restructure()
Diese Methode reorganisiert eine Konfigurationsbereichsdatei. |
void |
setNextActiveVersion(short nextActiveVersion)
Legt die Version fest mit der Konfigurationsobjekte, die mit createConfigurationObject(long, long, java.lang.String, java.lang.String) erzeugt werden, gültig werden. |
Method Detail |
---|
ConfigurationObjectInfo getConfigurationAreaInfo()
void flush() throws IOException
IOException
- Fehler beim Zugriff auf die Datei in der der Konfigurationsbereich gespeichert istvoid close() throws IOException
flush()
und ein Zustand
hergestellt werden, mit dem das System zu einem späteren Zeitpunkt wieder hochgefahren werden kann.
IOException
- Fehler beim Zugriff auf die Datei in der der Konfigurationsbereich gespeichert istDynamicObjectInfo createDynamicObject(long objectID, long typeID, String pid, short simulationVariant, String name, DynamicObjectType.PersistenceMode persistenceMode) throws IllegalArgumentException, IllegalStateException
objectID
- ID des ObjektstypeID
- Typ des Objekts, der Typ wird über die ID festgelegtpid
- Pid des ObjektssimulationVariant
- Simulationsvariante unter der das dynamische Objekt gültig istname
- Name des Objekts, null
wird als "" interpretiertpersistenceMode
- Soll das dynamische Objekte persistent gespeichert werden
IllegalArgumentException
- Die übergebene Id des Objekts muss größer als die größte Id des Konfigurationsbereichs sein
IllegalStateException
getGreatestId()
ConfigurationObjectInfo createConfigurationObject(long objectID, long typeID, String pid, String name) throws IllegalStateException, IllegalArgumentException
objectID
- ID des ObjektstypeID
- Typ des Objekts, der Typ wird über die ID festgelegtpid
- Pid des Objektsname
- Name des Objekts, null
wird als "" interpretiert
IllegalStateException
- Die Version, mit der das Objekt gültig werden soll, wurde noch nicht mit setNextActiveVersion(short)
festgelegt
IllegalArgumentException
- Die übergebene Id des Objekts muss größer als die größte Id des Konfigurationsbereichs seingetGreatestId()
SystemObjectInformationInterface[] getCurrentObjects()
SystemObjectInformationInterface[] getActualObjects(long typeId)
typeId
- TypeId, die ein Objekt besitzen muss, damit es zurückgegeben wird
SystemObjectInformationInterface[] getObjects(long startTime, long endTime, ConfigurationAreaTime kindOfTime, TimeSpecificationType timeSpecificationType, Collection<Long> typeIds)
timeSpecificationType
bestimmt, wann/wie lange ein Objekt gültig gewesen sein muss um
in die Lösung aufgenommen zu werden.
startTime
- Zeitpunkt, ab der ein Objekt gültig sein muss, um zurückgegeben zu werdenendTime
- Zeitpunkt, bis zu der Objekte zurückgegeben werdenkindOfTime
- Ein Konfigurationsobjekt wird mit der Aktivierung einer Version gültig. Da der Konfigurationsverantwortliche die Version zu
einem früheren Zeitpunkt aktiviert haben kann, als die lokale Konfiguration, legt dieser Parameter fest, welcher Zeitpunkt für
ein Konfigurationsobjekt benutzt werden soll an dem es als "gültig" markiert wurde.timeSpecificationType
- Gibt die Art und Weise an, wie der Zeitraum zu betrachten ist.typeIds
- Liste von TypeId´s. Damit ein Objekt zurückgegeben wird, muss die TypeId des Objekts mit einer TypeId in der Liste
übereinstimmen
SystemObjectInformationInterface[] getNewObjects()
Iterator<SystemObjectInformationInterface> iterator()
SystemObjectInformationInterface getOldObject(long id)
null
zurückgegeben.
id
- Id des geforderten Objekts
null
SystemObjectInformationInterface[] getObjects(String pid, long startTime, long endTime, ConfigurationAreaTime kindOfTime)
pid
- Pid, über die die Objekte identifiziert werdenstartTime
- Zeitpunkt, ab dem ein Objekt mit der angegebenen Pid gültig gewesen sein muss um zurückgegeben zu werden. War das Objekt vor dem
angegebenen Zeitraum bereits gültig, so wird es ebenfalls zurückgegeben.endTime
- Zeitpunkt, bis zu dem ein Objekt mit der angegebenen Pid gültig gewesen sein muss um zurückgegeben zu werden. Ist das Objekt über diesen
Zeitraum hinweg gültig, so wird es ebenfalls zurückgegeben. Der Zeitpunkt darf nicht in der Zukunft liegen, der größt mögliche Zeitpunkt
ist die aktuelle Zeit.kindOfTime
- Legt fest, welcher Zeitpunkt bei einer aktivierten Version benutzt wird. Der Zeitpunkt der lokalen Aktivierung einer Version oder aber der
Zeitpunkt der Aktivierung durch den Konfigurationsverantwortlichen.
int getSerializerVersion()
Serializer
erstellt. Die benutzte Version ist in der
gesamten Datei identisch. Ein Versionswechsel innerhalb der Datei ohne die Konvertierung aller Daten auf die neue Version ist nicht gestattet.
void setNextActiveVersion(short nextActiveVersion)
createConfigurationObject(long, long, java.lang.String, java.lang.String)
erzeugt werden, gültig werden.
nextActiveVersion
- Version, mit der Konfigurationsobjekte gültig werden. Die erste Version, mit der ein Objekt gültig sein kann, ist die 1. Die
Versionen sind positive Ganzzahlen, die fortlaufend nummeriert sind.short getNextActiveVersion()
boolean restructure()
boolean initialVersionRestructure()
restructure()
long getGreatestId()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |