JRReport (JasperReports 4.8.0 API)

All Superinterfaces:

JRDefaultStyleProvider, JRIdentifiable, JRPropertiesHolder

All Known Implementing Classes:

JasperDesign, JasperReport, JRBaseReport, TableJasperReport, TableReport
```
public interface JRReport
extends JRDefaultStyleProvider, JRPropertiesHolder, JRIdentifiable
```
An abstract representation of a Jasper report. This interface is inherited by all report implementations (designs, compiled reports, filled reports). It only contains constants and getters and setters for the most common report properties and elements.

Version:

$Id: JRReport.java 5306 2012-04-26 15:22:28Z lucianc $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LANGUAGE_GROOVY` A constant used to specify that the language used by expressions is Groovy.
`static String`	`LANGUAGE_JAVA` A constant used to specify that the language used by expressions is Java.

Method Summary

Methods
Modifier and Type	Method and Description
`JRBand`	`getBackground()`
`int`	`getBottomMargin()`
`int`	`getColumnCount()` Gets the number of columns on each page
`RunDirectionEnum`	`getColumnDirection()` Specifies whether columns will be filled from left to right or from right to left.
`JRBand`	`getColumnFooter()`
`JRBand`	`getColumnHeader()`
`int`	`getColumnSpacing()` Specifies the space between columns on the same page.
`int`	`getColumnWidth()`
`JRDataset[]`	`getDatasets()` Returns the datasets of this report.
`JRSection`	`getDetailSection()`
`JRField[]`	`getFields()`
`String`	`getFormatFactoryClass()` Gets the name of the class implementing the `FormatFactory` interface to use with this report.
`JRGroup[]`	`getGroups()`
`String[]`	`getImports()` Gets an array of imports (needed if report expression require additional classes in order to compile).
`String`	`getLanguage()` Gets the report language.
`JRBand`	`getLastPageFooter()`
`int`	`getLeftMargin()`
`JRDataset`	`getMainDataset()` Returns the main report dataset.
`String`	`getName()` Gets the report name.
`JRBand`	`getNoData()`
`OrientationEnum`	`getOrientationValue()` Specifies whether document pages will be rendered in a portrait or landscape layout.
`JRBand`	`getPageFooter()`
`JRBand`	`getPageHeader()`
`int`	`getPageHeight()`
`int`	`getPageWidth()`
`JRParameter[]`	`getParameters()`
`PrintOrderEnum`	`getPrintOrderValue()` Specifies whether columns will be filled horizontally or vertically.
`String`	`getProperty(String name)` Gets a property value
`String[]`	`getPropertyNames()` Gets an array of report properties names.
`JRQuery`	`getQuery()`
`String`	`getResourceBundle()` Gets the base name of the report associated resource bundle.
`int`	`getRightMargin()`
`String`	`getScriptletClass()`
`JRScriptlet[]`	`getScriptlets()`
`JRSortField[]`	`getSortFields()`
`JRStyle[]`	`getStyles()` Gets an array of report styles.
`JRBand`	`getSummary()`
`JRReportTemplate[]`	`getTemplates()` Returns the list of report templates.
`JRBand`	`getTitle()`
`int`	`getTopMargin()`
`JRVariable[]`	`getVariables()`
`WhenNoDataTypeEnum`	`getWhenNoDataTypeValue()` Specifies the report behavior in case of empty datasources.
`WhenResourceMissingTypeEnum`	`getWhenResourceMissingTypeValue()` Returns the resource missing handling type.
`boolean`	`isFloatColumnFooter()` Specifies if the column footer section will be printed at the bottom of the column or if it will immediately follow the last detail or group footer printed on the current column.
`boolean`	`isIgnorePagination()` Decides whether to use pagination when filling the report.
`boolean`	`isSummaryNewPage()` Specifies if the summary section will be printed on a separate last page.
`boolean`	`isSummaryWithPageHeaderAndFooter()` Specifies if the summary section will be accompanied by the page header and footer.
`boolean`	`isTitleNewPage()` Specifies if the title section will be printed on a separate initial page.
`void`	`removeProperty(String name)`
`void`	`setProperty(String name, String value)`
`void`	`setWhenNoDataType(WhenNoDataTypeEnum whenNoDataType)` Sets the report behavior in case of empty datasources.
`void`	`setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)` Sets the resource missing handling type.

Methods inherited from interface net.sf.jasperreports.engine.JRDefaultStyleProvider
getDefaultStyle

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties

Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUID

- Field Detail
  - LANGUAGE_JAVA
```
static final String LANGUAGE_JAVA
```
    A constant used to specify that the language used by expressions is Java.
    
    See Also:
    Constant Field Values
  - LANGUAGE_GROOVY
```
static final String LANGUAGE_GROOVY
```
    A constant used to specify that the language used by expressions is Groovy.
    
    See Also:
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Gets the report name.
  - getLanguage
```
String getLanguage()
```
    Gets the report language. Should be Java or Groovy.
  - getColumnCount
```
int getColumnCount()
```
    Gets the number of columns on each page
  - getPrintOrderValue
```
PrintOrderEnum getPrintOrderValue()
```
    Specifies whether columns will be filled horizontally or vertically.
    
    Returns:
    a value representing one of the print order constants in PrintOrderEnum
  - getColumnDirection
```
RunDirectionEnum getColumnDirection()
```
    Specifies whether columns will be filled from left to right or from right to left.
    
    Returns:
    a value representing one of the column direction constants in RunDirectionEnum
  - getPageWidth
```
int getPageWidth()
```
  - getPageHeight
```
int getPageHeight()
```
  - getOrientationValue
```
OrientationEnum getOrientationValue()
```
    Specifies whether document pages will be rendered in a portrait or landscape layout.
    
    Returns:
    a value representing one of the orientation constants in OrientationEnum
  - getWhenNoDataTypeValue
```
WhenNoDataTypeEnum getWhenNoDataTypeValue()
```
    Specifies the report behavior in case of empty datasources.
  - setWhenNoDataType
```
void setWhenNoDataType(WhenNoDataTypeEnum whenNoDataType)
```
    Sets the report behavior in case of empty datasources.
  - getColumnWidth
```
int getColumnWidth()
```
  - getColumnSpacing
```
int getColumnSpacing()
```
    Specifies the space between columns on the same page.
  - getLeftMargin
```
int getLeftMargin()
```
  - getRightMargin
```
int getRightMargin()
```
  - getTopMargin
```
int getTopMargin()
```
  - getBottomMargin
```
int getBottomMargin()
```
  - isTitleNewPage
```
boolean isTitleNewPage()
```
    Specifies if the title section will be printed on a separate initial page.
  - isSummaryNewPage
```
boolean isSummaryNewPage()
```
    Specifies if the summary section will be printed on a separate last page.
  - isSummaryWithPageHeaderAndFooter
```
boolean isSummaryWithPageHeaderAndFooter()
```
    Specifies if the summary section will be accompanied by the page header and footer.
  - isFloatColumnFooter
```
boolean isFloatColumnFooter()
```
    Specifies if the column footer section will be printed at the bottom of the column or if it will immediately follow the last detail or group footer printed on the current column.
  - getScriptletClass
```
String getScriptletClass()
```
  - getFormatFactoryClass
```
String getFormatFactoryClass()
```
    Gets the name of the class implementing the FormatFactory interface to use with this report.
  - getResourceBundle
```
String getResourceBundle()
```
    Gets the base name of the report associated resource bundle.
  - getPropertyNames
```
String[] getPropertyNames()
```
    Gets an array of report properties names.
  - getProperty
```
String getProperty(String name)
```
    Gets a property value
    
    Parameters:
    name - the property name
  - setProperty
```
void setProperty(String name,
               String value)
```
  - removeProperty
```
void removeProperty(String name)
```
  - getImports
```
String[] getImports()
```
    Gets an array of imports (needed if report expression require additional classes in order to compile).
  - getStyles
```
JRStyle[] getStyles()
```
    Gets an array of report styles.
  - getScriptlets
```
JRScriptlet[] getScriptlets()
```
  - getParameters
```
JRParameter[] getParameters()
```
  - getQuery
```
JRQuery getQuery()
```
  - getFields
```
JRField[] getFields()
```
  - getSortFields
```
JRSortField[] getSortFields()
```
  - getVariables
```
JRVariable[] getVariables()
```
  - getGroups
```
JRGroup[] getGroups()
```
  - getBackground
```
JRBand getBackground()
```
  - getTitle
```
JRBand getTitle()
```
  - getPageHeader
```
JRBand getPageHeader()
```
  - getColumnHeader
```
JRBand getColumnHeader()
```
  - getDetailSection
```
JRSection getDetailSection()
```
  - getColumnFooter
```
JRBand getColumnFooter()
```
  - getPageFooter
```
JRBand getPageFooter()
```
  - getLastPageFooter
```
JRBand getLastPageFooter()
```
  - getSummary
```
JRBand getSummary()
```
  - getNoData
```
JRBand getNoData()
```
  - getWhenResourceMissingTypeValue
```
WhenResourceMissingTypeEnum getWhenResourceMissingTypeValue()
```
    Returns the resource missing handling type.
  - setWhenResourceMissingType
```
void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
```
    Sets the resource missing handling type.
    
    Parameters:
    whenResourceMissingType - the resource missing handling type
  - getMainDataset
```
JRDataset getMainDataset()
```
    Returns the main report dataset.
    The main report dataset consists of all parameters, fields, variables and groups of the report.
    
    Returns:
    the main report dataset
  - getDatasets
```
JRDataset[] getDatasets()
```
    Returns the datasets of this report.
    
    Returns:
    the datasets of this report
  - isIgnorePagination
```
boolean isIgnorePagination()
```
    Decides whether to use pagination when filling the report.
    If set to true the report will be generated on one long page.
    The design attribute can be overridden at fill time by the IS_IGNORE_PAGINATION parameter.
    
    Returns:
    whether to use pagination when filling the report
  - getTemplates
```
JRReportTemplate[] getTemplates()
```
    Returns the list of report templates.
    A report template is an expression which resolves at runtime to a template. Templates include styles which can be used in the report.
    The order in which the templates are included in the report is important:
    - A style's parent must appear before the style itself.
    - A style overrides styles with the same name that are placed before it. Also, report styles override templates styles with the same name.
    Returns:
    the list of report templates, or null if none
    See Also:
    JRTemplate, JRParameter.REPORT_TEMPLATES

Interface JRReport

Field Summary

Method Summary

Methods inherited from interface net.sf.jasperreports.engine.JRDefaultStyleProvider

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder

Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable

Field Detail

LANGUAGE_JAVA

LANGUAGE_GROOVY

Method Detail

getName

getLanguage

getColumnCount

getPrintOrderValue

getColumnDirection

getPageWidth

getPageHeight

getOrientationValue

getWhenNoDataTypeValue

setWhenNoDataType

getColumnWidth

getColumnSpacing

getLeftMargin

getRightMargin

getTopMargin

getBottomMargin

isTitleNewPage

isSummaryNewPage

isSummaryWithPageHeaderAndFooter

isFloatColumnFooter

getScriptletClass

getFormatFactoryClass

getResourceBundle

getPropertyNames

getProperty

setProperty

removeProperty

getImports

getStyles

getScriptlets

getParameters

getQuery

getFields

getSortFields

getVariables

getGroups

getBackground

getTitle

getPageHeader

getColumnHeader

getDetailSection

getColumnFooter

getPageFooter

getLastPageFooter

getSummary

getNoData

getWhenResourceMissingTypeValue

setWhenResourceMissingType

getMainDataset

getDatasets

isIgnorePagination

getTemplates