de.must.io

Class XmlFile

java.lang.Object

de.must.io.MarkupFile

de.must.io.XmlFile

public class XmlFile
extends MarkupFile

XML output class. Association with data objects may provide easy listings. Sample:

       DoKontakt doKontakt1 = new DoKontakt();
       doKontakt1.select("*", "TELENR <> \'\'", "NAMNAC, NAMVOR");
       de.must.io.XmlFile XmlFile1 = new de.must.io.XmlFile("Fon", "Telefonliste", "MustMarketing");
       XmlFile1.list(doKontakt1, new String[] {"NAMNAC", "NAMVOR", "TELENR", "FONPRV"});
       XmlFile1.close();
       XmlFile1.presentInBrowser();
       doKontakt1.closeQuery();
 

Field Summary

Fields inherited from class de.must.io.MarkupFile

fileExtension, fileName, generator, mode, MODE_HTML, MODE_XML_XSL, title

Constructor Summary

Constructors

Constructor and Description
XmlFile(java.lang.String fileName, java.lang.String title, java.lang.String generator) Constructs a new XML ouput file.

Method Summary

Modifier and Type	Method and Description
void	addElement(java.lang.String elementName, java.lang.String value) Adds an element.
void	addElementNonConverted(java.lang.String elementName, java.lang.String value) Adds an element.
void	completeAllOpenTagNodes() Completes all open tag nodes.
void	completeCurrentTagNode() Completes the current tag node and goes one step back in element hierarchy.
protected java.lang.String	getConvertedString(char charToConvert) Returns the HTML compatible converted string.
void	list(DataObject dataObjectToList, java.lang.String[] columns, ProgressFrame ControllingProgressFrame) List the content of the data object as previously selected.
void	newTagNode(java.lang.String nodeName) Begins a new tag node.
protected void	outputFooter() Outputs the footer.
protected void	outputHeader() Outputs the header.
void	outputHeader(java.lang.String xslFileName) Outputs the header.
protected void	outputItem(DataObject DataObjectToList, java.lang.String[] columns) Ouptuts items (columns) of the current row of the data object.
void	outputStandardEntityDefinitionList() Outputs the standard entitiy definition list.
void	presentInBrowser() Presents the XML file in the browser.

Methods inherited from class de.must.io.MarkupFile

close, finalize, flush, list, openOutputFile, openOutputWriter, startTableIfNecessary, stopTableIfNecessary, write, writeln, writelnNonConverted, writeNonConverted

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlFile

public XmlFile(java.lang.String fileName,
               java.lang.String title,
               java.lang.String generator)
        throws java.io.IOException

Constructs a new XML ouput file.

Parameters:

fileName - the name of the output file (path)

title - the title of the XML file

generator - the name of the generator

Throws:

java.io.IOException

Method Detail

list

public void list(DataObject dataObjectToList,
                 java.lang.String[] columns,
                 ProgressFrame ControllingProgressFrame)

List the content of the data object as previously selected.

Overrides:

list in class MarkupFile

Parameters:

dataObjectToList - the data object, whose selectted content is to be listed

columns - the columns to list

ControllingProgressFrame - the controlling progress frame

outputHeader

protected void outputHeader()

Outputs the header.

Specified by:

outputHeader in class MarkupFile

outputHeader

public void outputHeader(java.lang.String xslFileName)

Outputs the header.

Parameters:

xslFileName - the name of the xslFileName to use.

outputStandardEntityDefinitionList

public void outputStandardEntityDefinitionList()

Outputs the standard entitiy definition list.

outputItem

protected void outputItem(DataObject DataObjectToList,
                          java.lang.String[] columns)

Ouptuts items (columns) of the current row of the data object.

Specified by:

outputItem in class MarkupFile

Parameters:

dataObjectToList - the data object, whose selectted content is to be listed

columns - the columns to list

outputFooter

protected void outputFooter()

Outputs the footer.

Specified by:

outputFooter in class MarkupFile

getConvertedString

protected java.lang.String getConvertedString(char charToConvert)

Returns the HTML compatible converted string.

Specified by:

getConvertedString in class MarkupFile

Parameters:

charToConvert - the char to convert

Returns:

the HTML compatible converted string

newTagNode

public void newTagNode(java.lang.String nodeName)

Begins a new tag node.

Parameters:

nodeName - the name of the tag to begin

addElement

public void addElement(java.lang.String elementName,
                       java.lang.String value)

Adds an element.

Parameters:

elementName - the name of the element

value - the value of the element

addElementNonConverted

public void addElementNonConverted(java.lang.String elementName,
                                   java.lang.String value)

Adds an element.

Parameters:

elementName - the name of the element

value - the value of the element

completeCurrentTagNode

public void completeCurrentTagNode()

Completes the current tag node and goes one step back in element hierarchy.

completeAllOpenTagNodes

public void completeAllOpenTagNodes()

Completes all open tag nodes.

presentInBrowser

public void presentInBrowser()

Presents the XML file in the browser.

Overrides:

presentInBrowser in class MarkupFile