de.must.print

Class Report

java.lang.Object

de.must.print.Report

public class Report
extends java.lang.Object

Interface to control report tools. At the moment, Crystal Reports[TM] is supported. ODBC to the database is required. See Crystal Reports[TM] select assistent for how to produce where conditions. The current version of Report.exe is based upon Crystal Reports Version 7 VCL, which seems to be unreliable concerning parameter passing. Any engagement concerning compiling and testing with a newer VCL Version is highly appreciated. Hint: static methods are going to become deprecated. Prefere creating instances of the Report class. The advantage is the option that you may wait until the report is done.

Field Summary

Fields

Modifier and Type	Field and Description
static int	OUTPUT_TO_HTML
static int	OUTPUT_TO_PRINTER
static int	OUTPUT_TO_WINDOW

Constructor Summary

Constructors

Constructor and Description
Report(java.lang.String reportName, ConnectionSpecification connectionSpecification) Constructs a new report.
Report(java.lang.String reportName, java.lang.String odbcName) Constructs a new report.

Method Summary

Modifier and Type	Method and Description
static boolean	exec(java.lang.String reportName, ConnectionSpecification connectionSpecification, boolean outputToWindow) Executes a specified report.
static boolean	exec(java.lang.String reportName, ConnectionSpecification connectionSpecification, boolean outputToWindow, java.lang.String whereCondition) Executes a specified report.
static boolean	exec(java.lang.String reportName, ConnectionSpecification connectionSpecification, boolean outputToWindow, java.lang.String whereCondition, java.lang.String[] parameters) Executes a specified report.
static boolean	exec(java.lang.String reportName, ConnectionSpecification connectionSpecification, int outputType, java.lang.String whereCondition, java.lang.String[] parameters) Executes a specified report.
static boolean	exec(java.lang.String reportName, ConnectionSpecification connectionSpecification, int outputType, java.lang.String whereCondition, java.lang.String[] parameters, java.lang.String outputFileName) Executes a specified report.
static boolean	exec(java.lang.String reportName, java.lang.String odbcName, boolean outputToWindow, java.lang.String whereCondition) Executes a specified report.
boolean	execute() Executes the report assynchroniously
boolean	executeAndWaitUntilDone() Executes the report and waits until the report is done.
void	setOutputType(int outputType) Sets the outputType.
void	setParameters(java.lang.String[] parameters) Sets the parameters.
void	setWhereCondition(java.lang.String whereCondition) Sets the whereCondition.

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_TO_PRINTER

public static final int OUTPUT_TO_PRINTER

See Also:

Constant Field Values

OUTPUT_TO_WINDOW

public static final int OUTPUT_TO_WINDOW

See Also:

Constant Field Values

OUTPUT_TO_HTML

public static final int OUTPUT_TO_HTML

See Also:

Constant Field Values

Constructor Detail

Report

public Report(java.lang.String reportName,
              java.lang.String odbcName)

Constructs a new report. Useful for individual process completion wait.

Parameters:

reportName - the name of the report to be executed

odbcName - the name of the ODBC data source name to connect to

Report

public Report(java.lang.String reportName,
              ConnectionSpecification connectionSpecification)

Constructs a new report. Useful for individual process completion wait.

Parameters:

reportName - the name of the report to be executed

connectionSpecification - the specification to connect to the database

Method Detail

exec

public static boolean exec(java.lang.String reportName,
                           ConnectionSpecification connectionSpecification,
                           boolean outputToWindow)

Executes a specified report.

Parameters:

reportName - the name of the report to be executed

connectionSpecification - the specification to connect to the database

outputToWindow - indicates whether the output is to be presented on screen instead of printing

Returns:

true if no error occurred

exec

public static boolean exec(java.lang.String reportName,
                           java.lang.String odbcName,
                           boolean outputToWindow,
                           java.lang.String whereCondition)

Executes a specified report. If you downloaded the whole framework, it's recommended to use ConnectionSpecification.

Parameters:

reportName - the name of the report to be executed

odbcName - the name of the ODBC data source name to connect to

outputToWindow - indicates whether the output is to be presented on screen instead of printing

whereCondition - a filter definition in Crystal Reports syntax - sample: {tableName.columnName} like '*searchedFragment*'

Returns:

true if no error occurred

exec

public static boolean exec(java.lang.String reportName,
                           ConnectionSpecification connectionSpecification,
                           boolean outputToWindow,
                           java.lang.String whereCondition)

Executes a specified report.

Parameters:

reportName - the name of the report to be executed

connectionSpecification - the specification to connect to the database

outputToWindow - indicates whether the output is to be presented on screen instead of printing

whereCondition - a filter definition in Crystal Reports syntax - sample: {tableName.columnName} like '*searchedFragment*'

Returns:

true if no error occurred

exec

public static boolean exec(java.lang.String reportName,
                           ConnectionSpecification connectionSpecification,
                           boolean outputToWindow,
                           java.lang.String whereCondition,
                           java.lang.String[] parameters)

Executes a specified report.

Parameters:

reportName - the name of the report to be executed

connectionSpecification - the specification to connect to the database

outputToWindow - indicates whether the output is to be presented on screen instead of printing

whereCondition - a filter definition in Crystal Reports syntax - sample: {tableName.columnName} like '*searchedFragment*'

parameters - an array of paramters to be set in Crystal Reports

Returns:

true if no error occurred

exec

public static boolean exec(java.lang.String reportName,
                           ConnectionSpecification connectionSpecification,
                           int outputType,
                           java.lang.String whereCondition,
                           java.lang.String[] parameters)

Executes a specified report.

Parameters:

reportName - the name of the report to be executed

connectionSpecification - the specification to connect to the database

outputType - OUTPUT_TO_PRINTER or OUTPUT_TO_WINDOW OR OUTPUT_TO_HTML;

whereCondition - a filter definition in Crystal Reports syntax - sample: {tableName.columnName} like '*searchedFragment*'

parameters - an array of paramters to be set in Crystal Reports

Returns:

true if no error occurred

exec

public static boolean exec(java.lang.String reportName,
                           ConnectionSpecification connectionSpecification,
                           int outputType,
                           java.lang.String whereCondition,
                           java.lang.String[] parameters,
                           java.lang.String outputFileName)

Executes a specified report.

Parameters:

reportName - the name of the report to be executed

connectionSpecification - the specification to connect to the database

outputType - OUTPUT_TO_PRINTER or OUTPUT_TO_WINDOW OR OUTPUT_TO_HTML;

whereCondition - a filter definition in Crystal Reports syntax - sample: {tableName.columnName} like '*searchedFragment*'

parameters - an array of paramters to be set in Crystal Reports

outputFileName - the complete path of the output file (for HTML output)

Returns:

true if no error occurred

setOutputType

public void setOutputType(int outputType)

Sets the outputType.

Parameters:

outputType - The outputType to set

setParameters

public void setParameters(java.lang.String[] parameters)

Sets the parameters.

Parameters:

parameters - The parameters to set

setWhereCondition

public void setWhereCondition(java.lang.String whereCondition)

Sets the whereCondition.

Parameters:

whereCondition - The whereCondition to set

execute

public boolean execute()

Executes the report assynchroniously

executeAndWaitUntilDone

public boolean executeAndWaitUntilDone()

Executes the report and waits until the report is done.