Package net.sf.jasperreports.engine.xml

Class JRXmlBaseWriter

java.lang.Object

net.sf.jasperreports.engine.xml.JRXmlBaseWriter

Direct Known Subclasses:

JRXmlTemplateWriter, JRXmlWriter

public abstract class JRXmlBaseWriter
extends Object

Base XML writer.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_REPORT_VERSION	Property that specifies the JasperReports version associated with this report.
protected String	version
protected VersionComparator	versionComparator
protected JRXmlWriteHelper	writer

Constructor Summary

Constructors

Constructor	Description
JRXmlBaseWriter()

Method Summary

Modifier and Type	Method	Description
protected boolean	isNewerVersionOrEqual(String oldVersion)
protected boolean	isOlderVersionThan(String version)
protected abstract boolean	toWriteConditionalStyles()	Decides whether conditional styles are to be written.
protected void	useWriter(JRXmlWriteHelper writer, String version)	Sets the XML write helper.
void	writeBox(JRLineBox box)
void	writeBox(JRLineBox box, XmlNamespace namespace)
protected void	writeConditionalStyle(JRConditionalStyle style)	Writes a conditional style.
protected void	writeExpression(String name, JRExpression expression, boolean writeClass)
void	writeParagraph(JRParagraph paragraph)
void	writeParagraph(JRParagraph paragraph, XmlNamespace namespace)
protected void	writePen(JRPen pen)
protected void	writeStyle(JRStyle style)	Writes a style.
void	writeStyleReferenceAttr(JRStyleContainer styleContainer)
void	writeTabStop(TabStop tabStop)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_REPORT_VERSION

public static final String PROPERTY_REPORT_VERSION

Property that specifies the JasperReports version associated with this report. Report elements/attributes newer than this version are neglected by the JRXML writers when a report template is generated. If not set, all elements/attributes will be printed out.

See Also:

JRXmlWriter, Constant Field Values

writer

protected JRXmlWriteHelper writer

version

protected String version

versionComparator

protected VersionComparator versionComparator

Constructor Detail

JRXmlBaseWriter

public JRXmlBaseWriter()

Method Detail

useWriter

protected void useWriter(JRXmlWriteHelper writer,
                         String version)

Sets the XML write helper.

Parameters:

writer - the XML write helper

writeStyle

protected void writeStyle(JRStyle style)
                   throws IOException

Writes a style.

Parameters:

style - the style to write.

Throws:

IOException

writeStyleReferenceAttr

public void writeStyleReferenceAttr(JRStyleContainer styleContainer)

toWriteConditionalStyles

protected abstract boolean toWriteConditionalStyles()

Decides whether conditional styles are to be written.

Returns:

whether conditional styles are to be written

writeConditionalStyle

protected void writeConditionalStyle(JRConditionalStyle style)
                              throws IOException

Writes a conditional style.

Parameters:

style - the conditional style

Throws:

IOException

writePen

protected void writePen(JRPen pen)
                 throws IOException

Throws:

IOException

writeBox

public void writeBox(JRLineBox box)
              throws IOException

Throws:

IOException

writeBox

public void writeBox(JRLineBox box,
                     XmlNamespace namespace)
              throws IOException

Throws:

IOException

writeParagraph

public void writeParagraph(JRParagraph paragraph)
                    throws IOException

Throws:

IOException

writeParagraph

public void writeParagraph(JRParagraph paragraph,
                           XmlNamespace namespace)
                    throws IOException

Throws:

IOException

writeTabStop

public void writeTabStop(TabStop tabStop)
                  throws IOException

Throws:

IOException

isNewerVersionOrEqual

protected boolean isNewerVersionOrEqual(String oldVersion)

isOlderVersionThan

protected boolean isOlderVersionThan(String version)

writeExpression

protected void writeExpression(String name,
                               JRExpression expression,
                               boolean writeClass)
                        throws IOException

Throws:

IOException