net.sf.jasperreports.engine

Class JasperCompileManager


public class JasperCompileManager
extends 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. Report compilation using this class is delegated to the JRDefaultCompiler.
See Also:
JasperDesign, JasperReport, JRDefaultCompiler, JRVerifier, JRXmlLoader, JRXmlWriter, JRLoader, JRSaver

Method Summary

static JasperReport
compileReport(InputStream inputStream)
Compiles the serialized report design object read from the supplied input stream and returns the generated compiled report design object.
static JasperReport
compileReport(String sourceFileName)
Compiles the XML report design file received as parameter, and returns the compiled report design object.
static JasperReport
compileReport(JasperDesign jasperDesign)
Compiles the report design object received as parameter and returns the generated compiled report design object.
static String
compileReportToFile(String sourceFileName)
Compiles the XML report design file specified by the parameter.
static void
compileReportToFile(String sourceFileName, String destFileName)
Compiles the XML report design file received as the first parameter, placing the result in the file specified by the second parameter.
static void
compileReportToFile(JasperDesign jasperDesign, String destFileName)
Compiles the report design object received as the first parameter, placing the result in the file specified by the second parameter.
static void
compileReportToStream(InputStream inputStream, 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.
static void
compileReportToStream(JasperDesign jasperDesign, 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.
static JREvaluator
loadEvaluator(JasperReport jasperReport)
static JREvaluator
loadEvaluator(JasperReport jasperReport, JRCrosstab crosstab)
static JREvaluator
loadEvaluator(JasperReport jasperReport, JRDataset dataset)
static Collection<E>
verifyDesign(JasperDesign jasperDesign)
Verifies the validity and consistency of the report design object.
static String
writeReportToXml(JRReport report)
Generates the XML representation of the report design object supplied as parameter using the "UTF-8" enconding.
static String
writeReportToXmlFile(String sourceFileName)
Generates the XML representation of the report design loaded from the specified filename.
static void
writeReportToXmlFile(String sourceFileName, 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.
static void
writeReportToXmlFile(JRReport report, 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.
static void
writeReportToXmlStream(InputStream inputStream, 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.
static void
writeReportToXmlStream(JRReport report, 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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

compileReport

public static JasperReport compileReport(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

compileReport

public static JasperReport compileReport(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

compileReport

public static JasperReport compileReport(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

compileReportToFile

public static String compileReportToFile(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

compileReportToFile

public static void compileReportToFile(String sourceFileName,
                                       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
Usages and Demos :

View More Examples of compileReportToFile(String sourceFileName,String destFileName)
   1: import net.sf.jasperreports.engine.JRException;
   2: import net.sf.jasperreports.engine.JasperCompileManager;
   3: 
   4:         ...
   5:       try {
   6:         JasperCompileManager.compileReportToFile(args[i], jasperFileName);
   7:       }
   8:       catch (JRException e) {
   9:         handleException(e);

View Full Code Here

compileReportToFile

public static void compileReportToFile(JasperDesign jasperDesign,
                                       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
Usages and Demos :

View More Examples of compileReportToFile(JasperDesign jasperDesign,String destFileName)
   1: import net.sf.jasperreports.engine.JRException;
   2: import net.sf.jasperreports.engine.JasperCompileManager;
   3: 
   4:         ...
   5:       try {
   6:         JasperCompileManager.compileReportToFile(args[i], jasperFileName);
   7:       }
   8:       catch (JRException e) {
   9:         handleException(e);

View Full Code Here

compileReportToStream

public static void compileReportToStream(InputStream inputStream,
                                         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

compileReportToStream

public static void compileReportToStream(JasperDesign jasperDesign,
                                         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

loadEvaluator

public static JREvaluator loadEvaluator(JasperReport jasperReport)
            throws JRException

loadEvaluator

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

loadEvaluator

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

verifyDesign

public static Collection<E> verifyDesign(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

writeReportToXml

public static String writeReportToXml(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

writeReportToXmlFile

public static String writeReportToXmlFile(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

writeReportToXmlFile

public static void writeReportToXmlFile(String sourceFileName,
                                        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

writeReportToXmlFile

public static void writeReportToXmlFile(JRReport report,
                                        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
See Also:
JRXmlWriter

writeReportToXmlStream

public static void writeReportToXmlStream(InputStream inputStream,
                                          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

writeReportToXmlStream

public static void writeReportToXmlStream(JRReport report,
                                          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
See Also:
JRXmlWriter