* This class exposes all the library's report compilation functionality. It has * various methods that allow the users to compile JRXML report templates found in files * on disk or that come from input streams. It also lets people compile in-memory report * templates by directly passing a * {@link net.sf.jasperreports.engine.design.JasperDesign} object and receiving the * corresponding {@link net.sf.jasperreports.engine.JasperReport} object. *
* Other utility methods include report template verification and JRXML report template * generation for in-memory constructed * {@link net.sf.jasperreports.engine.design.JasperDesign} class instances. These * instances are especially useful in GUI tools that simplify report design work. *
* The facade class relies on the report template language to determine an appropriate report compiler.
* The report compilation facade first reads a configuration property called
* net.sf.jasperreports.compiler.<language> to determine whether a compiler
* implementation has been configured for the specific report language. If such a property
* is found, its value is used as compiler implementation class name and the facade
* instantiates a compiler object and delegates the report compilation to it. By default,
* JasperReports includes configuration properties that map the Groovy, JavaScript and
* BeanShell report compilers to the groovy, javascript and bsh
* report languages, respectively.
*
* If the report uses Java as language and no specific compiler has been set for this * language, the report compilation facade employs a built-in fall back mechanism that * picks the best Java-based report compiler available in the environment in which the * report compilation process takes place. *
* The facade first reads the
* configuration property called net.sf.jasperreports.compiler.class to allow
* users to override its built-in compiler-detection logic by providing the name of the report
* compiler implementation to use directly.
*
* If the property is not provided, the facade first tries to see if the JDT compiler from the * Eclipse Foundation is available in the application's classpath. If it is, the * {@link net.sf.jasperreports.engine.design.JRJdtCompiler} implementation is used. *
* If the JDT compiler is not available, the compilation facade then tries to locate the JDK
* 1.3-compatible Java compiler from Sun Microsystems. This is normally found in the
* tools.jar file that comes with the JDK installation.
*
* If all these fail, the last thing the fall back mechanism does is to try to launch the
* javac.exe program from the command line in order to compile the temporarily
* generated Java source file on the fly.
*
net.sf.jasperreports.compiler.<language>net.sf.jasperreports.compiler.<language> to the desired compiler
* implementation class names. In particular, the mechanism that automatically chooses a
* Java report compiler can be superseded by explicitly setting the
* net.sf.jasperreports.compiler.java property to the name of one of the built-in
* Java compiler classes or of a custom compiler implementation class.
* net.sf.jasperreports.compiler.xml.validationnet.sf.jasperreports.compiler.classpathnet.sf.jasperreports.compiler.temp.dirnet.sf.jasperreports.compiler.keep.java.file*.java file or
* generated script in order to fix compilation problems related to report expressions. By
* default, the engine deletes this file after report compilation, along with its corresponding
* *.class file. To keep it, however, set this configuration property to true.org.eclipse.jdt.core. prefix
* and passes them to the JDT Java compiler when compiling the generated Java class to
* evaluate report expressions.
* * One of the uses of this mechanism is to instruct the JDT compiler to observe Java 1.5 * code compatibility. To do so, the following properties should be set:
*org.eclipse.jdt.core.compiler.source=1.5org.eclipse.jdt.core.compiler.compliance=1.5org.eclipse.jdt.core.compiler.codegen.TargetPlatform=1.5*.jasper extension,
* located in the same directory as the XML source file.
*
* @param sourceFileName XML source file name
* @return resulting file name containing a serialized {@link net.sf.jasperreports.engine.JasperReport} object
*/
public String compileToFile(String sourceFileName) throws JRException
{
File sourceFile = new File(sourceFileName);
JasperDesign jasperDesign = JRXmlLoader.load(sourceFileName);
File destFile = new File(sourceFile.getParent(), jasperDesign.getName() + ".jasper");
String destFileName = destFile.toString();
compileToFile(jasperDesign, destFileName);
return destFileName;
}
/**
* 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
* {@link net.sf.jasperreports.engine.JasperReport} object representing
* the compiled report design.
*
* @param sourceFileName XML source file name
* @param destFileName file name to place the result into
*/
public void compileToFile(
String sourceFileName,
String destFileName
) throws JRException
{
JasperDesign jasperDesign = JRXmlLoader.load(sourceFileName);
compileToFile(jasperDesign, destFileName);
}
/**
* 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
* {@link net.sf.jasperreports.engine.JasperReport} object representing the compiled report design.
*
* @param jasperDesign source report design object
* @param destFileName file name to place the compiled report design into
*/
public void compileToFile(
JasperDesign jasperDesign,
String destFileName
) throws JRException
{
JasperReport jasperReport = compile(jasperDesign);
JRSaver.saveObject(jasperReport, destFileName);
}
/**
* Compiles the XML report design file received as parameter, and returns
* the compiled report design object.
*
* @param sourceFileName XML source file name
* @return compiled report design object
*/
public JasperReport compile(String sourceFileName) throws JRException
{
JasperDesign jasperDesign = JRXmlLoader.load(sourceFileName);
return compile(jasperDesign);
}
/**
* 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.
*
* @param inputStream XML source input stream
* @param outputStream output stream to write the compiled report design to
*/
public void compileToStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
JasperDesign jasperDesign = JRXmlLoader.load(inputStream);
compileToStream(jasperDesign, 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.
*
* @param jasperDesign source report design object
* @param outputStream output stream to write the compiled report design to
*/
public void compileToStream(
JasperDesign jasperDesign,
OutputStream outputStream
) throws JRException
{
JasperReport jasperReport = compile(jasperDesign);
JRSaver.saveObject(jasperReport, outputStream);
}
/**
* Compiles the serialized report design object read from the supplied input stream and
* returns the generated compiled report design object.
*
* @param inputStream XML source input stream
* @return compiled report design object
*/
public JasperReport compile(InputStream inputStream) throws JRException
{
JasperDesign jasperDesign = JRXmlLoader.load(inputStream);
return compile(jasperDesign);
}
/**
* Compiles the report design object received as parameter and
* returns the generated compiled report design object.
*
* @param jasperDesign source report design object
* @return compiled report design object
* @see net.sf.jasperreports.engine.design.JRCompiler
*/
public JasperReport compile(JasperDesign jasperDesign) throws JRException
{
return getCompiler(jasperDesign).compileReport(jasperDesign);
}
/**
* Verifies the validity and consistency of the report design object.
* Returns a collection of {@link JRValidationFault errors}, if problems are found in the report design.
*
* @param jasperDesign report design object to verify
* @return collection of {@link JRValidationFault JRValidationFault} if problems are found
* @see net.sf.jasperreports.engine.design.JRVerifier
*/
public Collection*.jasper.jrxml extension, located in the same directory as
* the source file.
*
* @param sourceFileName source file name containing the report design object
* @return XML representation of the report design
*/
public String writeToXmlFile(
String sourceFileName
) throws JRException
{
File sourceFile = new File(sourceFileName);
/* We need the report name. */
JRReport report = (JRReport)JRLoader.loadObject(sourceFile);
File destFile = new File(sourceFile.getParent(), report.getName() + ".jasper.jrxml");
String destFileName = destFile.toString();
writeToXmlFile(report, destFileName);
return 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. The result is "UTF-8" encoded.
*
* @param sourceFileName source file name containing the report design object
* @param destFileName output file name to write the XML report design representation to
*/
public void writeToXmlFile(
String sourceFileName,
String destFileName
) throws JRException
{
JRReport report = (JRReport)JRLoader.loadObjectFromFile(sourceFileName);
writeToXmlFile(report, 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. The result is "UTF-8" encoded.
*
* @param report source report design object
* @param destFileName output file name to write the XML report design representation to
* @see net.sf.jasperreports.engine.xml.JRXmlWriter
*/
public void writeToXmlFile(
JRReport report,
String destFileName
) throws JRException
{
new JRXmlWriter(jasperReportsContext).write(
report,
destFileName,
"UTF-8"
);
}
/**
* 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.
*
* @param inputStream source input stream to read the report design object from
* @param outputStream output stream to write the XML report design representation to
*/
public void writeToXmlStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
JRReport report = (JRReport)JRLoader.loadObject(inputStream);
writeToXmlStream(report, 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.
*
* @param report source report design object
* @param outputStream output stream to write the XML report design representation to
* @see net.sf.jasperreports.engine.xml.JRXmlWriter
*/
public void writeToXmlStream(
JRReport report,
OutputStream outputStream
) throws JRException
{
new JRXmlWriter(jasperReportsContext).write(
report,
outputStream,
"UTF-8"
);
}
/**
* Generates the XML representation of the report design object supplied as parameter
* using the "UTF-8" enconding.
*
* @param report source report design object
* @return XML representation of the report design
* @see net.sf.jasperreports.engine.xml.JRXmlWriter
*/
public String writeToXml(JRReport report)
{
return new JRXmlWriter(jasperReportsContext).write(report, "UTF-8");
}
/**
* @see #compileToFile(String)
*/
public static String compileReportToFile(String sourceFileName) throws JRException
{
return getDefaultInstance().compileToFile(sourceFileName);
}
/**
* @see #compileToFile(String, String)
*/
public static void compileReportToFile(
String sourceFileName,
String destFileName
) throws JRException
{
getDefaultInstance().compileToFile(sourceFileName, destFileName);
}
/**
* @see #compileToFile(JasperDesign, String)
*/
public static void compileReportToFile(
JasperDesign jasperDesign,
String destFileName
) throws JRException
{
getDefaultInstance().compileToFile(jasperDesign, destFileName);
}
/**
* @see #compile(String)
*/
public static JasperReport compileReport(String sourceFileName) throws JRException
{
return getDefaultInstance().compile(sourceFileName);
}
/**
* @see #compileToStream(InputStream, OutputStream)
*/
public static void compileReportToStream(
InputStream inputStream,
OutputStream outputStream
) throws JRException
{
getDefaultInstance().compileToStream(inputStream, outputStream);
}
/**
* @see #compileToStream(JasperDesign, OutputStream)
*/
public static void compileReportToStream(
JasperDesign jasperDesign,
OutputStream outputStream
) throws JRException
{
getDefaultInstance().compileToStream(jasperDesign, outputStream);
}
/**
* @see #compile(InputStream)
*/
public static JasperReport compileReport(InputStream inputStream) throws JRException
{
return getDefaultInstance().compile(inputStream);
}
/**
* @see #compile(JasperDesign)
*/
public static JasperReport compileReport(JasperDesign jasperDesign) throws JRException
{
return getDefaultInstance().compile(jasperDesign);
}
/**
* @see #verify(JasperDesign)
*/
public static Collection