net.sf.jasperreports.components
Class ComponentsXmlHandler

java.lang.Object
  net.sf.jasperreports.components.ComponentsXmlHandler

All Implemented Interfaces:

ComponentXmlWriter, XmlDigesterConfigurer

public class ComponentsXmlHandler
extends Object
implements XmlDigesterConfigurer, ComponentXmlWriter

XML handler (digester + writer) for built-in component implementations.

Version:

$Id: ComponentsXmlHandler.java 5191 2012-03-30 11:36:57Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

ComponentsExtensionsRegistryFactory

Constructor Summary

ComponentsXmlHandler()
Deprecated. Replaced by ComponentsXmlHandler(JasperReportsContext).

ComponentsXmlHandler(JasperReportsContext jasperReportsContext)

Method Summary

protected void	addBarbecueRules(org.apache.commons.digester.Digester digester)
protected void	addBarcode4jRules(org.apache.commons.digester.Digester digester)
protected <T> void	addBaseBarcode4jRules(org.apache.commons.digester.Digester digester, String barcodePattern, Class<T> barcodeComponentClass)
protected <T> void	addExpressionRules(org.apache.commons.digester.Digester digester, String expressionPattern, Class<T> factoryClass, String setterMethod, boolean jrNamespace)
protected void	addListRules(org.apache.commons.digester.Digester digester)
protected void	addMapRules(org.apache.commons.digester.Digester digester)
protected void	addTableCellRules(org.apache.commons.digester.Digester digester, String pattern, String setNextMethod)
protected void	addTableGroupCellRules(org.apache.commons.digester.Digester digester, String pattern, String setNextMethod)
protected void	addTableRules(org.apache.commons.digester.Digester digester)
void	configureDigester(org.apache.commons.digester.Digester digester) Configures an XML digester by adding the rules required to parse component XML fragments.
protected void	writeBarbecue(BarbecueComponent barcode, ComponentKey componentKey, JRXmlWriter reportWriter)
protected void	writeGroupCells(List<GroupCell> cells, String name, JRXmlWriter reportWriter)
protected void	writeList(ListComponent list, ComponentKey componentKey, JRXmlWriter reportWriter)
protected void	writeMap(MapComponent map, ComponentKey componentKey, JRXmlWriter reportWriter)
protected void	writeTable(TableComponent table, ComponentKey componentKey, JRXmlWriter reportWriter)
protected void	writeTableCell(Cell cell, String name, JRXmlWriter reportWriter)
void	writeToXml(ComponentKey componentKey, Component component, 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

Constructor Detail

ComponentsXmlHandler

public ComponentsXmlHandler()

Deprecated. Replaced by ComponentsXmlHandler(JasperReportsContext).

ComponentsXmlHandler

public ComponentsXmlHandler(JasperReportsContext jasperReportsContext)

Method Detail

configureDigester

public void configureDigester(org.apache.commons.digester.Digester digester)

Description copied from interface: XmlDigesterConfigurer

Configures an XML digester by adding the rules required to parse component XML fragments.

Specified by:

configureDigester in interface XmlDigesterConfigurer

Parameters:

digester - the digester to configure

addListRules

protected void addListRules(org.apache.commons.digester.Digester digester)

addBarbecueRules

protected void addBarbecueRules(org.apache.commons.digester.Digester digester)

addBarcode4jRules

protected void addBarcode4jRules(org.apache.commons.digester.Digester digester)

addBaseBarcode4jRules

protected <T> void addBaseBarcode4jRules(org.apache.commons.digester.Digester digester,
                                         String barcodePattern,
                                         Class<T> barcodeComponentClass)

addMapRules

protected void addMapRules(org.apache.commons.digester.Digester digester)

addTableRules

protected void addTableRules(org.apache.commons.digester.Digester digester)

addTableCellRules

protected void addTableCellRules(org.apache.commons.digester.Digester digester,
                                 String pattern,
                                 String setNextMethod)

addTableGroupCellRules

protected void addTableGroupCellRules(org.apache.commons.digester.Digester digester,
                                      String pattern,
                                      String setNextMethod)

addExpressionRules

protected <T> void addExpressionRules(org.apache.commons.digester.Digester digester,
                                      String expressionPattern,
                                      Class<T> factoryClass,
                                      String setterMethod,
                                      boolean jrNamespace)

writeToXml

public void writeToXml(ComponentKey componentKey,
                       Component component,
                       JRXmlWriter reportWriter)
                throws IOException

Description copied from interface: ComponentXmlWriter

Outputs the XML representation of a component.

Specified by:

writeToXml in interface ComponentXmlWriter

Parameters:

componentKey - the component type key

component - the component instance

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(ListComponent list,
                         ComponentKey componentKey,
                         JRXmlWriter reportWriter)
                  throws IOException

Throws:

IOException

writeBarbecue

protected void writeBarbecue(BarbecueComponent barcode,
                             ComponentKey componentKey,
                             JRXmlWriter reportWriter)
                      throws IOException

Throws:

IOException

writeMap

protected void writeMap(MapComponent map,
                        ComponentKey componentKey,
                        JRXmlWriter reportWriter)
                 throws IOException

Throws:

IOException

writeTable

protected void writeTable(TableComponent table,
                          ComponentKey componentKey,
                          JRXmlWriter reportWriter)
                   throws IOException

Throws:

IOException

writeGroupCells

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

Throws:

IOException

writeTableCell

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

Throws:

IOException