net.sf.jasperreports.engine
Class JasperReport

java.lang.Object
  extended bynet.sf.jasperreports.engine.base.JRBaseReport
      extended bynet.sf.jasperreports.engine.JasperReport
All Implemented Interfaces:
JRDefaultFontProvider, JRDefaultStyleProvider, JRReport, java.io.Serializable

public class JasperReport
extends JRBaseReport

The actual representation of a compiled report. The main difference between a report and a report design is that reports are already compiled and validated, so many characteristics are read only.

Version:
$Id: JasperReport.java,v 1.28 2005/11/28 09:20:44 teodord Exp $
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseReport
background, bottomMargin, columnCount, columnFooter, columnHeader, columnSpacing, columnWidth, datasets, defaultFont, defaultStyle, detail, fonts, ignorePagination, importsSet, isFloatColumnFooter, isSummaryNewPage, isTitleNewPage, language, lastPageFooter, leftMargin, mainDataset, name, orientation, pageFooter, pageHeader, pageHeight, pageWidth, printOrder, propertiesMap, rightMargin, styles, summary, title, topMargin, whenNoDataType
 
Fields inherited from interface net.sf.jasperreports.engine.JRReport
LANGUAGE_JAVA, ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, PRINT_ORDER_HORIZONTAL, PRINT_ORDER_VERTICAL, WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL, WHEN_NO_DATA_TYPE_BLANK_PAGE, WHEN_NO_DATA_TYPE_NO_PAGES, WHEN_RESOURCE_MISSING_TYPE_EMPTY, WHEN_RESOURCE_MISSING_TYPE_ERROR, WHEN_RESOURCE_MISSING_TYPE_KEY, WHEN_RESOURCE_MISSING_TYPE_NULL
 
Constructor Summary
JasperReport(JRReport report, java.lang.String compilerClass, java.io.Serializable compileData, JRExpressionCollector expressionCollector, java.lang.String compileNameSuffix)
          Constructs a report by specifying the template report and compile information.
 
Method Summary
 java.io.Serializable getCompileData()
          Returns data resulted from the expression evaluators compilation.
 java.lang.String getCompileNameSuffix()
          Returns the suffix of the class/unit names generated at report compilation.
 java.lang.String getCompilerClass()
          Returns the name of the compiler class used to compile this report.
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseReport
getBackground, getBottomMargin, getColumnCount, getColumnFooter, getColumnHeader, getColumnSpacing, getColumnWidth, getDatasets, getDefaultFont, getDefaultStyle, getDetail, getFields, getFonts, getGroups, getImports, getLanguage, getLastPageFooter, getLeftMargin, getMainDataset, getName, getOrientation, getPageFooter, getPageHeader, getPageHeight, getPageWidth, getParameters, getPrintOrder, getProperty, getPropertyNames, getQuery, getResourceBundle, getRightMargin, getScriptletClass, getStyles, getSummary, getTitle, getTopMargin, getVariables, getWhenNoDataType, getWhenResourceMissingType, isFloatColumnFooter, isIgnorePagination, isSummaryNewPage, isTitleNewPage, removeProperty, setProperty, setWhenNoDataType, setWhenResourceMissingType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JasperReport

public JasperReport(JRReport report,
                    java.lang.String compilerClass,
                    java.io.Serializable compileData,
                    JRExpressionCollector expressionCollector,
                    java.lang.String compileNameSuffix)
Constructs a report by specifying the template report and compile information.

Parameters:
report - the report template
compilerClass - the name of the class used to compile the report
compileData - the report/main dataset compile data
expressionCollector - instance used to collect expressions from the report design
compileNameSuffix - unique string used to distinguish between distinct compilations of reports having the same name

The collector is used to fetch the generated expression IDs.

Method Detail

getCompilerClass

public java.lang.String getCompilerClass()
Returns the name of the compiler class used to compile this report.

The compiler is used to instantiate expression evaluators.

Returns:
the name of the compiler class used to compile this report

getCompileData

public java.io.Serializable getCompileData()
Returns data resulted from the expression evaluators compilation.

This data is used to create expression evaluators for report filling.

Returns:
expression evaluators compiled data

getCompileNameSuffix

public java.lang.String getCompileNameSuffix()
Returns the suffix of the class/unit names generated at report compilation.

This is used to distinguish between disctinct compilations of reports having the same name.

Returns:
the suffix of the class/unit names generated at report compilation


© 2001-2005 JasperSoft Corporation www.jaspersoft.com