net.sf.jasperreports.engine.part

Interface PartComponentXmlWriter

All Known Implementing Classes:

AbstractPartComponentXmlWriter, PartComponentsXmlWriter

public interface PartComponentXmlWriter

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.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isToWrite(JRPart part, JRXmlWriter reportWriter) Specifies whether this component should be written out.
void	writeToXml(JRPart part, JRXmlWriter reportWriter) Outputs the XML representation of a component.

Method Detail

isToWrite

boolean isToWrite(JRPart part,
                JRXmlWriter reportWriter)

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

writeToXml

void writeToXml(JRPart part,
              JRXmlWriter reportWriter)
                throws IOException

Outputs the XML representation of a component.

Parameters:

part - the part

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()