net.sf.jasperreports.engine.component

## Interface ComponentXmlWriter

- All Known Implementing Classes:
    AbstractComponentXmlWriter, ComponentsXmlWriter, IconLabelComponentXmlWriter, 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 5878 2013-01-07 20:23:13Z teodord $
  Author:
    Lucian Chirita (lucianc@users.sourceforge.net)

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `isToWrite(JRComponentElement componentElement, JRXmlWriter reportWriter)` Specifies whether this component should be written out.
    `void` | `writeToXml(JRComponentElement componentElement, JRXmlWriter reportWriter)` Outputs the XML representation of a component.

- - ### Method Detail

    - #### isToWrite

          boolean isToWrite(JRComponentElement componentElement,
                          JRXmlWriter reportWriter)

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

    - #### writeToXml

          void writeToXml(JRComponentElement componentElement,
                        JRXmlWriter reportWriter)
                          throws java.io.IOException

      Outputs the XML representation of a component.
      Parameters:
        `componentElement` - the component element
        `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()`

© 2001-2010 Jaspersoft Corporation www.jaspersoft.com