de.must.io

Class MarkupFile

java.lang.Object

de.must.io.MarkupFile

Direct Known Subclasses:

HtmlFile, XmlFile

public abstract class MarkupFile
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	fileExtension
protected java.lang.String	fileName
protected java.lang.String	generator
protected int	mode
static int	MODE_HTML
static int	MODE_XML_XSL
protected java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
MarkupFile(java.lang.String fileName, java.lang.String fileExtension, java.lang.String title, java.lang.String generator) Constructs a new MarkupFile.
MarkupFile(java.io.Writer writer, java.lang.String fileName, java.lang.String fileExtension, java.lang.String title, java.lang.String generator) Constructs a new MarkupFile.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file.
protected void	finalize()
void	flush() Flushes the stream.
protected abstract java.lang.String	getConvertedString(char charToConvert)
void	list(DataObject DataObjectToList, java.lang.String[] columns)
void	list(DataObject DataObjectToList, java.lang.String[] columns, ProgressFrame ControllingProgressFrame)
void	openOutputFile(java.lang.String outputFileName)
void	openOutputWriter(java.io.Writer writer)
protected abstract void	outputFooter()
protected abstract void	outputHeader()
protected abstract void	outputItem(DataObject DataObjectToList, java.lang.String[] columns)
void	presentInBrowser() Presents the created file in the browser.
protected boolean	startTableIfNecessary()
protected boolean	stopTableIfNecessary()
void	write(java.lang.String fragment)
void	writeln(java.lang.String line)
void	writelnNonConverted(java.lang.String line)
void	writeNonConverted(java.lang.String fragment)

Methods inherited from class java.lang.Object

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

Field Detail

fileName

protected java.lang.String fileName

fileExtension

protected java.lang.String fileExtension

title

protected java.lang.String title

generator

protected java.lang.String generator

MODE_HTML

public static final int MODE_HTML

See Also:

Constant Field Values

MODE_XML_XSL

public static final int MODE_XML_XSL

See Also:

Constant Field Values

mode

protected int mode

Constructor Detail

MarkupFile

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

Constructs a new MarkupFile.

Parameters:

fileName - the name / path of the file without extension

fileExtension - the file extension

title - the title of the HTML file

generator - the generator

Throws:

java.io.IOException

MarkupFile

public MarkupFile(java.io.Writer writer,
                  java.lang.String fileName,
                  java.lang.String fileExtension,
                  java.lang.String title,
                  java.lang.String generator)
           throws java.io.IOException

Constructs a new MarkupFile.

Parameters:

writer - the writer to stream output to - may be null for file output

fileName - the name / path of the file without extension

fileExtension - the file extension

title - the title of the HTML file

generator - the generator

Throws:

java.io.IOException

Method Detail

list

public void list(DataObject DataObjectToList,
                 java.lang.String[] columns)

list

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

outputHeader

protected abstract void outputHeader()

outputItem

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

outputFooter

protected abstract void outputFooter()

getConvertedString

protected abstract java.lang.String getConvertedString(char charToConvert)

startTableIfNecessary

protected boolean startTableIfNecessary()

stopTableIfNecessary

protected boolean stopTableIfNecessary()

openOutputFile

public void openOutputFile(java.lang.String outputFileName)
                    throws java.io.IOException

Throws:

java.io.IOException

openOutputWriter

public void openOutputWriter(java.io.Writer writer)

write

public void write(java.lang.String fragment)

writeln

public void writeln(java.lang.String line)

writelnNonConverted

public void writelnNonConverted(java.lang.String line)

writeNonConverted

public void writeNonConverted(java.lang.String fragment)

presentInBrowser

public void presentInBrowser()

Presents the created file in the browser.

flush

public void flush()

Flushes the stream.

close

public void close()

Closes the file.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable