net.sf.jasperreports.components

Class ComponentsXmlWriter

java.lang.Object

net.sf.jasperreports.components.ComponentsXmlWriter

All Implemented Interfaces:

ComponentXmlWriter

public class ComponentsXmlWriter
extends Object
implements ComponentXmlWriter

XML writer for built-in component implementations.

Version:

$Id: ComponentsXmlHandler.java 5655 2012-09-12 13:25:21Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

ComponentsExtensionsRegistryFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_COMPONENTS_PREFIX
static String	PROPERTY_COMPONENTS_VERSION_SUFFIX

Constructor Summary

Constructors

Constructor and Description
ComponentsXmlWriter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getVersion(JRComponentElement componentElement, JRXmlWriter reportWriter)
protected boolean	isBarcode4jName(String name)
protected boolean	isNewerVersionOrEqual(JRComponentElement componentElement, JRXmlWriter reportWriter, String oldVersion)
boolean	isToWrite(JRComponentElement componentElement, JRXmlWriter reportWriter) Specifies whether this component should be written out.
protected void	writeBarbecue(JRComponentElement componentElement, JRXmlWriter reportWriter)
protected void	writeExpression(String name, JRExpression expression, boolean writeClass, JRComponentElement componentElement, JRXmlWriter reportWriter)
protected void	writeExpression(String name, XmlNamespace namespace, JRExpression expression, boolean writeClass, JRComponentElement componentElement, JRXmlWriter reportWriter)
protected void	writeGroupCells(JRComponentElement componentElement, List<GroupCell> cells, String name, JRXmlWriter reportWriter)
protected void	writeList(JRComponentElement componentElement, JRXmlWriter reportWriter)
protected void	writeMap(JRComponentElement componentElement, JRXmlWriter reportWriter)
protected void	writeTable(JRComponentElement componentElement, JRXmlWriter reportWriter)
protected void	writeTableCell(JRComponentElement componentElement, Cell cell, String name, JRXmlWriter reportWriter)
void	writeToXml(JRComponentElement componentElement, JRXmlWriter reportWriter) Outputs the XML representation of a component.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_COMPONENTS_PREFIX

public static final String PROPERTY_COMPONENTS_PREFIX

See Also:

Constant Field Values

PROPERTY_COMPONENTS_VERSION_SUFFIX

public static final String PROPERTY_COMPONENTS_VERSION_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ComponentsXmlWriter

public ComponentsXmlWriter(JasperReportsContext jasperReportsContext)

Method Detail

writeToXml

public void writeToXml(JRComponentElement componentElement,
              JRXmlWriter reportWriter)
                throws IOException

Description copied from interface: ComponentXmlWriter

Outputs the XML representation of a component.

Specified by:

writeToXml in interface ComponentXmlWriter

Parameters:

componentElement - the component element

reportWriter - the report writer to which output is to be written

Throws:

IOException - exceptions produced while writing to the output stream

See Also:

ComponentKey.getNamespacePrefix(), JRXmlWriter.getXmlWriteHelper()

writeList

protected void writeList(JRComponentElement componentElement,
             JRXmlWriter reportWriter)
                  throws IOException

Throws:

IOException

writeBarbecue

protected void writeBarbecue(JRComponentElement componentElement,
                 JRXmlWriter reportWriter)
                      throws IOException

Throws:

IOException

writeMap

protected void writeMap(JRComponentElement componentElement,
            JRXmlWriter reportWriter)
                 throws IOException

Throws:

IOException

writeTable

protected void writeTable(JRComponentElement componentElement,
              JRXmlWriter reportWriter)
                   throws IOException

Throws:

IOException

writeGroupCells

protected void writeGroupCells(JRComponentElement componentElement,
                   List<GroupCell> cells,
                   String name,
                   JRXmlWriter reportWriter)
                        throws IOException

Throws:

IOException

writeTableCell

protected void writeTableCell(JRComponentElement componentElement,
                  Cell cell,
                  String name,
                  JRXmlWriter reportWriter)
                       throws IOException

Throws:

IOException

isToWrite

public boolean isToWrite(JRComponentElement componentElement,
                JRXmlWriter reportWriter)

Description copied from interface: ComponentXmlWriter

Specifies whether this component should be written out. This is useful for versioning.

Specified by:

isToWrite in interface ComponentXmlWriter

getVersion

protected String getVersion(JRComponentElement componentElement,
                JRXmlWriter reportWriter)

isNewerVersionOrEqual

protected boolean isNewerVersionOrEqual(JRComponentElement componentElement,
                            JRXmlWriter reportWriter,
                            String oldVersion)

isBarcode4jName

protected boolean isBarcode4jName(String name)

writeExpression

protected void writeExpression(String name,
                   JRExpression expression,
                   boolean writeClass,
                   JRComponentElement componentElement,
                   JRXmlWriter reportWriter)
                        throws IOException

Throws:

IOException

writeExpression

protected void writeExpression(String name,
                   XmlNamespace namespace,
                   JRExpression expression,
                   boolean writeClass,
                   JRComponentElement componentElement,
                   JRXmlWriter reportWriter)
                        throws IOException

Throws:

IOException