net.sf.jasperreports.engine.component
Interface ComponentXmlWriter

All Known Implementing Classes:

ComponentsXmlHandler, SortComponentXmlWriter, SpiderChartXmlWriter

public interface ComponentXmlWriter

A component writer is responsible for producing a XML representation of component instances.

Its function is inverse to the one of XmlDigesterConfigurer, which transforms XML fragments into object instances.

Version:

$Id: ComponentXmlWriter.java 4595 2011-09-08 15:55:10Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Method Summary

void	writeToXml(ComponentKey componentKey, Component component, JRXmlWriter reportWriter) Outputs the XML representation of a component.

Method Detail

writeToXml

void writeToXml(ComponentKey componentKey,
                Component component,
                JRXmlWriter reportWriter)
                throws java.io.IOException

Outputs the XML representation of a component.

Parameters:

componentKey - the component type key

component - the component instance

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

Throws:

java.io.IOException - exceptions produced while writing to the output stream

See Also:

ComponentKey.getNamespacePrefix(), JRXmlWriter.getXmlWriteHelper()