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

Class AbstractXMLDefinitionWriter

java.lang.Object

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

Direct Known Subclasses:

DataFactoryWriter, FunctionsWriter, ObjectWriter, ParserConfigWriter, ReportConfigWriter, ReportDefinitionWriter, ReportDescriptionWriter, StyleWriter, SubReportDefinitionWriter, TemplatesWriter

public abstract class AbstractXMLDefinitionWriter
extends Object

A base class for writer classes for the JFreeReport XML report files.

Author:

Thomas Morgner

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASIC_KEY_TAG	The 'basic-key' tag name.
static String	BASIC_OBJECT_TAG	The text for the 'basic-object' tag.
static String	CLASS_ATTRIBUTE	The class attribute name.
static String	COMPOUND_KEY_TAG	The 'compound-key' tag name.
static String	COMPOUND_OBJECT_TAG	The text for the 'compound-object' tag.
static String	CONFIGURATION_TAG	The 'configuration' tag name.
static String	DATASOURCE_TAG	The datasource tag name.
static String	EXTENDS_TAG	The 'extends' tag name.
static String	FUNCTIONS_TAG	The functions tag name.
static String	HEIGHT_ATT	Literal text for an XML attribute.
static String	NAME_ATTR	The 'name' attribute text.
static String	OUTPUT_TARGET_TAG	The 'output-config' tag name.
static String	PARSER_CONFIG_TAG	The parser config tag name.
static String	PROPERTIES_TAG	The properties tag name.
static String	PROPERTY_TAG	The 'property' tag name.
static String	REPORT_CONFIG_TAG	The report config tag name.
static String	REPORT_DEFINITION_TAG	the document element tag for the extended report format.
static String	STYLE_TAG	The 'style' tag name.
static String	STYLES_TAG	The styles tag name.
static String	TEMPLATE_TAG	The template tag.
static String	TEMPLATES_TAG	The templates tag name.
static String	WIDTH_ATT	Literal text for an XML attribute.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractXMLDefinitionWriter(ReportWriterContext reportWriter, org.pentaho.reporting.libraries.xmlns.writer.XmlWriter xmlWriter)	Creates a new writer.

Method Summary

Modifier and Type	Method	Description
protected AbstractReportDefinition	getReport()	Returns the report.
protected ReportWriterContext	getReportWriter()	Returns the report writer.
protected org.pentaho.reporting.libraries.xmlns.writer.XmlWriter	getXmlWriter()
protected static boolean	hasPublicDefaultConstructor(Class c)
abstract void	write()	Writes the report definition portion.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_DEFINITION_TAG

public static final String REPORT_DEFINITION_TAG

the document element tag for the extended report format.

See Also:

Constant Field Values

PARSER_CONFIG_TAG

public static final String PARSER_CONFIG_TAG

The parser config tag name.

See Also:

Constant Field Values

REPORT_CONFIG_TAG

public static final String REPORT_CONFIG_TAG

The report config tag name.

See Also:

Constant Field Values

STYLES_TAG

public static final String STYLES_TAG

The styles tag name.

See Also:

Constant Field Values

TEMPLATES_TAG

public static final String TEMPLATES_TAG

The templates tag name.

See Also:

Constant Field Values

FUNCTIONS_TAG

public static final String FUNCTIONS_TAG

The functions tag name.

See Also:

Constant Field Values

COMPOUND_OBJECT_TAG

public static final String COMPOUND_OBJECT_TAG

The text for the 'compound-object' tag.

See Also:

Constant Field Values

BASIC_OBJECT_TAG

public static final String BASIC_OBJECT_TAG

The text for the 'basic-object' tag.

See Also:

Constant Field Values

DATASOURCE_TAG

public static final String DATASOURCE_TAG

The datasource tag name.

See Also:

Constant Field Values

PROPERTIES_TAG

public static final String PROPERTIES_TAG

The properties tag name.

See Also:

Constant Field Values

CLASS_ATTRIBUTE

public static final String CLASS_ATTRIBUTE

The class attribute name.

See Also:

Constant Field Values

CONFIGURATION_TAG

public static final String CONFIGURATION_TAG

The 'configuration' tag name.

See Also:

Constant Field Values

OUTPUT_TARGET_TAG

public static final String OUTPUT_TARGET_TAG

The 'output-config' tag name.

See Also:

Constant Field Values

WIDTH_ATT

public static final String WIDTH_ATT

Literal text for an XML attribute.

See Also:

Constant Field Values

HEIGHT_ATT

public static final String HEIGHT_ATT

Literal text for an XML attribute.

See Also:

Constant Field Values

STYLE_TAG

public static final String STYLE_TAG

The 'style' tag name.

See Also:

Constant Field Values

COMPOUND_KEY_TAG

public static final String COMPOUND_KEY_TAG

The 'compound-key' tag name.

See Also:

Constant Field Values

BASIC_KEY_TAG

public static final String BASIC_KEY_TAG

The 'basic-key' tag name.

See Also:

Constant Field Values

EXTENDS_TAG

public static final String EXTENDS_TAG

The 'extends' tag name.

See Also:

Constant Field Values

TEMPLATE_TAG

public static final String TEMPLATE_TAG

The template tag.

See Also:

Constant Field Values

PROPERTY_TAG

public static final String PROPERTY_TAG

The 'property' tag name.

See Also:

Constant Field Values

NAME_ATTR

public static final String NAME_ATTR

The 'name' attribute text.

See Also:

Constant Field Values

Constructor Detail

AbstractXMLDefinitionWriter

protected AbstractXMLDefinitionWriter(ReportWriterContext reportWriter,
                                      org.pentaho.reporting.libraries.xmlns.writer.XmlWriter xmlWriter)

Creates a new writer.

Parameters:

reportWriter - the report writer.

xmlWriter -

Method Detail

getReportWriter

protected ReportWriterContext getReportWriter()

Returns the report writer.

Returns:

The report writer.

getXmlWriter

protected org.pentaho.reporting.libraries.xmlns.writer.XmlWriter getXmlWriter()

getReport

protected AbstractReportDefinition getReport()

Returns the report.

Returns:

The report.

write

public abstract void write()
                    throws IOException,
                           ReportWriterException

Writes the report definition portion. Every DefinitionWriter handles one or more elements of the JFreeReport object tree, DefinitionWriter traverse the object tree and write the known objects or forward objects to other definition writers.

Throws:

IOException - if there is an I/O problem.

ReportWriterException - if the report serialisation failed.

hasPublicDefaultConstructor

protected static boolean hasPublicDefaultConstructor(Class c)