public class MessageTemplate
extends java.lang.Object
Diese Klasse erlaubt es, Vorlagen für die Erstellung von Betriebsmeldungs-Texten zu erzeugen. Eine Betriebsmeldungsvorlage besteht aus Textbausteinen, die später mit variablen Anteilen gefüllt werden können. Beispiel:
MessageTemplate template = new MessageTemplate(
MessageGrade.INFORMATION,
MessageType.APPLICATION_DOMAIN,
MessageTemplate.fixed("Der Fahrstreifen "),
MessageTemplate.object(),
MessageTemplate.fixed(" enthält fehlerhafte Daten "),
MessageTemplate.set("attr", " und ", "im Attribut ", "in den Attributen "),
MessageTemplate.fixed(".")
);
final SystemObject fahrstreifen = ...;
OperatingMessage operatingMessage = template.newMessage(fahrstreifen);
operatingMessage.add("attr", "qKfz");
operatingMessage.add("attr", "qPkw");
operatingMessage.add("attr", "qB");
operatingMessage.send();
Mit Ausgabe
operatingMessage = Der Fahrstreifen fs.test enthält fehlerhafte Daten in den Attributen qKfz, qPkw und qB.
und Versand einer entsprechenden Betriebsmeldung.
Folgende Methoden erzeugen Parameter-Bausteine:
fixed(String)
, ein fester String.variable(String)
, eine mit einem beliebigen String oder Objekt befüllbare Variable. (Siehe OperatingMessage.put(String, Object)
)set(String, String)
, eine Variable, mit mit einer Menge von Objekten befüllt wird. Die doppelte Angabe eines Objekts wird automatisch verhindert, Objekte werden in der Reihenfolge ausgegeben, wie sie eingefügt werden. Optional können hier 2 weitere Parameter angegeben werden, mit denen ein Singular und Plural-Präfix definiert werden kann. (Siehe OperatingMessage.add(String, Object)
)object()
, fügt eine Referenz auf das Systemobjekt ein, auf das sich die Meldung bezieht. (Siehe newMessage(SystemObject)
)ids()
, Eine spezielle Mengen-Variable, die Kennungen der Betriebsmeldung enthält. Die IDs werden im MeldungsTypZusatz publiziert. (Siehe OperatingMessage.addId(Object)
)Diese Klasse sowie die hier definierten OperatingMessageParam-Instanzen sind unveränderlich und threadsafe.
Modifier and Type | Class and Description |
---|---|
static class |
MessageTemplate.OperatingMessageParam
Abstrakte Klasse für einen Textbaustein
|
Constructor and Description |
---|
MessageTemplate(MessageGrade grade,
MessageType domain,
MessageTemplate.OperatingMessageParam... text)
Erzeugt eine neue Betriebsmeldungs-Text-Vorlage
|
Modifier and Type | Method and Description |
---|---|
static MessageTemplate.OperatingMessageParam |
fixed(java.lang.String s)
Erstellt einen festen String-Wert als Textbaustein
|
MessageType |
getDomain()
Gibt die Art der Meldung zurück
|
MessageGrade |
getGrade()
Gibt die Schwere der Meldung zurück
|
java.util.logging.Level |
getLevel()
Gibt den Level zurück, mit dem erzeugte Meldungen beim Versand über die Debug-Funktionen ausgegeben werden sollen.
|
java.util.List<MessageTemplate.OperatingMessageParam> |
getParams()
Gibt die Textbausteine dieses Objekts zurück
|
static MessageTemplate.OperatingMessageParam |
ids()
Erstellt einen neuen Platzhalter für die der Meldung zugeordneten Kennungen (MeldungsTypZusatz).
|
OperatingMessage |
newMessage(SystemObject systemObject)
Erstellt aus der Vorlage ein neues Betriebsmeldungs-Objekt, das mit konkreten Werten gefüllt und dann versand werden kann
|
static MessageTemplate.OperatingMessageParam |
object()
Erstellt einen neuen Platzhalter für das Objekt, auf das sich die Betriebsmeldung bezieht
|
static MessageTemplate.OperatingMessageParam |
set(java.lang.String variable,
java.lang.String joiner)
Erstellt einen neuen Platzhalter für eine Menge
|
static MessageTemplate.OperatingMessageParam |
set(java.lang.String variable,
java.lang.String joiner,
java.lang.String singular,
java.lang.String plural)
Erstellt einen neuen Platzhalter für eine Menge
|
java.lang.String |
toString() |
static MessageTemplate.OperatingMessageParam |
variable(java.lang.String variable)
Erstellt einen neuen Platzhalter für eine einfache Variable
|
MessageTemplate |
withDebugLevel(java.util.logging.Level level)
Gibt eine Kopie dieses Objekts zurück, welches den übergebenen Debug-Level für die Debug-Meldung verwendet (standardmäßig INFO)
|
MessageTemplate |
withIdFactory(MessageIdFactory factory)
Gibt eine Kopie dieses Objekts zurück, welches den übergebenen Lambda-Ausdruck zur Erzeugung einer Betriebsmeldungs-ID verwendet
|
public MessageTemplate(MessageGrade grade, MessageType domain, MessageTemplate.OperatingMessageParam... text)
Erzeugt eine neue Betriebsmeldungs-Text-Vorlage
grade
- Schwere der Meldungdomain
- Art der Meldungtext
- Textbestandteile, die verkettet werden. Zur Erzeugung der einzelnen MessageTemplate.OperatingMessageParam
-Instanzen können die statischen Methoden in dieser Klasse benutzt werden.public static MessageTemplate.OperatingMessageParam set(java.lang.String variable, java.lang.String joiner)
Erstellt einen neuen Platzhalter für eine Menge
variable
- Variablennamejoiner
- Verbinder zwischen dem zweitletzen un dem letzten Eintrag. Sinnvoll sind z. B. “, ”, “ und ”, “ sowie ”, …public static MessageTemplate.OperatingMessageParam set(java.lang.String variable, java.lang.String joiner, java.lang.String singular, java.lang.String plural)
Erstellt einen neuen Platzhalter für eine Menge
variable
- Variablennamejoiner
- Verbinder zwischen dem zweitletzten un dem letzten Eintrag. Sinnvoll sind z. B. “, ”, “ und ”, “ sowie ”, …singular
- Singular-Präfixplural
- Plural-Präfixpublic static MessageTemplate.OperatingMessageParam fixed(java.lang.String s)
Erstellt einen festen String-Wert als Textbaustein
s
- Textpublic static MessageTemplate.OperatingMessageParam variable(java.lang.String variable)
Erstellt einen neuen Platzhalter für eine einfache Variable
variable
- Variablennamepublic static MessageTemplate.OperatingMessageParam object()
Erstellt einen neuen Platzhalter für das Objekt, auf das sich die Betriebsmeldung bezieht
public static MessageTemplate.OperatingMessageParam ids()
Erstellt einen neuen Platzhalter für die der Meldung zugeordneten Kennungen (MeldungsTypZusatz). Nicht identisch mit der Meldungs-ID, die zur Verknüpfung von Meldungen verwendet wird.
public MessageTemplate withIdFactory(MessageIdFactory factory)
Gibt eine Kopie dieses Objekts zurück, welches den übergebenen Lambda-Ausdruck zur Erzeugung einer Betriebsmeldungs-ID verwendet
factory
- Lambda-Ausdruck o.ä. zur Erzeugung der Meldungs-IDpublic MessageTemplate withDebugLevel(java.util.logging.Level level)
Gibt eine Kopie dieses Objekts zurück, welches den übergebenen Debug-Level für die Debug-Meldung verwendet (standardmäßig INFO)
level
- Debug-Levelpublic java.util.List<MessageTemplate.OperatingMessageParam> getParams()
Gibt die Textbausteine dieses Objekts zurück
public MessageGrade getGrade()
Gibt die Schwere der Meldung zurück
public MessageType getDomain()
Gibt die Art der Meldung zurück
public OperatingMessage newMessage(SystemObject systemObject)
Erstellt aus der Vorlage ein neues Betriebsmeldungs-Objekt, das mit konkreten Werten gefüllt und dann versand werden kann
systemObject
- Objekt, auf das sich die Meldung bezieht (null ist erlaubt wodurch es dann kein Bezugsobjekt gibt)public java.util.logging.Level getLevel()
Gibt den Level zurück, mit dem erzeugte Meldungen beim Versand über die Debug-Funktionen ausgegeben werden sollen.
Mit Debug.OFF
kann die Ausgabe über Debug deaktiviert werden, dann wird nur die Meldung über den Datenverteiler versendet
public java.lang.String toString()
toString
in class java.lang.Object