public class SystemObjectInfo
extends java.lang.Object
Klasse zum Zugriff auf beschreibende Informationen von Systemobjekten.
puk.configuration
Modifier and Type | Field and Description |
---|---|
private static Debug |
_debug
DebugLogger für Debug-Ausgaben
|
private java.lang.String |
_descriptionAsHTML
Beschreibung im HTML-Format
|
private java.lang.String |
_descriptionAsXML
Beschreibung im XML-Format der Versorgungsdateien
|
private java.lang.Object |
_lock
Objekt für die synchronisierte Umwandlung der Kurzinfo/Beschreibung vom XML-Format ins HTML-Format
|
private java.lang.String |
_shortInfoAsHTML
Kurzinfo im HTML-Format
|
private java.lang.String |
_shortInfoAsXML
Kurzinfo im XML-Format der Versorgungsdateien
|
static SystemObjectInfo |
UNDEFINED
der undefinierte Zustand dieses Info-Objekts
|
Constructor and Description |
---|
SystemObjectInfo(java.lang.String shortInfo,
java.lang.String description)
Initialisiert ein neues Info-Objekt mit beschreibenden Informationen eines Systemobjekts.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die
HTML konform ist. |
java.lang.String |
getDescriptionAsMarkdown()
Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die in
Markdown formatiert ist. |
java.lang.String |
getDescriptionAsXML()
Liefert die ausführliche Beschreibung des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht.
|
private java.lang.String |
getHTMLText(java.lang.String text)
Wandelt Text im XML-Format in einen Text im HTML-Format um.
|
private java.lang.String |
getMarkdownText(java.lang.String text)
Wandelt Text im XML-Format in einen Text im Markdown-Format um.
|
java.lang.String |
getShortInfo()
Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die
HTML konform ist. |
java.lang.String |
getShortInfoAsMarkdown()
Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die in
Markdown formatiert ist. |
java.lang.String |
getShortInfoAsXML()
Liefert die Kurzinformation des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht.
|
java.lang.String |
toString()
String-Repräsentation dieses Objekts.
|
private void |
transferXml(org.w3c.dom.NodeList nodes,
java.lang.StringBuilder resultText)
Parst den Text nach XML-Tags und gibt sie zur weiteren Verarbeitung an die Methoden
transferXml(org.w3c.dom.Node, StringBuilder) weiter. |
private void |
transferXml(org.w3c.dom.Node node,
java.lang.StringBuilder resultText)
Ersetzt einzelne XML-Tags durch passende HTML-Tags
|
private void |
transferXmlToMarkdown(org.w3c.dom.NodeList nodes,
java.lang.StringBuilder resultText)
Parst den Text nach XML-Tags und gibt sie zur weiteren Verarbeitung an die Methoden
transferXmlToMarkdown(org.w3c.dom.Node, StringBuilder) weiter. |
private void |
transferXmlToMarkdown(org.w3c.dom.Node node,
java.lang.StringBuilder resultText)
Ersetzt einzelne XML-Tags durch passende Markdown-Tags
|
private static final Debug _debug
DebugLogger für Debug-Ausgaben
private java.lang.String _shortInfoAsHTML
Kurzinfo im HTML-Format
private java.lang.String _descriptionAsHTML
Beschreibung im HTML-Format
private final java.lang.String _shortInfoAsXML
Kurzinfo im XML-Format der Versorgungsdateien
private final java.lang.String _descriptionAsXML
Beschreibung im XML-Format der Versorgungsdateien
private final java.lang.Object _lock
Objekt für die synchronisierte Umwandlung der Kurzinfo/Beschreibung vom XML-Format ins HTML-Format
public static final SystemObjectInfo UNDEFINED
der undefinierte Zustand dieses Info-Objekts
public SystemObjectInfo(java.lang.String shortInfo, java.lang.String description)
Initialisiert ein neues Info-Objekt mit beschreibenden Informationen eines Systemobjekts.
shortInfo
- Kurze beschreibende Information des jeweiligen Systemobjekts.description
- Ausführliche Beschreibung des jeweiligen Systemobjekts.public java.lang.String getShortInfo()
Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die HTML
konform ist.
HTML
konformer Text, der die Kurzbeschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getShortInfoAsMarkdown()
Lieferte eine kurze beschreibende Information des jeweiligen Systemobjekts zurück, die in Markdown
formatiert ist.
Markdown
konformer Text, der die Kurzbeschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getDescription()
Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die HTML
konform ist.
HTML
konformer Text, der die ausführliche Beschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getDescriptionAsMarkdown()
Lieferte eine ausführliche Beschreibung des jeweiligen Systemobjekts zurück, die in Markdown
formatiert ist.
Markdown
konformer Text, der die ausführliche Beschreibung enthält. Ist keine Beschreibung vorhanden, wird ein leerer String ""
zurückgegeben.public java.lang.String getShortInfoAsXML()
Liefert die Kurzinformation des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht. Die Formatierung entspricht der K2S.DTD.
public java.lang.String getDescriptionAsXML()
Liefert die ausführliche Beschreibung des jeweiligen Systemobjekts zurück, wie sie in der Versorgungsdatei steht. Die Formatierung entspricht der K2S.DTD.
public java.lang.String toString()
String-Repräsentation dieses Objekts. Enthält die Kurzinformation und die ausführliche Beschreibung.
toString
in class java.lang.Object
getShortInfo()
,
getDescription()
private java.lang.String getHTMLText(java.lang.String text)
Wandelt Text im XML-Format in einen Text im HTML-Format um.
text
- umzuwandelnder Text im XML-Formatprivate java.lang.String getMarkdownText(java.lang.String text)
Wandelt Text im XML-Format in einen Text im Markdown-Format um.
text
- umzuwandelnder Text im XML-Formatprivate void transferXml(org.w3c.dom.Node node, java.lang.StringBuilder resultText)
Ersetzt einzelne XML-Tags durch passende HTML-Tags
node
- XML-TagresultText
- umgewandelter Text in HTML-Formatprivate void transferXml(org.w3c.dom.NodeList nodes, java.lang.StringBuilder resultText)
Parst den Text nach XML-Tags und gibt sie zur weiteren Verarbeitung an die Methoden transferXml(org.w3c.dom.Node, StringBuilder)
weiter.
nodes
- alle im Text enthaltenen TagsresultText
- den im HTML-Format umgewandelten Textprivate void transferXmlToMarkdown(org.w3c.dom.Node node, java.lang.StringBuilder resultText)
Ersetzt einzelne XML-Tags durch passende Markdown-Tags
node
- XML-TagresultText
- umgewandelter Text in Markdown-Formatprivate void transferXmlToMarkdown(org.w3c.dom.NodeList nodes, java.lang.StringBuilder resultText)
Parst den Text nach XML-Tags und gibt sie zur weiteren Verarbeitung an die Methoden transferXmlToMarkdown(org.w3c.dom.Node, StringBuilder)
weiter.
nodes
- alle im Text enthaltenen TagsresultText
- den im Markdown-Format umgewandelten Text