Class StandardProtocoller
- java.lang.Object
-
- de.bsvrz.pat.onlprot.standardProtocolModule.ProtocolModule
-
- de.bsvrz.pat.onlprot.standardProtocolModule.StandardProtocoller
-
- All Implemented Interfaces:
ProtocolModuleInterface
public class StandardProtocoller extends ProtocolModule
Der Standardprotokollierer, welcher eine tabellarische Ausgabe (in drei verschieden ausführlichen Tiefen) und eine XML-Ausgabe erzeugen kann.
-
-
Constructor Summary
Constructors Constructor Description StandardProtocoller()
Erzeugt ein neues Objekt der KlasseStandardProtocoller
mit demactionText
AktualisierungStandardProtocoller(java.lang.String actionText)
Erzeugt ein neues Objekt der KlasseStandardProtocoller
mit speziellemactionText
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Standardprotokollierers aus.java.lang.String
getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurückprotected de.bsvrz.sys.funclib.commandLineArgs.ArgumentList.ValueSelection
getProtocollerSelection()
Stellt Liste der bekannten Protokollierer zusammen.de.bsvrz.dav.daf.main.ClientReceiverInterface
initProtocol(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList argumentList, java.io.PrintWriter protocolFileWriter, java.lang.String[] args)
Führt die Initialisierungsschritte des Standardprotokollierers aus.de.bsvrz.dav.daf.main.ClientReceiverInterface
initProtocolWithoutHeader(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList protocollerArgumentList, java.io.PrintWriter printWriter)
Führt die Initialisierungsschritte des Standardprotokollierers aus.void
update(de.bsvrz.dav.daf.main.ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes vom benutzten Protokollierer aufgerufen wird.-
Methods inherited from class de.bsvrz.pat.onlprot.standardProtocolModule.ProtocolModule
getProtocolFileWriter, getProtocoller, setProtocolFileWriter, setProtocoller
-
-
-
-
Constructor Detail
-
StandardProtocoller
public StandardProtocoller()
Erzeugt ein neues Objekt der KlasseStandardProtocoller
mit demactionText
Aktualisierung
-
StandardProtocoller
public StandardProtocoller(java.lang.String actionText)
Erzeugt ein neues Objekt der KlasseStandardProtocoller
mit speziellemactionText
- Parameters:
actionText
- String mit dem gewünschten Ausgabetext bei Aktualisierungen
-
-
Method Detail
-
getHelp
public java.lang.String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück- Specified by:
getHelp
in interfaceProtocolModuleInterface
- Specified by:
getHelp
in classProtocolModule
- Returns:
- String mit der Beschreibung der erlaubten Aufrufparameter und deren erwartetes Format
-
initProtocol
public de.bsvrz.dav.daf.main.ClientReceiverInterface initProtocol(de.bsvrz.sys.funclib.commandLineArgs.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.- Specified by:
initProtocol
in interfaceProtocolModuleInterface
- Overrides:
initProtocol
in classProtocolModule
- Parameters:
argumentList
-ArgumentList
der noch nicht ausgewerteten Aufrufparameter der ApplikationprotocolFileWriter
- PrintWriter der protokollierten Datensequenzenargs
- String[] mit den Kommandozeilenargumenten- Returns:
- ClientReceiverInterface-Handle auf den benutzten Protokollierer
-
initProtocolWithoutHeader
public de.bsvrz.dav.daf.main.ClientReceiverInterface initProtocolWithoutHeader(de.bsvrz.sys.funclib.commandLineArgs.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.- Parameters:
protocollerArgumentList
-printWriter
-- Returns:
-
update
public void update(de.bsvrz.dav.daf.main.ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes vom benutzten Protokollierer aufgerufen wird.- Specified by:
update
in classProtocolModule
- Parameters:
results
-ResultData
[] mit den empfangenen Ergebnisdatensätzen- See Also:
ClientReceiverInterface.update(de.bsvrz.dav.daf.main.ResultData[])
-
closeProtocol
public void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Standardprotokollierers aus. Fußzeilen werden geschrieben und der Ausgabe-Stream geschlossen.- Specified by:
closeProtocol
in interfaceProtocolModuleInterface
- Specified by:
closeProtocol
in classProtocolModule
-
getProtocollerSelection
protected de.bsvrz.sys.funclib.commandLineArgs.ArgumentList.ValueSelection getProtocollerSelection()
Stellt Liste der bekannten Protokollierer zusammen. Kann bei der Interpretation von Aufrufargumenten mit der MethodeArgumentList.Argument.asValueCase(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList.ValueSelection)
benutzt werden, um eine der verschiedenen Ausgabeoptionen auszuwählen.- Returns:
- ValueSelection mit den erlaubten Protokollierern
-
-