de.must.print

Class ProportionalListReportByHtml

java.lang.Object

java.lang.Thread

de.must.middle.MustThread

de.must.middle.InterruptibleThread

de.must.middle.InterruptibleBatchThread

de.must.middle.FileOutputThread

de.must.print.ProportionalListReportByHtml

All Implemented Interfaces:

FileDetermination, BatchControllable, Controllable, CoreRunnable, Exemptible, ExemptibleManager, ProportionalListReport, java.lang.Runnable

public abstract class ProportionalListReportByHtml
extends FileOutputThread
implements ProportionalListReport

HTML implementation of the report interface for lists with proportional column definition.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LINE_FIRST
static int	HEADER_LINE_LAST
static int	HEADER_LINE_MIDDLE
static int	HEADER_LINE_ONE_AND_ONLY
protected HtmlFile	out

Fields inherited from class de.must.middle.FileOutputThread

outputPath, writer

Fields inherited from class de.must.middle.InterruptibleBatchThread

sessionResources

Fields inherited from class de.must.middle.InterruptibleThread

threadController

Fields inherited from class de.must.middle.MustThread

threadDoneListeners

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface de.must.print.ProportionalListReport

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from interface de.must.middle.BatchControllable

GROUP_TERMINATION_ALLOWED_WITHOUT_CONFIRMATION, GROUP_TERMINATION_NOT_ALLOWED, GROUP_TERMINATION_REQUIRES_CONFIRMATION

Constructor Summary

Constructors

Constructor and Description
ProportionalListReportByHtml(SessionResources sessionResources, java.lang.String fileName, java.lang.String title, java.lang.String generator) Constructs a new proportional list report
ProportionalListReportByHtml(SessionResources sessionResources, java.lang.String fileName, java.lang.String title, java.lang.String generator, boolean createOut) Constructs a new proportional list report

Method Summary

Modifier and Type	Method and Description
protected void	beginHtml() Begins the HTML instruction set.
protected void	beginHtml(boolean printOnLoad) Begins the HTML instruction set.
protected void	beginTable() Starts a table in for proportional usage.
protected void	beginTableNormal() Starts a table in standard format / non-proportional usage.
protected void	endHtml() Ends the HTML instruction set.
protected void	endTable() Ends the current table.
java.lang.String	getFileName()
protected java.lang.String	getFormattedDate(DataObject dataObject, java.lang.String columnName) Returns a database table date in a formatted way.
protected java.lang.String	getFormattedDate(java.sql.Date date) Formats a date and returns it.
protected void	outputHead(int headerLineType, java.lang.String[] columnHeaders, int[] proportion) Writes the head of the list.
protected void	outputHead(int headerLineType, java.lang.String[] columnHeaders, int[] proportion, int[] alignment) Writes the head of the list with the default proportion.
protected void	outputHead(java.lang.String[] columnHeaders) Writes the head of the list with the default proportion.
protected void	outputHead(java.lang.String[] columnHeaders, int[] proportion) Writes the head of the list with the default proportion.
protected void	outputHead(java.lang.String[] columnHeaders, int[] proportion, int[] alignment) Writes the head of the list with the default proportion (single head line).
protected void	outputParameter(java.lang.String label, java.lang.String value)
protected void	outputSubHeaders(java.lang.String[] columnHeaders, int[] proportion) Outputs sub column headers.
protected void	outputSubHeaders(java.lang.String[] columnHeaders, int[] proportion, int[] alignment) Outputs sub column headers.
protected void	outputTitle(java.lang.String title) Writes the title of the list.
protected void	presentInBrowser() Presents the created file in the browser.
protected void	println(java.lang.String[] values) Outputs one data row of the list in default proportion.
protected void	println(java.lang.String[] values, int[] proportion) Outputs one data row of the list.
protected void	println(java.lang.String[] values, int[] proportion, int[] alignment) Outputs one data row of the list in default proportion.
protected void	println(java.util.Vector<java.lang.Object> values)
protected void	println(java.util.Vector<java.lang.Object> values, int[] proportion)
protected void	printSpaceLine() Prints a space line in a table / an empty row.
protected void	setAlignment(int columnIndex, int alignType) Sets the alignment of a specific column.
void	setColumnSpace(int i) Sets the number of columns to be used to divide data columns.
void	setDefaultProportion(int[] defaultProportion) Sets the column default proportion to influence column width.
void	setLeftMargin(int i) Sets the left margin.
void	setRightMargin(int i) Sets the right margin.
void	setTableWidth(int i) Sets the table width in %.

Methods inherited from class de.must.middle.FileOutputThread

getOutputPath, setOutputFolder, writeTo

Methods inherited from class de.must.middle.InterruptibleBatchThread

getSessionResources, isTerminationRequested, isToRun, requiresUserConfirmationToTerminate, runCore, setTerminationRequiresUserConfirmation, start, terminate

Methods inherited from class de.must.middle.InterruptibleThread

free, register, register, run, runPartAfterCore, setStatusInformation, setThreadController

Methods inherited from class de.must.middle.MustThread

addThreadDoneListener, fireThreadDone, fireThreadDone, getEventMessage, getFinalState, idle, logDebug, logError, logError, logInfo, setEventErrorMessage, setEventMessage, setFinalState

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.must.middle.Controllable

addThreadDoneListener, runCore, setThreadController, start

Methods inherited from interface de.must.middle.BatchControllable

getName

Methods inherited from interface de.must.middle.CoreRunnable

runCore

Field Detail

HEADER_LINE_ONE_AND_ONLY

public static final int HEADER_LINE_ONE_AND_ONLY

See Also:

Constant Field Values

HEADER_LINE_FIRST

public static final int HEADER_LINE_FIRST

See Also:

Constant Field Values

HEADER_LINE_MIDDLE

public static final int HEADER_LINE_MIDDLE

See Also:

Constant Field Values

HEADER_LINE_LAST

public static final int HEADER_LINE_LAST

See Also:

Constant Field Values

out

protected HtmlFile out

Constructor Detail

ProportionalListReportByHtml

public ProportionalListReportByHtml(SessionResources sessionResources,
                                    java.lang.String fileName,
                                    java.lang.String title,
                                    java.lang.String generator)
                             throws java.io.IOException

Constructs a new proportional list report

Parameters:

sessionResources - the session resources to use

fileName - the name of the output file

title - the title of the report

generator - the report's generator identification

Throws:

java.io.IOException

ProportionalListReportByHtml

public ProportionalListReportByHtml(SessionResources sessionResources,
                                    java.lang.String fileName,
                                    java.lang.String title,
                                    java.lang.String generator,
                                    boolean createOut)
                             throws java.io.IOException

Constructs a new proportional list report

Parameters:

sessionResources - the session resources to use

fileName - the name of the output file

title - the title of the report

generator - the report's generator identification

createOut - whether or not output is to create right now

Throws:

java.io.IOException

Method Detail

getFileName

public java.lang.String getFileName()

Specified by:

getFileName in interface FileDetermination

setColumnSpace

public void setColumnSpace(int i)

Sets the number of columns to be used to divide data columns.

Parameters:

i - the number of columns to be used to divide data columns

setLeftMargin

public void setLeftMargin(int i)

Sets the left margin. When printed, this margin is added to the standard left margin.

Parameters:

i - the new left margin

setRightMargin

public void setRightMargin(int i)

Sets the right margin.

Parameters:

i - the new right margin

setTableWidth

public void setTableWidth(int i)

Sets the table width in %.

Parameters:

i - the new table width in %

setDefaultProportion

public void setDefaultProportion(int[] defaultProportion)

Sets the column default proportion to influence column width.

Specified by:

setDefaultProportion in interface ProportionalListReport

Parameters:

defaultProportion - the proportion usually to be used

setAlignment

protected void setAlignment(int columnIndex,
                            int alignType)

Sets the alignment of a specific column.

Parameters:

columnIndex - the index of the regarded column

alignType - the align type of the specified column

See Also:

ProportionalListReport.ALIGN_LEFT, ProportionalListReport.ALIGN_CENTER, ProportionalListReport.ALIGN_RIGHT

beginHtml

protected void beginHtml()

Begins the HTML instruction set.

beginHtml

protected void beginHtml(boolean printOnLoad)

Begins the HTML instruction set.

Parameters:

printOnLoad - whether body tag should include onLoad="print()"

outputTitle

protected void outputTitle(java.lang.String title)

Writes the title of the list.

Parameters:

title - the title of the list

outputParameter

protected void outputParameter(java.lang.String label,
                               java.lang.String value)

outputHead

protected void outputHead(java.lang.String[] columnHeaders)

Writes the head of the list with the default proportion.

Parameters:

columnHeaders - the column headers

See Also:

setDefaultProportion(int[])

outputHead

protected void outputHead(java.lang.String[] columnHeaders,
                          int[] proportion,
                          int[] alignment)

Writes the head of the list with the default proportion (single head line).

Parameters:

columnHeaders - the column headers

proportion - the used proportion for this table header

alignment - the alignment of the table header

outputHead

protected void outputHead(int headerLineType,
                          java.lang.String[] columnHeaders,
                          int[] proportion,
                          int[] alignment)

Writes the head of the list with the default proportion.

Parameters:

headerLineType - see HEADER_LINE_*

columnHeaders - the column headers

proportion - the used proportion for this table header

alignment - the alignment of the table header

See Also:

HEADER_LINE_ONE_AND_ONLY, HEADER_LINE_FIRST, HEADER_LINE_MIDDLE, HEADER_LINE_LAST

outputHead

protected void outputHead(java.lang.String[] columnHeaders,
                          int[] proportion)

Writes the head of the list with the default proportion.

Parameters:

columnHeaders - the column headers

proportion - the column proportion to be used

outputHead

protected void outputHead(int headerLineType,
                          java.lang.String[] columnHeaders,
                          int[] proportion)

Writes the head of the list.

Parameters:

headerLineType - the header line type

columnHeaders - the column headers

proportion - the column proportion to be used

See Also:

HEADER_LINE_ONE_AND_ONLY, HEADER_LINE_FIRST, HEADER_LINE_MIDDLE, HEADER_LINE_LAST

outputSubHeaders

protected void outputSubHeaders(java.lang.String[] columnHeaders,
                                int[] proportion,
                                int[] alignment)

Outputs sub column headers.

Parameters:

columnHeaders - the column headers

proportion - the column proportion to be used

alignment - the alignment of these row cells

outputSubHeaders

protected void outputSubHeaders(java.lang.String[] columnHeaders,
                                int[] proportion)

Outputs sub column headers.

Parameters:

columnHeaders - the column headers

proportion - the column proportion to be used

printSpaceLine

protected void printSpaceLine()

Prints a space line in a table / an empty row.

println

protected void println(java.lang.String[] values)

Outputs one data row of the list in default proportion.

Parameters:

values - the row values

println

protected void println(java.lang.String[] values,
                       int[] proportion,
                       int[] alignment)

Outputs one data row of the list in default proportion.

Parameters:

values - the row values

proportion - the column proportion to be used

alignment - the alignment of these row cells

println

protected void println(java.lang.String[] values,
                       int[] proportion)

Outputs one data row of the list.

Parameters:

values - the row values

proportion - the column proportion to be used

println

protected void println(java.util.Vector<java.lang.Object> values)

println

protected void println(java.util.Vector<java.lang.Object> values,
                       int[] proportion)

beginTableNormal

protected void beginTableNormal()

Starts a table in standard format / non-proportional usage. This may be useful to present parameters before the report table begins.

beginTable

protected void beginTable()

Starts a table in for proportional usage.

endTable

protected void endTable()

Ends the current table.

getFormattedDate

protected java.lang.String getFormattedDate(DataObject dataObject,
                                            java.lang.String columnName)

Returns a database table date in a formatted way.

Parameters:

dataObject - the DataObject used to access the table

columnName - the name of the column containing the date value

Returns:

the formatted date

getFormattedDate

protected java.lang.String getFormattedDate(java.sql.Date date)

Formats a date and returns it.

Parameters:

the - date to be formatted

Returns:

the formatted date

endHtml

protected void endHtml()

Ends the HTML instruction set.

presentInBrowser

protected void presentInBrowser()

Presents the created file in the browser.