de.bsvrz.pua.prot.util
Class ProcessingParameter

java.lang.Object
  extended by de.bsvrz.pua.prot.util.ProcessingParameter

public class ProcessingParameter
extends java.lang.Object

Datenklasse, die alle Parameter, die für die Protokollerstellung angegeben müssen, zusammenfasst

Version:
$Revision: 1.2 $ / $Date: 2008/01/22 16:55:49 $ / ($Author: yvonnes $)
Author:
beck et al. projects GmbH, Martin Hilgers

Field Summary
 ArchiveDataKind[] archiveDataKind
          Art der Daten, die vom Archivsystem angefordert werden sollen
 java.util.Hashtable<java.lang.String,java.lang.String> aspBindings
          Bindungen der freien Aspekte (optional)
 java.lang.Boolean deltaProtocol
          True falls ein Änderungsprotokoll erzeugt werden soll.
 SystemObject mainObject
          Hauptobjekt des Protokolls
 java.util.HashSet<SystemObject> objects
          Weiteren Objekte des Protokolls (optional )
 java.util.List<Tuple<java.lang.Long,java.lang.Long>> periodList
          Zeitbereiche, die berücksichtigt werden sollen (optional)
 java.util.Hashtable<java.lang.String,java.lang.String[]> pseudoObjects
          Pseudoobjekt Definitionen (optional).
 java.lang.Boolean saveProtocol
          True falls das Protokoll gespeichert werden soll
 SystemObject script
          Skriptobjekt
 short simVar
          Simulationsvariante
 
Constructor Summary
ProcessingParameter()
          Erzeugt das Objekt.
ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar)
          Erzeugt Auftragsparameter mit denen ein Protokolle erstellt werden kann.
ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar, long start, long stop)
          Erzeugt Auftragsparameter.
ProcessingParameter(SystemObject script, SystemObject mainObject, SystemObject[] objects, short simVar, java.util.List<Tuple<java.lang.Long,java.lang.Long>> periods)
          Erzeugt Auftragsparameter.
ProcessingParameter(SystemObject script, SystemObject mainObject, SystemObject[] objects, short simVar, long start, long stop)
          Erzeugt Auftragsparameter.
 
Method Summary
 java.lang.String check()
          Überprüft ob alle Informationen dir für die Protokollerstellung unbedingt notwendig sind, vorliegen.
static ProcessingParameter deserialize(DataModel model, byte[] ba)
          Deserialisiert ein Objekt aus einem Byte-Array.
 byte[] serialize()
          Serilaisiert das Objekt in einen Byte-Array.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

script

public SystemObject script
Skriptobjekt


periodList

public java.util.List<Tuple<java.lang.Long,java.lang.Long>> periodList
Zeitbereiche, die berücksichtigt werden sollen (optional)


mainObject

public SystemObject mainObject
Hauptobjekt des Protokolls


objects

public java.util.HashSet<SystemObject> objects
Weiteren Objekte des Protokolls (optional )


simVar

public short simVar
Simulationsvariante


aspBindings

public java.util.Hashtable<java.lang.String,java.lang.String> aspBindings
Bindungen der freien Aspekte (optional)


pseudoObjects

public java.util.Hashtable<java.lang.String,java.lang.String[]> pseudoObjects
Pseudoobjekt Definitionen (optional). x: Alias, y die dem Alias x zugeordnete Liste mit Objekt-Pids


saveProtocol

public java.lang.Boolean saveProtocol
True falls das Protokoll gespeichert werden soll


deltaProtocol

public java.lang.Boolean deltaProtocol
True falls ein Änderungsprotokoll erzeugt werden soll. Sonst wird ein Statusprotokoll erzeugt (optional).


archiveDataKind

public ArchiveDataKind[] archiveDataKind
Art der Daten, die vom Archivsystem angefordert werden sollen

Constructor Detail

ProcessingParameter

public ProcessingParameter()
Erzeugt das Objekt. Das Erstellen von Protokollen ist mit dem so erzeugten Objekt ist jedoch nicht möglich, da es noch nicht initialisiert wurde.


ProcessingParameter

public ProcessingParameter(SystemObject script,
                           SystemObject mainObject,
                           short simVar)
                    throws FailureException
Erzeugt Auftragsparameter mit denen ein Protokolle erstellt werden kann. Anschließend muss das Zeitintervall periodList eingestellt werden!

Parameters:
script - Skript das verwendet werden soll.
mainObject - Hauptobjekt.
simVar - Simulationsvariante
Throws:
FailureException - Ungültige Parameter.

ProcessingParameter

public ProcessingParameter(SystemObject script,
                           SystemObject mainObject,
                           short simVar,
                           long start,
                           long stop)
                    throws FailureException
Erzeugt Auftragsparameter.

Parameters:
script - Skript das verwendet werden soll.
mainObject - Hauptobjekt.
simVar - Simulationsvariante
start - Startzeitpunkt des Protokolls.
stop - Endzeitpunkt des Protokolls.
Throws:
FailureException - Ungültige Parameter.

ProcessingParameter

public ProcessingParameter(SystemObject script,
                           SystemObject mainObject,
                           SystemObject[] objects,
                           short simVar,
                           long start,
                           long stop)
                    throws FailureException
Erzeugt Auftragsparameter.

Parameters:
script - Skript das verwendet werden soll.
mainObject - Hauptobjekt.
objects - Objekte für die das Protokoll erstellt wird.
simVar - Simulationsvariante.
start - Startzeitpunkt des Protokolls.
stop - Endzeitpunkt des Protokolls.
Throws:
FailureException - Ungültige Parameter.

ProcessingParameter

public ProcessingParameter(SystemObject script,
                           SystemObject mainObject,
                           SystemObject[] objects,
                           short simVar,
                           java.util.List<Tuple<java.lang.Long,java.lang.Long>> periods)
                    throws FailureException
Erzeugt Auftragsparameter.

Parameters:
script - Skript das verwendet werden soll.
mainObject - Hauptobjekt.
objects - Objekte für die das Protokoll erstellt wird.
simVar - Simulationsvariante.
periods - Zeitintervalle des Protokolls.
Throws:
FailureException - Ungültige Parameter.
Method Detail

serialize

public byte[] serialize()
                 throws FailureException
Serilaisiert das Objekt in einen Byte-Array.

Returns:
Byte Array.
Throws:
FailureException - Fehler beim Serialisieren.

deserialize

public static ProcessingParameter deserialize(DataModel model,
                                              byte[] ba)
                                       throws FailureException
Deserialisiert ein Objekt aus einem Byte-Array. Der übliche Java Serialisierer kann nicht verwendet werden, da Objekte der Klasse SystemObject damit nicht serialisiert werden können.

Parameters:
model - Verbindung zur Konfiguration.
ba - Serialisiertes Objekt als Byte-Array.
Returns:
Deserialisiertes Objekt.
Throws:
FailureException - Fehler beim Deserialisieren.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

check

public java.lang.String check()
Überprüft ob alle Informationen dir für die Protokollerstellung unbedingt notwendig sind, vorliegen. Das sind: script, mainObject und simVar

Returns:
String mit Fehlermeldung oder null falls alle Informationen vorliegen.


Copyright © 2005-2008 beck et al. projects GmbH All Rights Reserved.