public final class ProcessingParameter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private java.util.Set<ArchiveDataKind> |
_archiveDataKind
Set mit Datenarten
|
private java.util.HashMap<java.lang.String,java.lang.String> |
_aspBindings
Map mit Aspekt-Bindungen (Zuordnung Alias->Aspekt)
|
private long |
_creationDate
Erstellungsdatum des Protokolls in ms seit 1.Januar 1970.
|
private java.lang.String |
_creatorName
Name des Erstellers des Protokolls (Freitext). null-Werte sind ungültig.
|
private java.lang.String |
_infoText
Infotext der beim Protokollerstellen angegeben werden kann. null-Werte sind ungültig.
|
private boolean |
_isPublic
Gibt an, ob das Protokoll öffentlich sein soll
|
private SystemObject |
_mainObject
Hauptobjekt.
|
private NoChangeMarker |
_noChangeMarker
Markierungsart für "Keine Änderungen"-Informationen.
|
private java.util.List<Tuple<java.lang.Long,java.lang.Long>> |
_periodList
Liste mit Zeitbereichen (Tuple
|
private ProtocolType |
_protocolType
Typ des Protokolls.
|
private java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> |
_pseudoObjects
Map mit Pseudoobjekt-Definitionen (Zuordnung Alias->Objekte)
|
private boolean |
_saveProtocol
Ob das Protokoll gespeichert werden soll
|
private SystemObject |
_script
Objekt, das das Skript darstellt.
|
private short |
_simVar
Simulationsvariante
|
Constructor and Description |
---|
ProcessingParameter()
Deprecated.
Bei der Benutzung der anderen Konstruktoren enthält das Objekt in jedem Fall gültige Werte, deren Benutzung ist daher zu empfehlen.
|
ProcessingParameter(SystemObject script)
Erzeugt Auftragsparameter mit Simulationsvariante 0.
|
ProcessingParameter(SystemObject script,
SystemObject mainObject,
short simVar)
Erzeugt Auftragsparameter.
|
ProcessingParameter(SystemObject script,
SystemObject mainObject,
short simVar,
java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periods)
Erzeugt Auftragsparameter.
|
ProcessingParameter(SystemObject script,
SystemObject mainObject,
short simVar,
java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periods,
java.util.Map<java.lang.String,java.lang.String> aspBindings,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects,
boolean saveProtocol,
java.lang.Boolean deltaProtocol,
java.util.Collection<ArchiveDataKind> archiveDataKind,
java.lang.String creatorName,
boolean isPublic,
java.lang.String infoText)
Erzeugt Auftragsparameter.
|
ProcessingParameter(SystemObject script,
SystemObject mainObject,
short simVar,
java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periods,
java.util.Map<java.lang.String,java.lang.String> aspBindings,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects,
boolean saveProtocol,
ProtocolType protocolType,
NoChangeMarker noChangeMarker,
java.util.Collection<ArchiveDataKind> archiveDataKind,
java.lang.String creatorName,
boolean isPublic,
java.lang.String infoText)
Erzeugt Auftragsparameter.
|
ProcessingParameter(SystemObject script,
SystemObject mainObject,
short simVar,
long start,
long stop)
Erzeugt Auftragsparameter.
|
Modifier and Type | Method and Description |
---|---|
void |
addPeriod(Tuple<java.lang.Long,java.lang.Long> period)
Fügt einen Zeitbereich hinzu
|
static ProcessingParameter |
deserialize(ObjectLookup model,
byte[] ba)
Deserialisiert ein Objekt aus einem Byte-Array.
|
java.util.Set<ArchiveDataKind> |
getArchiveDataKind()
Art der Daten, die vom Archivsystem angefordert werden sollen
|
ArchiveDataKindCombination |
getArchiveDataKindCombination()
Art der Daten, die vom Archivsystem angefordert werden sollen
|
java.util.Map<java.lang.String,java.lang.String> |
getAspBindings()
Bindungen der freien Aspekte (optional)
|
long |
getCreationDate()
Gibt das Erstellungsdatums des Protokolls zurück
|
java.lang.String |
getCreatorName()
Gibt den Erstellernamen des Protokolls zurück (Freitext)
|
java.lang.Boolean |
getDeltaProtocol()
Deprecated.
getProtocolType() benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werden |
java.lang.String |
getInfoText()
Text, der dem Protokoll mitgegeben werden kann und später in
ProtocolAdministrationData.infoText ausgelesen
werden kann |
SystemObject |
getMainObject()
Gibt das Hauptobjekt des Protokolls zurück
|
NoChangeMarker |
getNoChangeMarker()
Gibt die Markierungsart für "Keine Änderungen" zurück.
|
java.util.List<Tuple<java.lang.Long,java.lang.Long>> |
getPeriodList()
Gibt Zeitbereiche, die berücksichtigt werden sollen, zurück
|
ProtocolType |
getProtocolType()
Gibt die Protokollart zurück.
|
java.util.Map<java.lang.String,java.lang.String[]> |
getPseudoObjects()
Pseudoobjekt-Definitionen (optional).
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getPseudoObjects2()
Pseudoobjekt-Definitionen (optional).
|
boolean |
getSaveProtocol()
Gibt zurück ob das protokoll gespeichert werden soll.
|
SystemObject |
getScript()
Gibt das Skriptobjekt zurück
|
short |
getSimVar()
Gibt die Simulationsvariante zurück
|
boolean |
isPublic()
Ist das Protokoll öffentlich?
|
void |
removePeriod(Tuple<java.lang.Long,java.lang.Long> period)
Entfernt einen Zeitbereich
|
byte[] |
serialize()
Serialisiert das Objekt in einen Byte-Array.
|
void |
setArchiveDataKind(ArchiveDataKind[] archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden soll
|
void |
setArchiveDataKind(java.util.Collection<ArchiveDataKind> archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden soll
|
void |
setArchiveDataKindCombination(ArchiveDataKindCombination archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden soll
|
void |
setAspBindings(java.util.Map<java.lang.String,java.lang.String> aspBindings) |
void |
setCreationDate(long creationDate)
Setzt das Erstellungsdatum des Protokolls
|
void |
setCreatorName(java.lang.String creatorName)
Setzt den Namen des Protokollerstellers (Freitext)
|
void |
setDeltaProtocol(java.lang.Boolean deltaProtocol)
Deprecated.
setProtocolType(ProtocolType) } benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werden |
void |
setInfoText(java.lang.String infoText)
Setzt einen beschreibenden Freitext des Protokolls.
|
void |
setIsPublic(boolean isPublic)
Setzt, ob das Protokoll öffentlich sein soll
|
void |
setMainObject(SystemObject mainObject)
Setzt das Hauptobjekt
|
void |
setNoChangeMarker(NoChangeMarker noChangeMarker)
Setzt die Markierungsart für "Keine Änderungen" bei Zustandsprotokollen.
|
void |
setPeriodList(java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periodList)
Setzt Zeitbereiche
|
void |
setProtocolType(ProtocolType protocolType)
Setzt die Protokollart.
|
void |
setPseudoObjects(java.util.Map<java.lang.String,java.lang.String[]> pseudoObjects)
Setzt die Pseudoobjekt-Definitionen
|
void |
setPseudoObjects2(java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects)
Setzt die Pseudoobjekt-Definitionen
|
void |
setSaveProtocol(boolean saveProtocol)
Setzt ob das Protokoll gespeichert werden soll.
|
void |
setScript(SystemObject script)
Setzt das Skriptobjekt
|
void |
setSimVar(short simVar)
Setzt die Simulationsvariante
|
java.lang.String |
toString() |
private void |
validatePeriod(Tuple<java.lang.Long,java.lang.Long> period) |
private SystemObject _script
private java.util.List<Tuple<java.lang.Long,java.lang.Long>> _periodList
private SystemObject _mainObject
private short _simVar
private java.util.HashMap<java.lang.String,java.lang.String> _aspBindings
private java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> _pseudoObjects
private boolean _saveProtocol
private ProtocolType _protocolType
private NoChangeMarker _noChangeMarker
private java.util.Set<ArchiveDataKind> _archiveDataKind
private java.lang.String _infoText
private java.lang.String _creatorName
private long _creationDate
private boolean _isPublic
public ProcessingParameter(SystemObject script) throws FailureException
script
- Skript das verwendet werden soll.FailureException
- Ungültige Parameter.public ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar) throws FailureException
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- SimulationsvarianteFailureException
- Ungültige Parameter.public ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar, long start, long stop) throws FailureException
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvariantestart
- Startzeitpunkt des Protokolls.stop
- Endzeitpunkt des Protokolls.FailureException
- Ungültige Parameter.public ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar, java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periods) throws FailureException
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.FailureException
- Ungültige Parameter.public ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar, java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, java.lang.Boolean deltaProtocol, java.util.Collection<ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText) throws FailureException
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.aspBindings
- Aspekt-Bindungen oder Collections.EMPTY_MAP
falls keine gewünscht sind.pseudoObjects
- Pseudo-Objekt-Definitionen oder Collections.EMPTY_MAP
falls keine gewünscht sind.saveProtocol
- Ob das Protokoll gespeichert werden solldeltaProtocol
- Ob das Protokoll ein Änderungsprotokoll ist (true: Ja, false: Zustandsprotokoll, null: Standardwert im Skript verwenden)archiveDataKind
- Liste mit Datensatzarten für die das Protokoll erstellt werden sollcreatorName
- Name des ErstellersisPublic
- Ist das Protokoll öffentlich?infoText
- BeschreibungstextFailureException
- Ungültige Parameter.public ProcessingParameter(SystemObject script, SystemObject mainObject, short simVar, java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, ProtocolType protocolType, NoChangeMarker noChangeMarker, java.util.Collection<ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText) throws FailureException
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.aspBindings
- Aspekt-Bindungen oder Collections.EMPTY_MAP
falls keine gewünscht sind.pseudoObjects
- Pseudo-Objekt-Definitionen oder Collections.EMPTY_MAP
falls keine gewünscht sind.saveProtocol
- Ob das Protokoll gespeichert werden sollprotocolType
- Zu erstellende Protokollart. null
wird als ProtocolType.Undefined
interpretiert.noChangeMarker
- Markierungsart für "Keine Änderungen" bei Zustandsprotokollen, entweder Zeilenweise oder für jede einzelne Zelle/jeden einzelnen Datensatz. null
wird als NoChangeMarker.Undefined
interpretiert.archiveDataKind
- Liste mit Datensatzarten für die das Protokoll erstellt werden sollcreatorName
- Name des ErstellersisPublic
- Ist das Protokoll öffentlich?infoText
- BeschreibungstextFailureException
- Ungültige Parameter.@Deprecated public ProcessingParameter()
setScript(de.bsvrz.dav.daf.main.config.SystemObject)
und {setSimVar(short)
} aufgerufen werden.public byte[] serialize() throws FailureException
FailureException
- Fehler beim Serialisieren.public static ProcessingParameter deserialize(ObjectLookup model, byte[] ba) throws FailureException
SystemObject
damit nicht serialisiert werden können.model
- Verbindung zur Konfiguration.ba
- Serialisiertes Objekt als Byte-Array.FailureException
- Fehler beim Deserialisieren.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public SystemObject getScript()
public void setScript(SystemObject script) throws FailureException
script
- Skriptobjekt (null ist ungültig)FailureException
- bei null-parameterpublic java.util.List<Tuple<java.lang.Long,java.lang.Long>> getPeriodList()
public void setPeriodList(java.util.Collection<Tuple<java.lang.Long,java.lang.Long>> periodList) throws FailureException
periodList
- Liste mit Zeitbereichen (TupleFailureException
- Fehlerhafter Parameterprivate void validatePeriod(Tuple<java.lang.Long,java.lang.Long> period) throws FailureException
FailureException
public void addPeriod(Tuple<java.lang.Long,java.lang.Long> period) throws FailureException
period
- ZeitbereichFailureException
- Fehlerhafter Parameterpublic void removePeriod(Tuple<java.lang.Long,java.lang.Long> period) throws FailureException
period
- ZeitbereichFailureException
- Fehlerhafter Parameterpublic SystemObject getMainObject()
public void setMainObject(SystemObject mainObject)
mainObject
- Hauptobjekt oder null falls keines definiert sein soll.public short getSimVar()
public void setSimVar(short simVar) throws FailureException
simVar
- SimulationsvarianteFailureException
- Fehlerhafter Parameterpublic java.util.Map<java.lang.String,java.lang.String> getAspBindings()
public void setAspBindings(java.util.Map<java.lang.String,java.lang.String> aspBindings) throws FailureException
FailureException
public java.util.Map<java.lang.String,java.lang.String[]> getPseudoObjects()
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getPseudoObjects2()
public void setPseudoObjects2(java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects) throws FailureException
pseudoObjects
- Zuordnung Alias zu PseudoObjekt-Pids. Alle Listen müssen die gleiche Länge haben. Leerstrings oder null-Einträge sind in den Listen
gültig, für diese Einträge wird eine leere Platzhalterspalte erstellt. Die Klasse speichert eine Kopie des pseudoObjects-Parameters.FailureException
- Bei ungültigen Parameternpublic void setPseudoObjects(java.util.Map<java.lang.String,java.lang.String[]> pseudoObjects) throws FailureException
pseudoObjects
- Zuordnung Alias zu PseudoObjekt-Pids. Alle Arrays müssen die gleiche Länge haben. Leerstrings oder null-Einträge sind in den Arrays
gültig, für diese Einträge wird eine leere Platzhalterspalte erstellt. Die Klasse speichert eine Kopie des pseudoObjects-Parameters.FailureException
- Bei ungültigen Parameternpublic boolean getSaveProtocol()
public void setSaveProtocol(boolean saveProtocol)
saveProtocol
- true wenn das Protokoll gespeichert werden sollpublic ProtocolType getProtocolType()
setProtocolType(ProtocolType)
public void setProtocolType(ProtocolType protocolType)
protocolType
- Zu erstellende Protokollart. null
wird als ProtocolType.Undefined
interpretiert
und bedeutet das die im Skript definierte Protokollart verwendet werden soll. Wenn das Skript keine Vorgabe macht, wird ein
Zustandsprotokoll erzeugt.public NoChangeMarker getNoChangeMarker()
setNoChangeMarker(NoChangeMarker)
public void setNoChangeMarker(NoChangeMarker noChangeMarker)
ProtocolNoChanges
-Datensatz abgebildet. Bei Zellenweisen Markierungen werden die einzelnen Zellen
mit einem ExpressionResult vom Typ ExpressionResult.ResultType.NO_CHANGE
befüllt.noChangeMarker
- Markierungsart, entweder Zeilenweise oder für jede einzelne Zelle/jeden einzelnen Datensatz.
null
wird als NoChangeMarker.Undefined
interpretiert
und bedeutet das die im Skript definierte Markierungsart verwendet werden soll. Wenn das Skript keine Vorgabe macht, werden
zeilenweise Markierungen verwendet.@Deprecated public java.lang.Boolean getDeltaProtocol()
getProtocolType()
benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werden@Deprecated public void setDeltaProtocol(java.lang.Boolean deltaProtocol)
setProtocolType(ProtocolType)
} benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werdendeltaProtocol
- true: Ja, false: Nein, null: Standardwerte im Skript verwenden (nein, falls nicht definiert).public java.util.Set<ArchiveDataKind> getArchiveDataKind()
public ArchiveDataKindCombination getArchiveDataKindCombination()
public void setArchiveDataKind(java.util.Collection<ArchiveDataKind> archiveDataKind) throws FailureException
archiveDataKind
- DatensatzartenFailureException
- Fehlerhafter Parameterpublic void setArchiveDataKind(ArchiveDataKind[] archiveDataKind) throws FailureException
archiveDataKind
- DatensatzartenFailureException
- Fehlerhafter Parameterpublic void setArchiveDataKindCombination(ArchiveDataKindCombination archiveDataKind)
archiveDataKind
- Datensatzartenpublic java.lang.String getInfoText()
ProtocolAdministrationData.infoText
ausgelesen
werden kannpublic void setInfoText(java.lang.String infoText) throws FailureException
ProtocolAdministrationData.infoText
wieder zurückgegeben.infoText
- FreitextFailureException
- null-Parameterpublic java.lang.String getCreatorName()
public void setCreatorName(java.lang.String creatorName) throws FailureException
creatorName
- namenFailureException
- null-Parameterpublic long getCreationDate()
public void setCreationDate(long creationDate)
creationDate
- Erstellungsdatum (ms seit 1. jan 1970)public boolean isPublic()
public void setIsPublic(boolean isPublic)
isPublic
- true wenn öffentlich