net.sf.jasperreports.engine.design
Class JRVerifier

java.lang.Object
  net.sf.jasperreports.engine.design.JRVerifier

public class JRVerifier
extends java.lang.Object

A report verifier.

The verifier checks that a report design meets certain rules in order to pass report compilation.

Version:

$Id: JRVerifier.java 2329 2008-08-29 16:38:35Z lucianc $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Constructor Summary

protected	JRVerifier(JasperDesign jrDesign)
protected	JRVerifier(JasperDesign jrDesign, JRExpressionCollector expressionCollector)

Method Summary

void	addBrokenRule(java.lang.Exception e, java.lang.Object source) Logs a broken report rule which was caused by an exception.
void	addBrokenRule(java.lang.String message, java.lang.Object source) Logs a broken rule for the report.
JasperDesign	getReportDesign()
void	verify(JRCategoryDataset dataset)
protected void	verify(JRCategorySeries series)
void	verify(JRGanttDataset dataset)
protected void	verify(JRGanttSeries series)
void	verify(JRHighLowDataset dataset)
void	verify(JRPieDataset dataset)
void	verify(JRTimePeriodDataset dataset)
protected void	verify(JRTimePeriodSeries series)
protected void	verify(JRTimeSeries series)
void	verify(JRTimeSeriesDataset dataset)
void	verify(JRValueDataset dataset) Verify the design of a value dataset.
void	verify(JRXyDataset dataset)
protected void	verify(JRXySeries series)
void	verify(JRXyzDataset dataset)
protected void	verify(JRXyzSeries series)
protected void	verifyComponentElement(JRComponentElement element)
protected java.util.Collection	verifyDesign()
static java.util.Collection	verifyDesign(JasperDesign jasperDesign) Validates a report design.
static java.util.Collection	verifyDesign(JasperDesign jasperDesign, JRExpressionCollector expressionCollector) Validates a report design.
void	verifyElement(JRElement element)
void	verifyElementDataset(JRElementDataset dataset)
protected void	verifyFormatFactoryClass()
protected void	verifyGenericElement(JRGenericElement element)
protected void	verifyHyperlinkParameter(JRHyperlinkParameter parameter)
protected void	verifyPropertyExpression(JRPropertyExpression propertyExpression)
protected void	verifyProperyExpressions(JRPropertyExpression[] propertyExpressions)
protected void	verifyReportElement(JRElement element)
protected void	verifyReportTemplates()
protected void	verifyTemplate(JRReportTemplate template)
protected boolean	verifyTemplateSourceType(java.lang.Class valueClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

JRVerifier

protected JRVerifier(JasperDesign jrDesign)

JRVerifier

protected JRVerifier(JasperDesign jrDesign,
                     JRExpressionCollector expressionCollector)

Method Detail

getReportDesign

public JasperDesign getReportDesign()

addBrokenRule

public void addBrokenRule(java.lang.String message,
                          java.lang.Object source)

Logs a broken rule for the report.

Parameters:

message - the message

source - the source object to which the rule applies; can be null if not available

addBrokenRule

public void addBrokenRule(java.lang.Exception e,
                          java.lang.Object source)

Logs a broken report rule which was caused by an exception.

Parameters:

e - the exception that caused the broken rule

source - the source object if available

verifyDesign

public static java.util.Collection verifyDesign(JasperDesign jasperDesign,
                                                JRExpressionCollector expressionCollector)

Validates a report design.

Parameters:

jasperDesign - the report design

expressionCollector - a collector which was used to collect expressions from the report design; if null, a new collector will be created and used to collect the expressions

Returns:

a list of design faults; the report design is valid iff the list is empty

verifyDesign

public static java.util.Collection verifyDesign(JasperDesign jasperDesign)

Validates a report design.

Parameters:

jasperDesign - the report design

Returns:

a list of design faults; the report design is valid iff the list is empty

verifyDesign

protected java.util.Collection verifyDesign()

verifyFormatFactoryClass

protected void verifyFormatFactoryClass()

verifyReportTemplates

protected void verifyReportTemplates()

verifyTemplate

protected void verifyTemplate(JRReportTemplate template)

verifyTemplateSourceType

protected boolean verifyTemplateSourceType(java.lang.Class valueClass)

verifyElement

public void verifyElement(JRElement element)

verifyHyperlinkParameter

protected void verifyHyperlinkParameter(JRHyperlinkParameter parameter)

verifyElementDataset

public void verifyElementDataset(JRElementDataset dataset)

verify

public void verify(JRCategoryDataset dataset)

verify

protected void verify(JRCategorySeries series)

verify

public void verify(JRPieDataset dataset)

verify

public void verify(JRHighLowDataset dataset)

verify

public void verify(JRTimePeriodDataset dataset)

verify

protected void verify(JRTimePeriodSeries series)

verify

public void verify(JRTimeSeriesDataset dataset)

verify

protected void verify(JRTimeSeries series)

verify

public void verify(JRValueDataset dataset)

Verify the design of a value dataset. Since value dataset's only contain a single value and do not support hyperlinks there is nothing to verify.

verify

public void verify(JRXyDataset dataset)

verify

protected void verify(JRXySeries series)

verify

protected void verify(JRGanttSeries series)

verify

public void verify(JRXyzDataset dataset)

verify

public void verify(JRGanttDataset dataset)

verify

protected void verify(JRXyzSeries series)

verifyReportElement

protected void verifyReportElement(JRElement element)

verifyProperyExpressions

protected void verifyProperyExpressions(JRPropertyExpression[] propertyExpressions)

verifyPropertyExpression

protected void verifyPropertyExpression(JRPropertyExpression propertyExpression)

verifyComponentElement

protected void verifyComponentElement(JRComponentElement element)

verifyGenericElement

protected void verifyGenericElement(JRGenericElement element)