net.sf.jasperreports.engine
Class JasperCompileManager

java.lang.Object
  net.sf.jasperreports.engine.JasperCompileManager

public final class JasperCompileManager
extends java.lang.Object

Fa�ade class for compiling report designs into the ready-to-fill form and for getting the XML representation of report design objects for storage or network transfer.

Version:

$Id: JasperCompileManager.java 5180 2012-03-29 13:23:12Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

JasperDesign, JasperReport, JRCompiler, JRVerifier, JRXmlLoader, JRXmlWriter, JRLoader, JRSaver

Method Summary

JasperReport	compile(java.io.InputStream inputStream) Compiles the serialized report design object read from the supplied input stream and returns the generated compiled report design object.
JasperReport	compile(JasperDesign jasperDesign) Compiles the report design object received as parameter and returns the generated compiled report design object.
JasperReport	compile(java.lang.String sourceFileName) Compiles the XML report design file received as parameter, and returns the compiled report design object.
static JasperReport	compileReport(java.io.InputStream inputStream)
static JasperReport	compileReport(JasperDesign jasperDesign)
static JasperReport	compileReport(java.lang.String sourceFileName)
static void	compileReportToFile(JasperDesign jasperDesign, java.lang.String destFileName)
static java.lang.String	compileReportToFile(java.lang.String sourceFileName)
static void	compileReportToFile(java.lang.String sourceFileName, java.lang.String destFileName)
static void	compileReportToStream(java.io.InputStream inputStream, java.io.OutputStream outputStream)
static void	compileReportToStream(JasperDesign jasperDesign, java.io.OutputStream outputStream)
void	compileToFile(JasperDesign jasperDesign, java.lang.String destFileName) Compiles the report design object received as the first parameter, placing the result in the file specified by the second parameter.
java.lang.String	compileToFile(java.lang.String sourceFileName) Compiles the XML report design file specified by the parameter.
void	compileToFile(java.lang.String sourceFileName, java.lang.String destFileName) Compiles the XML report design file received as the first parameter, placing the result in the file specified by the second parameter.
void	compileToStream(java.io.InputStream inputStream, java.io.OutputStream outputStream) Compiles the XML representation of the report design read from the supplied input stream and writes the generated compiled report design object to the output stream specified by the second parameter.
void	compileToStream(JasperDesign jasperDesign, java.io.OutputStream outputStream) Compiles the report design object represented by the first parameter and writes the generated compiled report design object to the output stream specified by the second parameter.
JREvaluator	getEvaluator(JasperReport jasperReport)
JREvaluator	getEvaluator(JasperReport jasperReport, JRCrosstab crosstab)
JREvaluator	getEvaluator(JasperReport jasperReport, JRDataset dataset)
static JasperCompileManager	getInstance(JasperReportsContext jasperReportsContext)
static JREvaluator	loadEvaluator(JasperReport jasperReport)
static JREvaluator	loadEvaluator(JasperReport jasperReport, JRCrosstab crosstab)
static JREvaluator	loadEvaluator(JasperReport jasperReport, JRDataset dataset)
java.util.Collection<JRValidationFault>	verify(JasperDesign jasperDesign) Verifies the validity and consistency of the report design object.
static java.util.Collection<JRValidationFault>	verifyDesign(JasperDesign jasperDesign)
static java.lang.String	writeReportToXml(JRReport report)
static void	writeReportToXmlFile(JRReport report, java.lang.String destFileName)
static java.lang.String	writeReportToXmlFile(java.lang.String sourceFileName)
static void	writeReportToXmlFile(java.lang.String sourceFileName, java.lang.String destFileName)
static void	writeReportToXmlStream(java.io.InputStream inputStream, java.io.OutputStream outputStream)
static void	writeReportToXmlStream(JRReport report, java.io.OutputStream outputStream)
java.lang.String	writeToXml(JRReport report) Generates the XML representation of the report design object supplied as parameter using the "UTF-8" enconding.
void	writeToXmlFile(JRReport report, java.lang.String destFileName) Generates the XML representation of the report design supplied as the first parameter and place it in the file specified by the second parameter.
java.lang.String	writeToXmlFile(java.lang.String sourceFileName) Generates the XML representation of the report design loaded from the specified filename.
void	writeToXmlFile(java.lang.String sourceFileName, java.lang.String destFileName) Generates the XML representation of the report design loaded from the first file parameter and place it in the file specified by the second parameter.
void	writeToXmlStream(java.io.InputStream inputStream, java.io.OutputStream outputStream) Generates the XML representation of the serialized report design object read from the supplied input stream abd writes it to the specified output stream, using the "UTF-8" encoding.
void	writeToXmlStream(JRReport report, java.io.OutputStream outputStream) Generates the XML representation of the report design object supplied as parameter and writes it to the specified output stream, using the "UTF-8" encoding.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static JasperCompileManager getInstance(JasperReportsContext jasperReportsContext)

compileToFile

public java.lang.String compileToFile(java.lang.String sourceFileName)
                               throws JRException

Compiles the XML report design file specified by the parameter. The result of this operation is another file that will contain the serialized JasperReport object representing the compiled report design, having the same name as the report design as declared in the XML plus the *.jasper extension, located in the same directory as the XML source file.

Parameters:

sourceFileName - XML source file name

Returns:

resulting file name containing a serialized JasperReport object

Throws:

JRException

compileToFile

public void compileToFile(java.lang.String sourceFileName,
                          java.lang.String destFileName)
                   throws JRException

Compiles the XML report design file received as the first parameter, placing the result in the file specified by the second parameter. The resulting file will contain a serialized instance of a JasperReport object representing the compiled report design.

Parameters:

sourceFileName - XML source file name

destFileName - file name to place the result into

Throws:

JRException

compileToFile

public void compileToFile(JasperDesign jasperDesign,
                          java.lang.String destFileName)
                   throws JRException

Compiles the report design object received as the first parameter, placing the result in the file specified by the second parameter. The resulting file will contain a serialized instance of a JasperReport object representing the compiled report design.

Parameters:

jasperDesign - source report design object

destFileName - file name to place the compiled report design into

Throws:

JRException

compile

public JasperReport compile(java.lang.String sourceFileName)
                     throws JRException

Compiles the XML report design file received as parameter, and returns the compiled report design object.

Parameters:

sourceFileName - XML source file name

Returns:

compiled report design object

Throws:

JRException

compileToStream

public void compileToStream(java.io.InputStream inputStream,
                            java.io.OutputStream outputStream)
                     throws JRException

Compiles the XML representation of the report design read from the supplied input stream and writes the generated compiled report design object to the output stream specified by the second parameter.

Parameters:

inputStream - XML source input stream

outputStream - output stream to write the compiled report design to

Throws:

JRException

compileToStream

public void compileToStream(JasperDesign jasperDesign,
                            java.io.OutputStream outputStream)
                     throws JRException

Compiles the report design object represented by the first parameter and writes the generated compiled report design object to the output stream specified by the second parameter.

Parameters:

jasperDesign - source report design object

outputStream - output stream to write the compiled report design to

Throws:

JRException

compile

public JasperReport compile(java.io.InputStream inputStream)
                     throws JRException

Compiles the serialized report design object read from the supplied input stream and returns the generated compiled report design object.

Parameters:

inputStream - XML source input stream

Returns:

compiled report design object

Throws:

JRException

compile

public JasperReport compile(JasperDesign jasperDesign)
                     throws JRException

Compiles the report design object received as parameter and returns the generated compiled report design object.

Parameters:

jasperDesign - source report design object

Returns:

compiled report design object

Throws:

JRException

See Also:

JRCompiler

verify

public java.util.Collection<JRValidationFault> verify(JasperDesign jasperDesign)

Verifies the validity and consistency of the report design object. Returns a collection of errors, if problems are found in the report design.

Parameters:

jasperDesign - report design object to verify

Returns:

collection of JRValidationFault if problems are found

See Also:

JRVerifier

getEvaluator

public JREvaluator getEvaluator(JasperReport jasperReport,
                                JRDataset dataset)
                         throws JRException

Throws:

JRException

getEvaluator

public JREvaluator getEvaluator(JasperReport jasperReport,
                                JRCrosstab crosstab)
                         throws JRException

Throws:

JRException

getEvaluator

public JREvaluator getEvaluator(JasperReport jasperReport)
                         throws JRException

Throws:

JRException

writeToXmlFile

public java.lang.String writeToXmlFile(java.lang.String sourceFileName)
                                throws JRException

Generates the XML representation of the report design loaded from the specified filename. The result of this operation is an "UTF-8" encoded XML file having the same name as the report design, plus the *.jasper.jrxml extension, located in the same directory as the source file.

Parameters:

sourceFileName - source file name containing the report design object

Returns:

XML representation of the report design

Throws:

JRException

writeToXmlFile

public void writeToXmlFile(java.lang.String sourceFileName,
                           java.lang.String destFileName)
                    throws JRException

Generates the XML representation of the report design loaded from the first file parameter and place it in the file specified by the second parameter. The result is "UTF-8" encoded.

Parameters:

sourceFileName - source file name containing the report design object

destFileName - output file name to write the XML report design representation to

Throws:

JRException

writeToXmlFile

public void writeToXmlFile(JRReport report,
                           java.lang.String destFileName)
                    throws JRException

Generates the XML representation of the report design supplied as the first parameter and place it in the file specified by the second parameter. The result is "UTF-8" encoded.

Parameters:

report - source report design object

destFileName - output file name to write the XML report design representation to

Throws:

JRException

See Also:

JRXmlWriter

writeToXmlStream

public void writeToXmlStream(java.io.InputStream inputStream,
                             java.io.OutputStream outputStream)
                      throws JRException

Generates the XML representation of the serialized report design object read from the supplied input stream abd writes it to the specified output stream, using the "UTF-8" encoding.

Parameters:

inputStream - source input stream to read the report design object from

outputStream - output stream to write the XML report design representation to

Throws:

JRException

writeToXmlStream

public void writeToXmlStream(JRReport report,
                             java.io.OutputStream outputStream)
                      throws JRException

Generates the XML representation of the report design object supplied as parameter and writes it to the specified output stream, using the "UTF-8" encoding.

Parameters:

report - source report design object

outputStream - output stream to write the XML report design representation to

Throws:

JRException

See Also:

JRXmlWriter

writeToXml

public java.lang.String writeToXml(JRReport report)

Generates the XML representation of the report design object supplied as parameter using the "UTF-8" enconding.

Parameters:

report - source report design object

Returns:

XML representation of the report design

See Also:

JRXmlWriter

compileReportToFile

public static java.lang.String compileReportToFile(java.lang.String sourceFileName)
                                            throws JRException

Throws:

JRException

See Also:

compileToFile(String)

compileReportToFile

public static void compileReportToFile(java.lang.String sourceFileName,
                                       java.lang.String destFileName)
                                throws JRException

Throws:

JRException

See Also:

compileToFile(String, String)

compileReportToFile

public static void compileReportToFile(JasperDesign jasperDesign,
                                       java.lang.String destFileName)
                                throws JRException

Throws:

JRException

See Also:

compileToFile(JasperDesign, String)

compileReport

public static JasperReport compileReport(java.lang.String sourceFileName)
                                  throws JRException

Throws:

JRException

See Also:

compile(String)

compileReportToStream

public static void compileReportToStream(java.io.InputStream inputStream,
                                         java.io.OutputStream outputStream)
                                  throws JRException

Throws:

JRException

See Also:

compileToStream(InputStream, OutputStream)

compileReportToStream

public static void compileReportToStream(JasperDesign jasperDesign,
                                         java.io.OutputStream outputStream)
                                  throws JRException

Throws:

JRException

See Also:

compileToStream(JasperDesign, OutputStream)

compileReport

public static JasperReport compileReport(java.io.InputStream inputStream)
                                  throws JRException

Throws:

JRException

See Also:

compile(InputStream)

compileReport

public static JasperReport compileReport(JasperDesign jasperDesign)
                                  throws JRException

Throws:

JRException

See Also:

compile(JasperDesign)

verifyDesign

public static java.util.Collection<JRValidationFault> verifyDesign(JasperDesign jasperDesign)

See Also:

verify(JasperDesign)

loadEvaluator

public static JREvaluator loadEvaluator(JasperReport jasperReport,
                                        JRDataset dataset)
                                 throws JRException

Throws:

JRException

See Also:

getEvaluator(JasperReport, JRDataset)

loadEvaluator

public static JREvaluator loadEvaluator(JasperReport jasperReport,
                                        JRCrosstab crosstab)
                                 throws JRException

Throws:

JRException

See Also:

getEvaluator(JasperReport, JRCrosstab)

loadEvaluator

public static JREvaluator loadEvaluator(JasperReport jasperReport)
                                 throws JRException

Throws:

JRException

See Also:

getEvaluator(JasperReport)

writeReportToXmlFile

public static java.lang.String writeReportToXmlFile(java.lang.String sourceFileName)
                                             throws JRException

Throws:

JRException

See Also:

writeToXmlFile(String)

writeReportToXmlFile

public static void writeReportToXmlFile(java.lang.String sourceFileName,
                                        java.lang.String destFileName)
                                 throws JRException

Throws:

JRException

See Also:

writeToXmlFile(String, String)

writeReportToXmlFile

public static void writeReportToXmlFile(JRReport report,
                                        java.lang.String destFileName)
                                 throws JRException

Throws:

JRException

See Also:

writeToXmlFile(JRReport, String)

writeReportToXmlStream

public static void writeReportToXmlStream(java.io.InputStream inputStream,
                                          java.io.OutputStream outputStream)
                                   throws JRException

Throws:

JRException

See Also:

writeToXmlStream(InputStream, OutputStream)

writeReportToXmlStream

public static void writeReportToXmlStream(JRReport report,
                                          java.io.OutputStream outputStream)
                                   throws JRException

Throws:

JRException

See Also:

writeToXmlStream(JRReport, OutputStream)

writeReportToXml

public static java.lang.String writeReportToXml(JRReport report)

See Also:

writeToXml(JRReport)