public class StandardProtocoller extends ProtocolModule
Der Standardprotokollierer, welcher eine tabellarische Ausgabe (in drei verschieden ausführlichen Tiefen) und eine XML-Ausgabe erzeugen kann.
Modifier and Type | Class and Description |
---|---|
private class |
StandardProtocoller.DataProtocoller
Gibt bei jeder Aktualisierung zusätzlich die Attributwerte der enthaltenen Datensätze aus.
|
private class |
StandardProtocoller.HeaderProtocoller
Gibt bei jeder Aktualisierung zusätzlich die Köpfe der enthaltenen Datensätze aus.
|
private class |
StandardProtocoller.SilentProtocoller
Keine Ausgabe.
|
private class |
StandardProtocoller.UpdateSummaryProtocoller
Gibt bei jeder Aktualisierung die Anzahl der enthaltenen Datensätze aus.
|
private class |
StandardProtocoller.XmlProtocoller
Gibt die Telegramme in einem XML-Format aus.
|
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
_actionText
Wird in
StandardProtocoller.UpdateSummaryProtocoller.update(de.bsvrz.dav.daf.main.ResultData[]) als Informationstext ausgegeben |
private static java.text.DateFormat |
_dateFormat
Datums-Format
|
private static java.lang.Object |
_memoryUsage
Objekt, dessen toString Methode Infos über die aktuelle Hauptspeicherverwendung der Applikation zurückgibt.
|
private static java.text.DateFormat |
dateFormat
Schreibt String-Format der Zeitstempel vor
|
private static Debug |
debug
Die Debug-Ausgabe
|
private static int |
FOOTER_WRITTEN
Konstante für
state : Es wurde ein Protokollfuß ausgegeben. |
private static int |
HEADER_WRITTEN
Konstante für
state : Es wurde bereits ein Protokollkopf, aber noch kein -fuß ausgegeben. |
private static java.lang.String |
indentationPrefix
Beschreibt Zeichenkette, die in jeder Zeile pro Einrückungsebene ausgegeben wird
|
private static int |
NO_HEADER_WRITTEN
Konstante für
state : Es wurde noch kein Protokollkopf ausgegeben. |
private long |
resultDataCount
Anzahl der bereits empfangenen Datensätze
|
private int |
state
Zustand des Protokollierers:
state == NO_HEADER_WRITTEN : Ausgangszustand: noch keinen Kopf geschrieben state == HEADER_WRITTEN : Kopf wurde ausgegeben. |
private long |
updateCount
Anzahl der Aufrufe von
StandardProtocoller.UpdateSummaryProtocoller.update(de.bsvrz.dav.daf.main.ResultData[]) |
Constructor and Description |
---|
StandardProtocoller()
Erzeugt ein neues Objekt der Klasse
StandardProtocoller mit dem actionText Aktualisierung |
StandardProtocoller(java.lang.String actionText)
Erzeugt ein neues Objekt der Klasse
StandardProtocoller mit speziellem actionText |
Modifier and Type | Method and Description |
---|---|
void |
closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Standardprotokollierers aus.
|
java.lang.String |
getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
|
protected ArgumentList.ValueSelection |
getProtocollerSelection()
Stellt Liste der bekannten Protokollierer zusammen.
|
ClientReceiverInterface |
initProtocol(ArgumentList argumentList,
java.io.PrintWriter protocolFileWriter,
java.lang.String[] args)
Führt die Initialisierungsschritte des Standardprotokollierers aus.
|
ClientReceiverInterface |
initProtocolWithoutHeader(ArgumentList protocollerArgumentList,
java.io.PrintWriter printWriter)
Führt die Initialisierungsschritte des Standardprotokollierers aus.
|
void |
update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes vom benutzten Protokollierer aufgerufen wird.
|
getProtocolFileWriter, getProtocoller, setProtocolFileWriter, setProtocoller
private static final Debug debug
Die Debug-Ausgabe
private static final java.text.DateFormat _dateFormat
Datums-Format
private static final java.text.DateFormat dateFormat
Schreibt String-Format der Zeitstempel vor
private static final java.lang.String indentationPrefix
Beschreibt Zeichenkette, die in jeder Zeile pro Einrückungsebene ausgegeben wird
private static final int NO_HEADER_WRITTEN
Konstante für state
: Es wurde noch kein Protokollkopf ausgegeben.
private static final int HEADER_WRITTEN
Konstante für state
: Es wurde bereits ein Protokollkopf, aber noch kein -fuß ausgegeben.
private static final int FOOTER_WRITTEN
Konstante für state
: Es wurde ein Protokollfuß ausgegeben.
private final java.lang.String _actionText
Wird in StandardProtocoller.UpdateSummaryProtocoller.update(de.bsvrz.dav.daf.main.ResultData[])
als Informationstext ausgegeben
private long resultDataCount
Anzahl der bereits empfangenen Datensätze
private int state
Zustand des Protokollierers:
state == NO_HEADER_WRITTEN
: Ausgangszustand: noch keinen Kopf geschrieben state == HEADER_WRITTEN
: Kopf wurde ausgegeben. Telegramme werden erwartet und Fußtext kann geschrieben werden. state == FOOTER_WRITTEN
: Fuß wurde ausgegeben. Die Protokollierung ist damit abgeschlossen. Es können keine weiteren Ausgaben folgen. private long updateCount
Anzahl der Aufrufe von StandardProtocoller.UpdateSummaryProtocoller.update(de.bsvrz.dav.daf.main.ResultData[])
private static java.lang.Object _memoryUsage
Objekt, dessen toString Methode Infos über die aktuelle Hauptspeicherverwendung der Applikation zurückgibt. Das Objekt kann in Debug-Nachrichten als zweiter Parameter benutzt werden. Die toString-Methode wird dann nur aufgerufen, wenn das Debug-Level so hoch eingestellt ist, dass die Meldung tatsächlich ausgegeben wird.
public StandardProtocoller()
Erzeugt ein neues Objekt der Klasse StandardProtocoller
mit dem actionText
Aktualisierung
public StandardProtocoller(java.lang.String actionText)
Erzeugt ein neues Objekt der Klasse StandardProtocoller
mit speziellem actionText
actionText
- String mit dem gewünschten Ausgabetext bei Aktualisierungenpublic java.lang.String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
getHelp
in interface ProtocolModuleInterface
getHelp
in class ProtocolModule
public ClientReceiverInterface initProtocol(ArgumentList argumentList, java.io.PrintWriter protocolFileWriter, java.lang.String[] args)
Führt die Initialisierungsschritte des Standardprotokollierers aus. Insbesondere wird einer der gültigen Protokollierer ausgewählt und der Protokollkopf ausgegeben.
initProtocol
in interface ProtocolModuleInterface
initProtocol
in class ProtocolModule
argumentList
- ArgumentList
der noch nicht ausgewerteten Aufrufparameter der ApplikationprotocolFileWriter
- PrintWriter der protokollierten Datensequenzenargs
- String[] mit den Kommandozeilenargumentenpublic ClientReceiverInterface initProtocolWithoutHeader(ArgumentList protocollerArgumentList, java.io.PrintWriter printWriter)
Führt die Initialisierungsschritte des Standardprotokollierers aus. Insbesondere wird einer der gültigen Protokollierer ausgewählt. In dieser Variante wird der Protokollkopf nicht ausgegeben.
protocollerArgumentList
- printWriter
- public void update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes vom benutzten Protokollierer aufgerufen wird.
update
in class ProtocolModule
results
- ResultData
[] mit den empfangenen ErgebnisdatensätzenClientReceiverInterface.update(de.bsvrz.dav.daf.main.ResultData[])
public void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Standardprotokollierers aus. Fußzeilen werden geschrieben und der Ausgabe-Stream geschlossen.
closeProtocol
in interface ProtocolModuleInterface
closeProtocol
in class ProtocolModule
protected ArgumentList.ValueSelection getProtocollerSelection()
Stellt Liste der bekannten Protokollierer zusammen. Kann bei der Interpretation von Aufrufargumenten mit der Methode ArgumentList.Argument.asValueCase(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList.ValueSelection)
benutzt werden, um eine der verschiedenen Ausgabeoptionen auszuwählen.