Package net.sf.jasperreports.engine.xml

Class JRXmlTemplateWriter

java.lang.Object

net.sf.jasperreports.engine.xml.JRXmlBaseWriter

net.sf.jasperreports.engine.xml.JRXmlTemplateWriter

public class JRXmlTemplateWriter
extends JRXmlBaseWriter

Template XML serializer.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

JRXmlTemplateLoader

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ENCODING	Default XML output encoding.
static XmlNamespace	JASPERTEMPLATE_NAMESPACE

Fields inherited from class net.sf.jasperreports.engine.xml.JRXmlBaseWriter

PROPERTY_REPORT_VERSION, version, versionComparator, writer

Constructor Summary

Constructors

Constructor	Description
JRXmlTemplateWriter(JasperReportsContext jasperReportsContext, JRTemplate template, Writer out, String encoding)	Creates an XML template writer.
JRXmlTemplateWriter(JRTemplate template, Writer out, String encoding)	Creates an XML template writer.

Method Summary

Modifier and Type	Method	Description
protected boolean	toWriteConditionalStyles()	Decides whether conditional styles are to be written.
void	write()	Writes the template to the output writer.
protected void	writeIncludedTemplate(JRTemplateReference reference)
protected void	writeIncludedTemplates()
protected void	writeStyles()
static String	writeTemplate(JasperReportsContext jasperReportsContext, JRTemplate template)	Returns the XML representation of a template.
static void	writeTemplate(JasperReportsContext jasperReportsContext, JRTemplate template, OutputStream out)	Writes the XML representation of a template to an output stream.
static void	writeTemplate(JasperReportsContext jasperReportsContext, JRTemplate template, OutputStream out, String encoding)	Writes the XML representation of a template to an output stream.
protected static void	writeTemplate(JasperReportsContext jasperReportsContext, JRTemplate template, Writer out, String encoding)
static String	writeTemplate(JasperReportsContext jasperReportsContext, JRTemplate template, String encoding)	Returns the XML representation of a template.
static String	writeTemplate(JRTemplate template)	Returns the XML representation of a template.
static void	writeTemplate(JRTemplate template, OutputStream out)	Writes the XML representation of a template to an output stream.
static void	writeTemplate(JRTemplate template, OutputStream out, String encoding)	Writes the XML representation of a template to an output stream.
static String	writeTemplate(JRTemplate template, String encoding)	Returns the XML representation of a template.
static void	writeTemplateToFile(JasperReportsContext jasperReportsContext, JRTemplate template, String outputFile)	Writes the XML representation of a template to a file.
static void	writeTemplateToFile(JasperReportsContext jasperReportsContext, JRTemplate template, String outputFile, String encoding)	Writes the XML representation of a template to a file.
static void	writeTemplateToFile(JRTemplate template, String outputFile)	Writes the XML representation of a template to a file.
static void	writeTemplateToFile(JRTemplate template, String outputFile, String encoding)	Writes the XML representation of a template to a file.

Methods inherited from class net.sf.jasperreports.engine.xml.JRXmlBaseWriter

isNewerVersionOrEqual, isOlderVersionThan, useWriter, writeBox, writeBox, writeConditionalStyle, writeExpression, writeParagraph, writeParagraph, writePen, writeStyle, writeStyleReferenceAttr, writeTabStop

Methods inherited from class java.lang.Object

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

Field Detail

JASPERTEMPLATE_NAMESPACE

public static final XmlNamespace JASPERTEMPLATE_NAMESPACE

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

Default XML output encoding.

See Also:

Constant Field Values

Constructor Detail

JRXmlTemplateWriter

public JRXmlTemplateWriter(JRTemplate template,
                           Writer out,
                           String encoding)

Creates an XML template writer.

Parameters:

template - the template to write

out - the output writer

encoding - the XML encoding to use

JRXmlTemplateWriter

public JRXmlTemplateWriter(JasperReportsContext jasperReportsContext,
                           JRTemplate template,
                           Writer out,
                           String encoding)

Creates an XML template writer.

Parameters:

jasperReportsContext -

template - the template to write

out - the output writer

encoding - the XML encoding to use

Method Detail

writeTemplate

public static String writeTemplate(JRTemplate template)

Returns the XML representation of a template.

Uses the default encoding.

Parameters:

template - the template

Returns:

the XML representation of the template

writeTemplate

public static String writeTemplate(JasperReportsContext jasperReportsContext,
                                   JRTemplate template)

Returns the XML representation of a template.

Uses the default encoding.

Parameters:

jasperReportsContext -

template - the template

Returns:

the XML representation of the template

writeTemplate

public static String writeTemplate(JRTemplate template,
                                   String encoding)

Returns the XML representation of a template.

Parameters:

template - the template

encoding - the XML encoding to use

Returns:

the XML representation of the template

writeTemplate

public static String writeTemplate(JasperReportsContext jasperReportsContext,
                                   JRTemplate template,
                                   String encoding)

Returns the XML representation of a template.

Parameters:

jasperReportsContext -

template - the template

encoding - the XML encoding to use

Returns:

the XML representation of the template

writeTemplate

public static void writeTemplate(JRTemplate template,
                                 OutputStream out)

Writes the XML representation of a template to an output stream.

Uses the default encoding.

Parameters:

template - the template

out - the output stream

writeTemplate

public static void writeTemplate(JasperReportsContext jasperReportsContext,
                                 JRTemplate template,
                                 OutputStream out)

Writes the XML representation of a template to an output stream.

Uses the default encoding.

Parameters:

jasperReportsContext -

template - the template

out - the output stream

writeTemplate

public static void writeTemplate(JRTemplate template,
                                 OutputStream out,
                                 String encoding)

Writes the XML representation of a template to an output stream.

Parameters:

template - the template

out - the output stream

encoding - the XML encoding to use

writeTemplate

public static void writeTemplate(JasperReportsContext jasperReportsContext,
                                 JRTemplate template,
                                 OutputStream out,
                                 String encoding)

Writes the XML representation of a template to an output stream.

Parameters:

jasperReportsContext -

template - the template

out - the output stream

encoding - the XML encoding to use

writeTemplateToFile

public static void writeTemplateToFile(JRTemplate template,
                                       String outputFile)

Writes the XML representation of a template to a file.

Uses the default encoding.

Parameters:

template - the template

outputFile - the output file name

writeTemplateToFile

public static void writeTemplateToFile(JasperReportsContext jasperReportsContext,
                                       JRTemplate template,
                                       String outputFile)

Writes the XML representation of a template to a file.

Uses the default encoding.

Parameters:

jasperReportsContext -

template - the template

outputFile - the output file name

writeTemplateToFile

public static void writeTemplateToFile(JRTemplate template,
                                       String outputFile,
                                       String encoding)

Writes the XML representation of a template to a file.

Parameters:

template - the template

outputFile - the output file name

encoding - the XML encoding to use

writeTemplateToFile

public static void writeTemplateToFile(JasperReportsContext jasperReportsContext,
                                       JRTemplate template,
                                       String outputFile,
                                       String encoding)

Writes the XML representation of a template to a file.

Parameters:

jasperReportsContext -

template - the template

outputFile - the output file name

encoding - the XML encoding to use

writeTemplate

protected static void writeTemplate(JasperReportsContext jasperReportsContext,
                                    JRTemplate template,
                                    Writer out,
                                    String encoding)
                             throws IOException

Throws:

IOException

write

public void write()
           throws IOException

Writes the template to the output writer.

Throws:

IOException

writeIncludedTemplates

protected void writeIncludedTemplates()
                               throws IOException

Throws:

IOException

writeIncludedTemplate

protected void writeIncludedTemplate(JRTemplateReference reference)
                              throws IOException

Throws:

IOException

writeStyles

protected void writeStyles()
                    throws IOException

Throws:

IOException

toWriteConditionalStyles

protected boolean toWriteConditionalStyles()

Description copied from class: JRXmlBaseWriter

Decides whether conditional styles are to be written.

Specified by:

toWriteConditionalStyles in class JRXmlBaseWriter

Returns:

whether conditional styles are to be written