net.sf.jasperreports.engine.fill

Class JRBaseFiller

java.lang.Object

net.sf.jasperreports.engine.fill.BaseReportFiller

net.sf.jasperreports.engine.fill.JRBaseFiller

All Implemented Interfaces:

ReportFiller, JRDefaultStyleProvider

Direct Known Subclasses:

JRHorizontalFiller, JRVerticalFiller

public abstract class JRBaseFiller
extends BaseReportFiller
implements JRDefaultStyleProvider

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	JRBaseFiller.DefaultStyleListener

Field Summary

Fields

Modifier and Type	Field and Description
protected JRFillBand	background
protected BandReportFillerParent	bandReportParent
protected List<JRBand>	bands List of JRFillBand objects containing all bands of the report.
protected int	bottomMargin
protected int	columnCount
protected RunDirectionEnum	columnDirection
protected JRFillBand	columnFooter
protected int	columnFooterOffsetY
protected JRFillBand	columnHeader
protected int	columnHeaderOffsetY
protected int	columnIndex
protected int	columnSpacing
protected int	columnWidth
protected Map<String,Format>	dateFormatCache
protected JRStyle	defaultStyle
protected JRFillSection	detailSection
static String	EXCEPTION_MESSAGE_KEY_CIRCULAR_DEPENDENCY_FOUND
static String	EXCEPTION_MESSAGE_KEY_COLUMN_HEADER_OVERFLOW_INFINITE_LOOP
static String	EXCEPTION_MESSAGE_KEY_EXTERNAL_STYLE_NAME_NOT_SET
static String	EXCEPTION_MESSAGE_KEY_INFINITE_LOOP_CREATING_NEW_PAGE
static String	EXCEPTION_MESSAGE_KEY_NO_SUCH_GROUP
static String	EXCEPTION_MESSAGE_KEY_PAGE_HEADER_OVERFLOW_INFINITE_LOOP
static String	EXCEPTION_MESSAGE_KEY_UNSUPPORTED_REPORT_SECTION_TYPE
protected JRFillGroup[]	groups
protected boolean	isCreatingNewPage
protected boolean	isFirstColumnBand
protected boolean	isFirstPageBand
protected boolean	isFloatColumnFooter
protected boolean	isLastPageFooter
protected boolean	isNewColumn
protected boolean	isNewGroup
protected boolean	isNewPage
protected boolean	isReorderBandElements
protected boolean	isSummaryNewPage
protected boolean	isSummaryWithPageHeaderAndFooter
protected boolean	isTitleNewPage
protected net.sf.jasperreports.engine.fill.SavePoint	keepTogetherSavePoint
protected int	lastPageColumnFooterOffsetY
protected JRFillBand	lastPageFooter
protected int	leftMargin
protected JRFillBand	missingFillBand
protected JRFillSection	missingFillSection
protected String	name
protected JRFillBand	noData
protected Map<String,Format>	numberFormatCache
protected int	offsetX
protected int	offsetY
protected OrientationEnum	orientation
protected JRFillBand	pageFooter
protected JRFillBand	pageHeader
protected int	pageHeight
protected int	pageWidth
protected PrintOrderEnum	printOrder
protected JRPrintPage	printPage
protected JRFillReportTemplate[]	reportTemplates
protected int	rightMargin
protected JRStyle[]	styles
protected Map<Integer,JRBaseFiller>	subfillers Collection of subfillers
protected JRFillBand	summary
protected List<JRTemplate>	templates
protected JRFillBand	title
protected int	topMargin
protected WhenNoDataTypeEnum	whenNoDataType
protected WhenResourceMissingTypeEnum	whenResourceMissingType the resource missing handling type

Fields inherited from class net.sf.jasperreports.engine.fill.BaseReportFiller

bookmarkHelper, calculator, datasetMap, delayedActions, factory, fillContext, fillerId, fillingThread, fillListener, formatFactory, ignorePagination, jasperPrint, jasperReport, jasperReportsContext, mainDataset, parent, printTransferPropertyPrefixes, propertiesUtil, scriptlet, virtualizationContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRBaseFiller(JasperReportsContext jasperReportsContext, JasperReport jasperReport, BandReportFillerParent parent)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBoundElement(JRFillElement element, JRPrintElement printElement, EvaluationTimeEnum evaluationType, JRGroup group, JRFillBand band)
protected void	addBoundElement(JRFillElement element, JRPrintElement printElement, EvaluationTimeEnum evaluationType, String groupName, JRFillBand band)
protected void	addBoundElement(JRFillElement element, JRPrintElement printElement, JREvaluationTime evaluationTime)
protected void	addDefaultStyleListener(JRBaseFiller.DefaultStyleListener listener)
protected void	addPage(JRPrintPage page)
protected void	addPageToParent(boolean ended)
void	addPrintStyle(JRStyle style)
protected net.sf.jasperreports.engine.fill.SavePoint	advanceSavePoint(net.sf.jasperreports.engine.fill.SavePoint savePoint, net.sf.jasperreports.engine.fill.SavePoint newSavePoint)
protected PrintElementOriginator	assignElementId(JRFillElement fillElement)
void	cancelFill() Cancells the fill process.
protected void	collectIncludedTemplates(JRTemplate template, List<JRStyle> externalStyles, Set<String> loadedLocations, Set<String> templateParentLocations)
protected List<JRStyle>	collectStyles()
protected void	collectStyles(JRTemplate template, List<JRStyle> externalStyles, Set<String> loadedLocations)
protected void	collectStyles(JRTemplate template, List<JRStyle> externalStyles, Set<String> loadedLocations, Set<String> templateParentLocations)
protected void	collectTemplates()
protected List<JRStyle>	collectTemplateStyles()
protected void	createReportTemplates(JRFillObjectFactory factory)
JasperPrint	fill(Map<String,Object> parameterValues)
protected void	fillBand(JRPrintBand band)
protected abstract void	fillReport()
protected JRPrintPage	getCurrentPage()
int	getCurrentPageCount() Returns the number of generated master print pages.
Format	getDateFormat(String pattern)
protected Format	getDateFormat(String pattern, TimeZone timeZone)
JRStyle	getDefaultStyle() Returns a default style.
protected JRFillField	getField(String fieldName) Returns a report field.
protected Map<String,JRFillField>	getFieldsMap() Returns the report fields indexed by name.
protected int	getFillerId()
protected JRFillGroup	getGroup(String groupName)
protected int	getMasterColumnCount()
BaseReportFiller	getMasterFiller() Returns the top-level (master) filler object.
Format	getNumberFormat(String pattern)
protected List<String>	getPrintTransferPropertyPrefixes()
protected ResourceBundle	getResourceBundle() Returns the report resource bundle.
JRStyledTextParser	getStyledTextParser()
List<JRTemplate>	getTemplates()
protected Map<String,JRFillVariable>	getVariablesMap() Returns the report variables indexed by name.
protected WhenResourceMissingTypeEnum	getWhenResourceMissingType()
protected boolean	hasBoundActions(JRPrintPage page)
protected boolean	hasMasterFormatFactory()
protected boolean	hasMasterLocale()
protected boolean	hasMasterTimeZone()
protected void	ignorePaginationSet()
protected JRFillObjectFactory	initFillFactory()
protected boolean	isBandOverFlowAllowed()
boolean	isPageFinal(int pageIdx)
boolean	isPageFinal(JRPrintPage page)
protected boolean	isReorderBandElements()
protected boolean	isSubreportRunToBottom()
protected void	jasperReportSet()
protected void	loadStyles()
protected void	lookupExternalDefaultStyle(Collection<JRStyle> styleList)
protected void	moveBoundActions(FillPageKey subreportKey, FillPageKey parentKey)
protected boolean	moveKeepTogetherSavePointContent()
protected JRPrintPage	newPage()
protected boolean	next()
protected void	registerSubfiller(JRBaseFiller subfiller)
protected void	resolveBandBoundElements(JRFillBand band, byte evaluation) Resloves elements which are to be evaluated at band level.
protected void	resolveColumnBoundElements(byte evaluation) Resolves elements which are to be evaluated at column level.
protected void	resolveGroupBoundElements(byte evaluation, boolean isFinal) Resolves elements which are to be evaluated at group level.
protected void	resolvePageBoundElements(byte evaluation) Resolves elements which are to be evaluated at page level.
protected void	resolveReportBoundElements() Resolves elements which are to be evaluated at report level.
protected void	setBandOverFlowAllowed(boolean splittableBand)
protected void	setDefaultStyle(JRStyle style)
protected void	setMasterPageVariables(int currentPageIndex, int totalPages)
protected abstract void	setPageHeight(int pageHeight)
protected void	setParameter(JRFillParameter parameter, Object value) Sets a parameter's value.
protected void	setParameter(String parameterName, Object value) Sets a parameter's value.
protected void	setReorderBandElements(boolean isReorderBandElements)
protected void	subreportPageFilled(JRPrintPage subreportPage)
protected void	unregisterSubfiller(JRBaseFiller subfiller)

Methods inherited from class net.sf.jasperreports.engine.fill.BaseReportFiller

addBoundElement, addFillListener, addLastPageBookmarks, addVariableCalculationReq, checkInterrupted, createBoundElementMaps, evaluateExpression, fill, fill, getExpressionEvaluator, getFillContext, getFormatFactory, getJasperPrint, getJasperReport, getJasperReportsContext, getLocale, getMainDataset, getOwnIgnorePagination, getParametersMap, getParameterValue, getParameterValuesMap, getPropertiesUtil, getTimeZone, getVariable, getVariableValue, initDatasets, initVirtualizationContext, isDeliberatelyInterrupted, isIgnorePagination, isInterrupted, isMasterReport, isSubreport, resolveBoundElements, resolveMasterBoundElements, setConnectionParameterValue, setDatasourceParameterValue, setFormatFactory, setIgnorePagination, setInterrupted, setJasperReportsContext, setParameters, setParametersToContext, setVirtualPageSize, updateBookmark

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_MESSAGE_KEY_INFINITE_LOOP_CREATING_NEW_PAGE

public static final String EXCEPTION_MESSAGE_KEY_INFINITE_LOOP_CREATING_NEW_PAGE

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_COLUMN_HEADER_OVERFLOW_INFINITE_LOOP

public static final String EXCEPTION_MESSAGE_KEY_COLUMN_HEADER_OVERFLOW_INFINITE_LOOP

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_CIRCULAR_DEPENDENCY_FOUND

public static final String EXCEPTION_MESSAGE_KEY_CIRCULAR_DEPENDENCY_FOUND

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_EXTERNAL_STYLE_NAME_NOT_SET

public static final String EXCEPTION_MESSAGE_KEY_EXTERNAL_STYLE_NAME_NOT_SET

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_NO_SUCH_GROUP

public static final String EXCEPTION_MESSAGE_KEY_NO_SUCH_GROUP

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_PAGE_HEADER_OVERFLOW_INFINITE_LOOP

public static final String EXCEPTION_MESSAGE_KEY_PAGE_HEADER_OVERFLOW_INFINITE_LOOP

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_UNSUPPORTED_REPORT_SECTION_TYPE

public static final String EXCEPTION_MESSAGE_KEY_UNSUPPORTED_REPORT_SECTION_TYPE

See Also:

Constant Field Values

bandReportParent

protected BandReportFillerParent bandReportParent

name

protected String name

columnCount

protected int columnCount

printOrder

protected PrintOrderEnum printOrder

columnDirection

protected RunDirectionEnum columnDirection

pageWidth

protected int pageWidth

pageHeight

protected int pageHeight

orientation

protected OrientationEnum orientation

whenNoDataType

protected WhenNoDataTypeEnum whenNoDataType

columnWidth

protected int columnWidth

columnSpacing

protected int columnSpacing

leftMargin

protected int leftMargin

rightMargin

protected int rightMargin

topMargin

protected int topMargin

bottomMargin

protected int bottomMargin

isTitleNewPage

protected boolean isTitleNewPage

isSummaryNewPage

protected boolean isSummaryNewPage

isSummaryWithPageHeaderAndFooter

protected boolean isSummaryWithPageHeaderAndFooter

isFloatColumnFooter

protected boolean isFloatColumnFooter

whenResourceMissingType

protected WhenResourceMissingTypeEnum whenResourceMissingType

the resource missing handling type

reportTemplates

protected JRFillReportTemplate[] reportTemplates

templates

protected List<JRTemplate> templates

defaultStyle

protected JRStyle defaultStyle

styles

protected JRStyle[] styles

groups

protected JRFillGroup[] groups

missingFillSection

protected JRFillSection missingFillSection

missingFillBand

protected JRFillBand missingFillBand

background

protected JRFillBand background

title

protected JRFillBand title

pageHeader

protected JRFillBand pageHeader

columnHeader

protected JRFillBand columnHeader

detailSection

protected JRFillSection detailSection

columnFooter

protected JRFillBand columnFooter

pageFooter

protected JRFillBand pageFooter

lastPageFooter

protected JRFillBand lastPageFooter

summary

protected JRFillBand summary

noData

protected JRFillBand noData

printPage

protected JRPrintPage printPage

bands

protected List<JRBand> bands

List of JRFillBand objects containing all bands of the report.

subfillers

protected Map<Integer,JRBaseFiller> subfillers

Collection of subfillers

dateFormatCache

protected Map<String,Format> dateFormatCache

numberFormatCache

protected Map<String,Format> numberFormatCache

keepTogetherSavePoint

protected net.sf.jasperreports.engine.fill.SavePoint keepTogetherSavePoint

isCreatingNewPage

protected boolean isCreatingNewPage

isNewPage

protected boolean isNewPage

isNewColumn

protected boolean isNewColumn

isNewGroup

protected boolean isNewGroup

isFirstPageBand

protected boolean isFirstPageBand

isFirstColumnBand

protected boolean isFirstColumnBand

columnIndex

protected int columnIndex

offsetX

protected int offsetX

offsetY

protected int offsetY

columnHeaderOffsetY

protected int columnHeaderOffsetY

columnFooterOffsetY

protected int columnFooterOffsetY

lastPageColumnFooterOffsetY

protected int lastPageColumnFooterOffsetY

isLastPageFooter

protected boolean isLastPageFooter

isReorderBandElements

protected boolean isReorderBandElements

Constructor Detail

JRBaseFiller

protected JRBaseFiller(JasperReportsContext jasperReportsContext,
            JasperReport jasperReport,
            BandReportFillerParent parent)
                throws JRException

Throws:

JRException

Method Detail

jasperReportSet

protected void jasperReportSet()

Specified by:

jasperReportSet in class BaseReportFiller

initFillFactory

protected JRFillObjectFactory initFillFactory()

Specified by:

initFillFactory in class BaseReportFiller

getFieldsMap

protected Map<String,JRFillField> getFieldsMap()

Returns the report fields indexed by name.

Returns:

the report fields map

getVariablesMap

protected Map<String,JRFillVariable> getVariablesMap()

Returns the report variables indexed by name.

Returns:

the report variables map

getField

protected JRFillField getField(String fieldName)

Returns a report field.

Parameters:

fieldName - the field name

Returns:

the field

getPrintTransferPropertyPrefixes

protected List<String> getPrintTransferPropertyPrefixes()

getStyledTextParser

public JRStyledTextParser getStyledTextParser()

getCurrentPageCount

public int getCurrentPageCount()

Returns the number of generated master print pages.

Returns:

the number of generated master print pages

getDefaultStyle

public JRStyle getDefaultStyle()

Description copied from interface: JRDefaultStyleProvider

Returns a default style.

Specified by:

getDefaultStyle in interface JRDefaultStyleProvider

isSubreportRunToBottom

protected boolean isSubreportRunToBottom()

getCurrentPage

protected JRPrintPage getCurrentPage()

setPageHeight

protected abstract void setPageHeight(int pageHeight)

fill

public JasperPrint fill(Map<String,Object> parameterValues)
                 throws JRException

Specified by:

fill in interface ReportFiller

Throws:

JRException

addPrintStyle

public void addPrintStyle(JRStyle style)
                   throws JRException

Throws:

JRException

addDefaultStyleListener

protected void addDefaultStyleListener(JRBaseFiller.DefaultStyleListener listener)

setDefaultStyle

protected void setDefaultStyle(JRStyle style)

loadStyles

protected void loadStyles()
                   throws JRException

Throws:

JRException

collectStyles

protected List<JRStyle> collectStyles()
                               throws JRException

Throws:

JRException

collectTemplates

protected void collectTemplates()
                         throws JRException

Throws:

JRException

getTemplates

public List<JRTemplate> getTemplates()

collectTemplateStyles

protected List<JRStyle> collectTemplateStyles()
                                       throws JRException

Throws:

JRException

collectStyles

protected void collectStyles(JRTemplate template,
                 List<JRStyle> externalStyles,
                 Set<String> loadedLocations)
                      throws JRException

Throws:

JRException

collectStyles

protected void collectStyles(JRTemplate template,
                 List<JRStyle> externalStyles,
                 Set<String> loadedLocations,
                 Set<String> templateParentLocations)
                      throws JRException

Throws:

JRException

collectIncludedTemplates

protected void collectIncludedTemplates(JRTemplate template,
                            List<JRStyle> externalStyles,
                            Set<String> loadedLocations,
                            Set<String> templateParentLocations)
                                 throws JRException

Throws:

JRException

lookupExternalDefaultStyle

protected void lookupExternalDefaultStyle(Collection<JRStyle> styleList)

fillReport

protected abstract void fillReport()
                            throws JRException

Throws:

JRException

ignorePaginationSet

protected void ignorePaginationSet()

Specified by:

ignorePaginationSet in class BaseReportFiller

getResourceBundle

protected ResourceBundle getResourceBundle()

Returns the report resource bundle.

Returns:

the report resource bundle

getDateFormat

public Format getDateFormat(String pattern)

getDateFormat

protected Format getDateFormat(String pattern,
                   TimeZone timeZone)

getNumberFormat

public Format getNumberFormat(String pattern)

hasMasterFormatFactory

protected boolean hasMasterFormatFactory()

hasMasterLocale

protected boolean hasMasterLocale()

hasMasterTimeZone

protected boolean hasMasterTimeZone()

setParameter

protected void setParameter(String parameterName,
                Object value)
                     throws JRException

Sets a parameter's value.

Parameters:

parameterName - the parameter name

value - the value

Throws:

JRException

setParameter

protected void setParameter(JRFillParameter parameter,
                Object value)
                     throws JRException

Sets a parameter's value.

Parameters:

parameter - the parameter

value - the value

Throws:

JRException

next

protected boolean next()
                throws JRException

Throws:

JRException

resolveReportBoundElements

protected void resolveReportBoundElements()
                                   throws JRException

Resolves elements which are to be evaluated at report level.

Throws:

JRException

resolvePageBoundElements

protected void resolvePageBoundElements(byte evaluation)
                                 throws JRException

Resolves elements which are to be evaluated at page level.

Parameters:

evaluation - the evaluation type

Throws:

JRException

resolveColumnBoundElements

protected void resolveColumnBoundElements(byte evaluation)
                                   throws JRException

Resolves elements which are to be evaluated at column level.

Parameters:

evaluation - the evaluation type

Throws:

JRException

resolveGroupBoundElements

protected void resolveGroupBoundElements(byte evaluation,
                             boolean isFinal)
                                  throws JRException

Resolves elements which are to be evaluated at group level.

Parameters:

evaluation - the evaluation type

isFinal -

Throws:

JRException

newPage

protected JRPrintPage newPage()

resolveBandBoundElements

protected void resolveBandBoundElements(JRFillBand band,
                            byte evaluation)
                                 throws JRException

Resloves elements which are to be evaluated at band level.

Parameters:

band - the band

evaluation - the evaluation type

Throws:

JRException

cancelFill

public void cancelFill()
                throws JRException

Cancells the fill process.

Specified by:

cancelFill in interface ReportFiller

Overrides:

cancelFill in class BaseReportFiller

Throws:

JRException

registerSubfiller

protected void registerSubfiller(JRBaseFiller subfiller)

unregisterSubfiller

protected void unregisterSubfiller(JRBaseFiller subfiller)

fillBand

protected void fillBand(JRPrintBand band)

addPage

protected void addPage(JRPrintPage page)

addPageToParent

protected void addPageToParent(boolean ended)
                        throws JRException

Throws:

JRException

setMasterPageVariables

protected void setMasterPageVariables(int currentPageIndex,
                          int totalPages)

getWhenResourceMissingType

protected WhenResourceMissingTypeEnum getWhenResourceMissingType()

isBandOverFlowAllowed

protected boolean isBandOverFlowAllowed()

setBandOverFlowAllowed

protected void setBandOverFlowAllowed(boolean splittableBand)

isReorderBandElements

protected boolean isReorderBandElements()

setReorderBandElements

protected void setReorderBandElements(boolean isReorderBandElements)

getMasterColumnCount

protected int getMasterColumnCount()

getMasterFiller

public BaseReportFiller getMasterFiller()

Returns the top-level (master) filler object.

Returns:

the master filler object

addBoundElement

protected void addBoundElement(JRFillElement element,
                   JRPrintElement printElement,
                   EvaluationTimeEnum evaluationType,
                   String groupName,
                   JRFillBand band)

addBoundElement

protected void addBoundElement(JRFillElement element,
                   JRPrintElement printElement,
                   EvaluationTimeEnum evaluationType,
                   JRGroup group,
                   JRFillBand band)

addBoundElement

protected void addBoundElement(JRFillElement element,
                   JRPrintElement printElement,
                   JREvaluationTime evaluationTime)

subreportPageFilled

protected void subreportPageFilled(JRPrintPage subreportPage)

moveBoundActions

protected void moveBoundActions(FillPageKey subreportKey,
                    FillPageKey parentKey)

isPageFinal

public boolean isPageFinal(int pageIdx)

Specified by:

isPageFinal in interface ReportFiller

isPageFinal

public boolean isPageFinal(JRPrintPage page)

hasBoundActions

protected boolean hasBoundActions(JRPrintPage page)

getGroup

protected JRFillGroup getGroup(String groupName)

createReportTemplates

protected void createReportTemplates(JRFillObjectFactory factory)

advanceSavePoint

protected net.sf.jasperreports.engine.fill.SavePoint advanceSavePoint(net.sf.jasperreports.engine.fill.SavePoint savePoint,
                                                          net.sf.jasperreports.engine.fill.SavePoint newSavePoint)

moveKeepTogetherSavePointContent

protected boolean moveKeepTogetherSavePointContent()

getFillerId

protected int getFillerId()

assignElementId

protected PrintElementOriginator assignElementId(JRFillElement fillElement)