Package org.pentaho.reporting.engine.classic.core.modules.parser.extwriter

Class ReportDescriptionWriter

java.lang.Object

org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.AbstractXMLDefinitionWriter

org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.ReportDescriptionWriter

public class ReportDescriptionWriter
extends AbstractXMLDefinitionWriter

A report description writer. The ReportDefinitionWriter class is responsible for writing the complete XML report definition file, but it delegates one large section (the report description) to this class.

Author:

Thomas Morgner.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BAND_TAG	The 'band' tag.
static String	ELEMENT_TAG	The 'element' tag.
static String	FIELD_TAG	The 'field' tag name.
static String	FIELDS_TAG	The 'fields' tag name.
static String	GROUP_FOOTER_TAG	The 'group-footer' tag name.
static String	GROUP_HEADER_TAG	The 'group-header' tag name.
static String	GROUP_TAG	The 'group' tag name.
static String	GROUPS_TAG	The 'groups' tag name.
static String	ITEMBAND_TAG	The 'itemband' tag name.
static String	NO_DATA_BAND_TAG
static String	PAGE_FOOTER_TAG	The 'page-footer' tag name.
static String	PAGE_HEADER_TAG	The 'page-header' tag name.
static String	REPORT_DESCRIPTION_TAG	The report description tag name.
static String	REPORT_FOOTER_TAG	The 'report-footer' tag name.
static String	REPORT_HEADER_TAG	The 'report-header' tag name.
static String	WATERMARK_TAG	The 'watermark' tag name.

Fields inherited from class org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.AbstractXMLDefinitionWriter

BASIC_KEY_TAG, BASIC_OBJECT_TAG, CLASS_ATTRIBUTE, COMPOUND_KEY_TAG, COMPOUND_OBJECT_TAG, CONFIGURATION_TAG, DATASOURCE_TAG, EXTENDS_TAG, FUNCTIONS_TAG, HEIGHT_ATT, NAME_ATTR, OUTPUT_TARGET_TAG, PARSER_CONFIG_TAG, PROPERTIES_TAG, PROPERTY_TAG, REPORT_CONFIG_TAG, REPORT_DEFINITION_TAG, STYLE_TAG, STYLES_TAG, TEMPLATE_TAG, TEMPLATES_TAG, WIDTH_ATT

Constructor Summary

Constructors

Constructor	Description
ReportDescriptionWriter(ReportWriterContext reportWriter, org.pentaho.reporting.libraries.xmlns.writer.XmlWriter indent)	Creates a new report description writer.

Method Summary

Modifier and Type	Method	Description
void	write()	Writes a report description element to a character stream writer.
protected void	writeDataSourceForElement(Element element)	Writes the datasource- or template-tag for an given element.

Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.AbstractXMLDefinitionWriter

getReport, getReportWriter, getXmlWriter, hasPublicDefaultConstructor

Methods inherited from class java.lang.Object

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

Field Detail

BAND_TAG

public static final String BAND_TAG

The 'band' tag.

See Also:

Constant Field Values

ELEMENT_TAG

public static final String ELEMENT_TAG

The 'element' tag.

See Also:

Constant Field Values

FIELDS_TAG

public static final String FIELDS_TAG

The 'fields' tag name.

See Also:

Constant Field Values

FIELD_TAG

public static final String FIELD_TAG

The 'field' tag name.

See Also:

Constant Field Values

GROUP_HEADER_TAG

public static final String GROUP_HEADER_TAG

The 'group-header' tag name.

See Also:

Constant Field Values

GROUP_FOOTER_TAG

public static final String GROUP_FOOTER_TAG

The 'group-footer' tag name.

See Also:

Constant Field Values

GROUP_TAG

public static final String GROUP_TAG

The 'group' tag name.

See Also:

Constant Field Values

GROUPS_TAG

public static final String GROUPS_TAG

The 'groups' tag name.

See Also:

Constant Field Values

WATERMARK_TAG

public static final String WATERMARK_TAG

The 'watermark' tag name.

See Also:

Constant Field Values

REPORT_DESCRIPTION_TAG

public static final String REPORT_DESCRIPTION_TAG

The report description tag name.

See Also:

Constant Field Values

REPORT_HEADER_TAG

public static final String REPORT_HEADER_TAG

The 'report-header' tag name.

See Also:

Constant Field Values

REPORT_FOOTER_TAG

public static final String REPORT_FOOTER_TAG

The 'report-footer' tag name.

See Also:

Constant Field Values

PAGE_HEADER_TAG

public static final String PAGE_HEADER_TAG

The 'page-header' tag name.

See Also:

Constant Field Values

PAGE_FOOTER_TAG

public static final String PAGE_FOOTER_TAG

The 'page-footer' tag name.

See Also:

Constant Field Values

ITEMBAND_TAG

public static final String ITEMBAND_TAG

The 'itemband' tag name.

See Also:

Constant Field Values

NO_DATA_BAND_TAG

public static final String NO_DATA_BAND_TAG

See Also:

Constant Field Values

Constructor Detail

ReportDescriptionWriter

public ReportDescriptionWriter(ReportWriterContext reportWriter,
                               org.pentaho.reporting.libraries.xmlns.writer.XmlWriter indent)

Creates a new report description writer.

Parameters:

reportWriter - the report writer.

indent - the current indention level.

Method Detail

write

public void write()
           throws IOException,
                  ReportWriterException

Writes a report description element to a character stream writer.

Specified by:

write in class AbstractXMLDefinitionWriter

Throws:

IOException - if there is an I/O problem.

ReportWriterException - if there is a problem writing the report.

writeDataSourceForElement

protected void writeDataSourceForElement(Element element)
                                  throws ReportWriterException,
                                         IOException

Writes the datasource- or template-tag for an given element.

Parameters:

element - the element, which should be written.

Throws:

ReportWriterException - if there is a problem writing the report

IOException - if there is an IO error.