java.lang.Object
- net.sf.jasperreports.engine.xml.JRXmlBaseWriter
- - net.sf.jasperreports.engine.xml.JRXmlWriter

```
public class JRXmlWriter
extends JRXmlBaseWriter
```
A writer that produces the JRXML representation of an in-memory report.
Sometimes report designs are generated automatically using the JasperReports API. Report design objects obtained this way can be serialized for disk storage or transferred over the network, but they also can be stored in JRXML format.
The JRXML representation of a given report design object can be obtained by using one of the public static writeReport() methods exposed by this class.

Author:

Teodor Danciu ([email protected]), Minor enhancements by Barry Klawans ([email protected])

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`EXCEPTION_MESSAGE_KEY_FILE_WRITE_ERROR`
`static String`	`EXCEPTION_MESSAGE_KEY_OUTPUT_STREAM_WRITE_ERROR`
`static String`	`EXCEPTION_MESSAGE_KEY_REPORT_DESIGN_WRITE_ERROR`
`static String`	`EXCEPTION_MESSAGE_KEY_UNSUPPORTED_CHART_TYPE`
`static XmlNamespace`	`JASPERREPORTS_NAMESPACE`
`static String`	`PREFIX_EXCLUDE_PROPERTIES`
`static String`	`PROPERTY_EXCLUDE_UUIDS`

Fields inherited from class net.sf.jasperreports.engine.xml.JRXmlBaseWriter
PROPERTY_REPORT_VERSION, version, versionComparator, writer

Constructor Summary

Constructors
Constructor Description

JRXmlWriter(JasperReportsContext jasperReportsContext)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected XmlNamespace`	`getNamespace()`
`JRReport`	`getReport()`
`Writer`	`getUnderlyingWriter()`	Returns the underlying stream to which this writer outputs to.
`JRXmlWriteHelper`	`getXmlWriteHelper()`	Returns the XML write helper used by this report writer.
`boolean`	`isExcludeUuids()`
`protected boolean`	`isPropertyToWrite(JRPropertiesHolder propertiesHolder, String propertyName)`
`void`	`setExcludeUuids(boolean excludeUuids)`
`protected boolean`	`toWriteConditionalStyles()`	Decides whether conditional styles are to be written.
`void`	`write(JRReport report, OutputStream outputStream, String encoding)`
`String`	`write(JRReport report, String encoding)`
`void`	`write(JRReport report, String destFileName, String encoding)`
`void`	`writeAreaChart(JRChart chart)`
`void`	`writeAxisFormat(String axisFormatElementName, JRFont axisLabelFont, Color axisLabelColor, JRFont axisTickLabelFont, Color axisTickLabelColor, String axisTickLabelMask, Boolean axisVerticalTickLabels, Color axisLineColor)`	Writes out the axis format block for a chart axis.
`void`	`writeAxisFormat(JRFont axisLabelFont, Color axisLabelColor, JRFont axisTickLabelFont, Color axisTickLabelColor, String axisTickLabelMask, Boolean axisVerticalTickLabels, Color axisLineColor)`	Writes out the axis format block for a chart axis.
`void`	`writeBar3DChart(JRChart chart)`
`void`	`writeBar3DPlot(JRBar3DPlot plot)`
`void`	`writeBarChart(JRChart chart)`
`void`	`writeBreak(JRBreak breakElement)`
`void`	`writeBubbleChart(JRChart chart)`
`protected void`	`writeBucket(JRCrosstabBucket bucket)`
`void`	`writeCandlestickChart(JRChart chart)`
`void`	`writeCategoryAxisFormat(JRFont axisLabelFont, Color axisLabelColor, JRFont axisTickLabelFont, Color axisTickLabelColor, String axisTickLabelMask, Boolean axisVerticalTickLabels, Double labelRotation, Color axisLineColor)`	Writes out the category axis format block.
`protected void`	`writeCellContents(JRCellContents contents)`
`void`	`writeChartTag(JRChart chart)`
`void`	`writeChildElements(JRElementGroup elementContainer)`	Writes the contents (child elements) of an element container.
`void`	`writeComponentElement(JRComponentElement componentElement)`
`void`	`writeCrosstab(JRCrosstab crosstab)`
`protected void`	`writeCrosstabCell(JRCrosstabCell cell)`
`protected void`	`writeCrosstabColumnGroup(JRCrosstabColumnGroup group)`
`protected void`	`writeCrosstabMeasure(JRCrosstabMeasure measure)`
`protected void`	`writeCrosstabParameter(JRCrosstabParameter parameter)`
`protected void`	`writeCrosstabRowGroup(JRCrosstabRowGroup group)`
`protected void`	`writeDataLevelBucket(DataLevelBucket bucket)`
`void`	`writeDataRange(JRDataRange dataRange)`	Writes a data range block to the output stream.
`void`	`writeDataset(JRDataset dataset)`
`protected void`	`writeDatasetContents(JRDataset dataset)`
`void`	`writeDatasetRun(JRDatasetRun datasetRun)`	Outputs the XML representation of a subdataset run object.
`void`	`writeElementDataset(JRElementDataset dataset)`	Writes the JRXML representation of an `element dataset`.
`void`	`writeElementDataset(JRElementDataset dataset, boolean skipIfEmpty)`	Writes the JRXML representation of an `element dataset`.
`void`	`writeElementDataset(JRElementDataset dataset, DatasetResetTypeEnum defaultResetType, boolean skipIfEmpty)`	Writes the JRXML representation of an `element dataset`.
`void`	`writeElementGroup(JRElementGroup elementGroup)`
`void`	`writeEllipse(JREllipse ellipse)`
`protected void`	`writeExpression(String name, JRExpression expression, boolean writeClass, String defaultClassName)`
`protected void`	`writeExpression(String name, XmlNamespace namespace, JRExpression expression, boolean writeClass)`
`void`	`writeFont(JRFont font)`
`void`	`writeFrame(JRFrame frame)`
`void`	`writeGanttChart(JRChart chart)`
`void`	`writeGenericElement(JRGenericElement element)`
`void`	`writeHighLowChart(JRChart chart)`
`void`	`writeHighLowDataset(JRHighLowDataset dataset)`
`void`	`writeHyperlink(String tagName, JRHyperlink hyperlink)`
`void`	`writeHyperlink(String tagName, XmlNamespace namespace, JRHyperlink hyperlink)`
`protected void`	`writeHyperlinkParameter(JRHyperlinkParameter parameter)`
`protected void`	`writeHyperlinkParameters(JRHyperlinkParameter[] parameters)`
`void`	`writeImage(JRImage image)`
`void`	`writeItemLabel(JRItemLabel itemLabel)`	Writes the description of how to display item labels in a category plot.
`void`	`writeLine(JRLine line)`
`void`	`writeLineChart(JRChart chart)`
`void`	`writeMeterChart(JRChart chart)`	Writes the definition of a meter chart to the output stream.
`void`	`writeMultiAxisChart(JRChart chart)`	Writes the definition of a multiple axis chart to the output stream.
`void`	`writeMultiAxisData(MultiAxisData data)`
`void`	`writePie3DChart(JRChart chart)`
`void`	`writePieChart(JRChart chart)`
`void`	`writePieDataset(JRPieDataset dataset)`
`void`	`writeProperties(JRPropertiesHolder propertiesHolder)`
`protected void`	`writePropertyExpression(DatasetPropertyExpression propertyExpression)`
`protected void`	`writePropertyExpression(JRPropertyExpression propertyExpression)`
`void`	`writePropertyExpressions(DatasetPropertyExpression[] propertyExpressions)`
`void`	`writePropertyExpressions(JRPropertyExpression[] propertyExpressions)`
`void`	`writeRectangle(JRRectangle rectangle)`
`static void`	`writeReport(JRReport report, OutputStream outputStream, String encoding)`
`static String`	`writeReport(JRReport report, String encoding)`
`protected void`	`writeReport(JRReport report, String encoding, Writer out)`
`static void`	`writeReport(JRReport report, String destFileName, String encoding)`
`protected void`	`writeReturnValue(ExpressionReturnValue returnValue)`
`protected void`	`writeReturnValue(VariableReturnValue returnValue)`
`void`	`writeScatterChart(JRChart chart)`
`protected void`	`writeSection(JRSection section)`
`void`	`writeStackedAreaChart(JRChart chart)`
`void`	`writeStackedBar3DChart(JRChart chart)`
`void`	`writeStackedBarChart(JRChart chart)`
`void`	`writeStaticText(JRStaticText staticText)`
`void`	`writeSubreport(JRSubreport subreport)`
`void`	`writeSubreportParameter(JRSubreportParameter subreportParameter, XmlNamespace namespace)`
`void`	`writeSubreportReturnValue(JRSubreportReturnValue returnValue, XmlNamespace namespace)`
`protected void`	`writeTemplate(JRReportTemplate template)`
`protected void`	`writeTemplates(JRReport report)`
`void`	`writeTextField(JRTextField textField)`
`void`	`writeThermometerChart(JRChart chart)`	Writes the description of a thermometer chart to the output stream.
`void`	`writeTimeSeriesChart(JRChart chart)`
`void`	`writeValueDataset(JRValueDataset dataset)`	Writes the description of a value dataset to the output stream.
`void`	`writeValueDisplay(JRValueDisplay valueDisplay)`	Writes the description of how to display a value in a valueDataset.
`void`	`writeXyAreaChart(JRChart chart)`
`void`	`writeXyBarChart(JRChart chart)`
`void`	`writeXyLineChart(JRChart chart)`

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

JASPERREPORTS_NAMESPACE

public static final XmlNamespace JASPERREPORTS_NAMESPACE

EXCEPTION_MESSAGE_KEY_FILE_WRITE_ERROR

public static final String EXCEPTION_MESSAGE_KEY_FILE_WRITE_ERROR

See Also:: Constant Field Values

EXCEPTION_MESSAGE_KEY_OUTPUT_STREAM_WRITE_ERROR

public static final String EXCEPTION_MESSAGE_KEY_OUTPUT_STREAM_WRITE_ERROR

See Also:: Constant Field Values

EXCEPTION_MESSAGE_KEY_REPORT_DESIGN_WRITE_ERROR

public static final String EXCEPTION_MESSAGE_KEY_REPORT_DESIGN_WRITE_ERROR

See Also:: Constant Field Values

EXCEPTION_MESSAGE_KEY_UNSUPPORTED_CHART_TYPE

public static final String EXCEPTION_MESSAGE_KEY_UNSUPPORTED_CHART_TYPE

See Also:: Constant Field Values

PREFIX_EXCLUDE_PROPERTIES

public static final String PREFIX_EXCLUDE_PROPERTIES

See Also:: Constant Field Values

PROPERTY_EXCLUDE_UUIDS

public static final String PROPERTY_EXCLUDE_UUIDS

See Also:: Constant Field Values

Constructor Detail

JRXmlWriter

public JRXmlWriter(JasperReportsContext jasperReportsContext)

Method Detail

getReport
```
public JRReport getReport()
```

isExcludeUuids
```
public boolean isExcludeUuids()
```

setExcludeUuids

public void setExcludeUuids(boolean excludeUuids)

write

public String write(JRReport report,
                    String encoding)

write

public void write(JRReport report,
                  String destFileName,
                  String encoding)
           throws JRException

Throws:: JRException

write

public void write(JRReport report,
                  OutputStream outputStream,
                  String encoding)
           throws JRException

Throws:: JRException

writeReport

public static String writeReport(JRReport report,
                                 String encoding)

See Also:: write(JRReport, String)

writeReport

public static void writeReport(JRReport report,
                               String destFileName,
                               String encoding)
                        throws JRException

Throws:: JRException
See Also:: write(JRReport, String, String)

writeReport

public static void writeReport(JRReport report,
                               OutputStream outputStream,
                               String encoding)
                        throws JRException

Throws:: JRException
See Also:: write(JRReport, OutputStream, String)

writeReport

protected void writeReport(JRReport report,
                           String encoding,
                           Writer out)
                    throws IOException

Throws:: IOException

writeProperties

public void writeProperties(JRPropertiesHolder propertiesHolder)
                     throws IOException

Throws:: IOException

isPropertyToWrite

protected boolean isPropertyToWrite(JRPropertiesHolder propertiesHolder,
                                    String propertyName)

writeTemplates

protected void writeTemplates(JRReport report)
                       throws IOException

Throws:: IOException

writeTemplate

protected void writeTemplate(JRReportTemplate template)
                      throws IOException

Parameters:: template -
Throws:: IOException

writeSection

protected void writeSection(JRSection section)
                     throws IOException

Throws:: IOException

writeChildElements
```
public void writeChildElements(JRElementGroup elementContainer)
```
Writes the contents (child elements) of an element container.

Parameters:

elementContainer - the element container

writeElementGroup

public void writeElementGroup(JRElementGroup elementGroup)
                       throws IOException

Throws:: IOException

writeBreak

public void writeBreak(JRBreak breakElement)
                throws IOException

Throws:: IOException

writeLine

public void writeLine(JRLine line)
               throws IOException

Throws:: IOException

writePropertyExpressions

public void writePropertyExpressions(JRPropertyExpression[] propertyExpressions)
                              throws IOException

Throws:: IOException

writePropertyExpressions

public void writePropertyExpressions(DatasetPropertyExpression[] propertyExpressions)
                              throws IOException

Throws:: IOException

writePropertyExpression

protected void writePropertyExpression(JRPropertyExpression propertyExpression)
                                throws IOException

Throws:: IOException

writePropertyExpression

protected void writePropertyExpression(DatasetPropertyExpression propertyExpression)
                                throws IOException

Throws:: IOException

writeRectangle

public void writeRectangle(JRRectangle rectangle)
                    throws IOException

Throws:: IOException

writeEllipse

public void writeEllipse(JREllipse ellipse)
                  throws IOException

Throws:: IOException

writeImage

public void writeImage(JRImage image)
                throws IOException

Throws:: IOException

writeStaticText

public void writeStaticText(JRStaticText staticText)
                     throws IOException

Throws:: IOException

writeFont

public void writeFont(JRFont font)
               throws IOException

Throws:: IOException

writeTextField

public void writeTextField(JRTextField textField)
                    throws IOException

Throws:: IOException

writeSubreport

public void writeSubreport(JRSubreport subreport)
                    throws IOException

Throws:: IOException

writeSubreportParameter

public void writeSubreportParameter(JRSubreportParameter subreportParameter,
                                    XmlNamespace namespace)
                             throws IOException

Throws:: IOException

writeElementDataset
```
public void writeElementDataset(JRElementDataset dataset)
                         throws IOException
```
Writes the JRXML representation of an element dataset.
The method produces a <dataset> XML element.

Parameters:

dataset - the element dataset

Throws:

IOException - any I/O exception that occurred while writing the XML output

writeElementDataset
```
public void writeElementDataset(JRElementDataset dataset,
                                boolean skipIfEmpty)
                         throws IOException
```
Writes the JRXML representation of an element dataset.
The method produces a <dataset> XML element.

Parameters:

dataset - the element dataset

skipIfEmpty - if set, no output will be produced if the element dataset only has default attribute values

Throws:

IOException - any I/O exception that occurred while writing the XML output

writeElementDataset
```
public void writeElementDataset(JRElementDataset dataset,
                                DatasetResetTypeEnum defaultResetType,
                                boolean skipIfEmpty)
                         throws IOException
```
Writes the JRXML representation of an element dataset.
The method produces a <dataset> XML element.

Parameters:

dataset - the element dataset

defaultResetType - the default dataset reset type

skipIfEmpty - if set, no output will be produced if the element dataset only has default attribute values

Throws:

IOException - any I/O exception that occurred while writing the XML output

writePieDataset

public void writePieDataset(JRPieDataset dataset)
                     throws IOException

Throws:: IOException

writeValueDataset
```
public void writeValueDataset(JRValueDataset dataset)
                       throws IOException
```
Writes the description of a value dataset to the output stream.

Parameters:

dataset - the value dataset to persist

Throws:

IOException

writeValueDisplay
```
public void writeValueDisplay(JRValueDisplay valueDisplay)
                       throws IOException
```
Writes the description of how to display a value in a valueDataset.

Parameters:

valueDisplay - the description to save

Throws:

IOException

writeItemLabel
```
public void writeItemLabel(JRItemLabel itemLabel)
                    throws IOException
```
Writes the description of how to display item labels in a category plot.

Parameters:

itemLabel - the description to save

Throws:

IOException

writeDataRange
```
public void writeDataRange(JRDataRange dataRange)
                    throws IOException
```
Writes a data range block to the output stream.

Parameters:

dataRange - the range to write

Throws:

IOException

writePieChart

public void writePieChart(JRChart chart)
                   throws IOException

Throws:: IOException

writePie3DChart

public void writePie3DChart(JRChart chart)
                     throws IOException

Throws:: IOException

writeCategoryAxisFormat

public void writeCategoryAxisFormat(JRFont axisLabelFont,
                                    Color axisLabelColor,
                                    JRFont axisTickLabelFont,
                                    Color axisTickLabelColor,
                                    String axisTickLabelMask,
                                    Boolean axisVerticalTickLabels,
                                    Double labelRotation,
                                    Color axisLineColor)
                             throws IOException

Writes out the category axis format block.

Parameters:: axisLabelFont - font to use for the axis label; axisLabelColor - color to use for the axis label; axisTickLabelFont - font to use for the label of each tick mark; axisTickLabelColor - color to use for the label of each tick mark; axisTickLabelMask - formatting mask to use for the label of each tick mark; axisVerticalTickLabels - flag to render tick labels at 90 degrees; labelRotation - label rotation angle; axisLineColor - the color to use for the axis line and any tick marks
Throws:: IOException

writeAxisFormat

public void writeAxisFormat(String axisFormatElementName,
                            JRFont axisLabelFont,
                            Color axisLabelColor,
                            JRFont axisTickLabelFont,
                            Color axisTickLabelColor,
                            String axisTickLabelMask,
                            Boolean axisVerticalTickLabels,
                            Color axisLineColor)
                     throws IOException

Writes out the axis format block for a chart axis.

Parameters:: axisFormatElementName - the name of the axis format element being written; axisLabelFont - font to use for the axis label; axisLabelColor - color to use for the axis label; axisTickLabelFont - font to use for the label of each tick mark; axisTickLabelColor - color to use for the label of each tick mark; axisTickLabelMask - formatting mask to use for the label of each tick mark; axisVerticalTickLabels - flag to render tick labels at 90 degrees; axisLineColor - the color to use for the axis line and any tick marks
Throws:: IOException

writeAxisFormat

public void writeAxisFormat(JRFont axisLabelFont,
                            Color axisLabelColor,
                            JRFont axisTickLabelFont,
                            Color axisTickLabelColor,
                            String axisTickLabelMask,
                            Boolean axisVerticalTickLabels,
                            Color axisLineColor)
                     throws IOException

Writes out the axis format block for a chart axis.

Parameters:: axisLabelFont - font to use for the axis label; axisLabelColor - color to use for the axis label; axisTickLabelFont - font to use for the label of each tick mark; axisTickLabelColor - color to use for the label of each tick mark; axisTickLabelMask - formatting mask to use for the label of each tick mark; axisVerticalTickLabels - flag to render tick labels at 90 degrees; axisLineColor - the color to use for the axis line and any tick marks
Throws:: IOException

writeBar3DPlot

public void writeBar3DPlot(JRBar3DPlot plot)
                    throws IOException

Throws:: IOException

writeBarChart

public void writeBarChart(JRChart chart)
                   throws IOException

Throws:: IOException

writeBar3DChart

public void writeBar3DChart(JRChart chart)
                     throws IOException

Throws:: IOException

writeBubbleChart

public void writeBubbleChart(JRChart chart)
                      throws IOException

Throws:: IOException

writeStackedBarChart

public void writeStackedBarChart(JRChart chart)
                          throws IOException

Throws:: IOException

writeStackedBar3DChart

public void writeStackedBar3DChart(JRChart chart)
                            throws IOException

Throws:: IOException

writeLineChart

public void writeLineChart(JRChart chart)
                    throws IOException

Throws:: IOException

writeTimeSeriesChart

public void writeTimeSeriesChart(JRChart chart)
                          throws IOException

Throws:: IOException

writeHighLowDataset

public void writeHighLowDataset(JRHighLowDataset dataset)
                         throws IOException

Throws:: IOException

writeHighLowChart

public void writeHighLowChart(JRChart chart)
                       throws IOException

Throws:: IOException

writeGanttChart

public void writeGanttChart(JRChart chart)
                     throws IOException

Throws:: IOException

writeCandlestickChart

public void writeCandlestickChart(JRChart chart)
                           throws IOException

Throws:: IOException

writeAreaChart

public void writeAreaChart(JRChart chart)
                    throws IOException

Throws:: IOException

writeScatterChart

public void writeScatterChart(JRChart chart)
                       throws IOException

Throws:: IOException

writeXyAreaChart

public void writeXyAreaChart(JRChart chart)
                      throws IOException

Throws:: IOException

writeXyBarChart

public void writeXyBarChart(JRChart chart)
                     throws IOException

Throws:: IOException

writeXyLineChart

public void writeXyLineChart(JRChart chart)
                      throws IOException

Throws:: IOException

writeMeterChart
```
public void writeMeterChart(JRChart chart)
                     throws IOException
```
Writes the definition of a meter chart to the output stream.

Parameters:

chart - the meter chart to write

Throws:

IOException

writeThermometerChart
```
public void writeThermometerChart(JRChart chart)
                           throws IOException
```
Writes the description of a thermometer chart to the output stream.

Parameters:

chart - the thermometer chart to write

Throws:

IOException

writeMultiAxisChart
```
public void writeMultiAxisChart(JRChart chart)
                         throws IOException
```
Writes the definition of a multiple axis chart to the output stream.

Parameters:

chart - the multiple axis chart to write

Throws:

IOException

writeStackedAreaChart

public void writeStackedAreaChart(JRChart chart)
                           throws IOException

Throws:: IOException

writeChartTag

public void writeChartTag(JRChart chart)
                   throws IOException

Throws:: IOException

writeSubreportReturnValue

public void writeSubreportReturnValue(JRSubreportReturnValue returnValue,
                                      XmlNamespace namespace)
                               throws IOException

Throws:: IOException

writeReturnValue

protected void writeReturnValue(VariableReturnValue returnValue)
                         throws IOException

Throws:: IOException

writeReturnValue

protected void writeReturnValue(ExpressionReturnValue returnValue)
                         throws IOException

Throws:: IOException

writeCrosstab

public void writeCrosstab(JRCrosstab crosstab)
                   throws IOException

Throws:: IOException

writeCrosstabRowGroup

protected void writeCrosstabRowGroup(JRCrosstabRowGroup group)
                              throws IOException

Throws:: IOException

writeCrosstabColumnGroup

protected void writeCrosstabColumnGroup(JRCrosstabColumnGroup group)
                                 throws IOException

Throws:: IOException

writeBucket

protected void writeBucket(JRCrosstabBucket bucket)
                    throws IOException

Throws:: IOException

writeCrosstabMeasure

protected void writeCrosstabMeasure(JRCrosstabMeasure measure)
                             throws IOException

Throws:: IOException

writeCrosstabCell

protected void writeCrosstabCell(JRCrosstabCell cell)
                          throws IOException

Throws:: IOException

writeCellContents

protected void writeCellContents(JRCellContents contents)
                          throws IOException

Throws:: IOException

writeCrosstabParameter

protected void writeCrosstabParameter(JRCrosstabParameter parameter)
                               throws IOException

Throws:: IOException

writeDataset

public void writeDataset(JRDataset dataset)
                  throws IOException

Throws:: IOException

writeDatasetContents

protected void writeDatasetContents(JRDataset dataset)
                             throws IOException

Throws:: IOException

writeDatasetRun
```
public void writeDatasetRun(JRDatasetRun datasetRun)
                     throws IOException
```
Outputs the XML representation of a subdataset run object.

Parameters:

datasetRun - the subdataset run

Throws:

IOException

writeFrame

public void writeFrame(JRFrame frame)
                throws IOException

Throws:: IOException

writeHyperlinkParameters

protected void writeHyperlinkParameters(JRHyperlinkParameter[] parameters)
                                 throws IOException

Throws:: IOException

writeHyperlinkParameter

protected void writeHyperlinkParameter(JRHyperlinkParameter parameter)
                                throws IOException

Throws:: IOException

writeHyperlink

public void writeHyperlink(String tagName,
                           JRHyperlink hyperlink)
                    throws IOException

Throws:: IOException

writeHyperlink

public void writeHyperlink(String tagName,
                           XmlNamespace namespace,
                           JRHyperlink hyperlink)
                    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

getXmlWriteHelper
```
public JRXmlWriteHelper getXmlWriteHelper()
```
Returns the XML write helper used by this report writer. The helper can be used to output XML elements and attributes.

Returns:

the XML write helper used by this report writer

getUnderlyingWriter
```
public Writer getUnderlyingWriter()
```
Returns the underlying stream to which this writer outputs to.

Returns:

the underlying stream used by this writer

writeComponentElement

public void writeComponentElement(JRComponentElement componentElement)
                           throws IOException

Throws:: IOException

getNamespace
```
protected XmlNamespace getNamespace()
```

writeGenericElement

public void writeGenericElement(JRGenericElement element)
                         throws IOException

Throws:: IOException

writeMultiAxisData

public void writeMultiAxisData(MultiAxisData data)
                        throws IOException

Throws:: IOException

writeDataLevelBucket

protected void writeDataLevelBucket(DataLevelBucket bucket)
                             throws IOException

Throws:: IOException

writeExpression

protected void writeExpression(String name,
                               JRExpression expression,
                               boolean writeClass,
                               String defaultClassName)
                        throws IOException

Throws:: IOException

writeExpression

protected void writeExpression(String name,
                               XmlNamespace namespace,
                               JRExpression expression,
                               boolean writeClass)
                        throws IOException

Throws:: IOException

Class JRXmlWriter

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

JASPERREPORTS_NAMESPACE

EXCEPTION_MESSAGE_KEY_FILE_WRITE_ERROR

EXCEPTION_MESSAGE_KEY_OUTPUT_STREAM_WRITE_ERROR

EXCEPTION_MESSAGE_KEY_REPORT_DESIGN_WRITE_ERROR

EXCEPTION_MESSAGE_KEY_UNSUPPORTED_CHART_TYPE

PREFIX_EXCLUDE_PROPERTIES

PROPERTY_EXCLUDE_UUIDS

Constructor Detail

JRXmlWriter

Method Detail

getReport

isExcludeUuids

setExcludeUuids

write

write

write

writeReport

writeReport

writeReport

writeReport

writeProperties

isPropertyToWrite

writeTemplates

writeTemplate

writeSection

writeChildElements

writeElementGroup

writeBreak

writeLine

writePropertyExpressions

writePropertyExpressions

writePropertyExpression

writePropertyExpression

writeRectangle

writeEllipse

writeImage

writeStaticText

writeFont

writeTextField

writeSubreport

writeSubreportParameter

writeElementDataset

writeElementDataset

writeElementDataset

writePieDataset

writeValueDataset

writeValueDisplay

writeItemLabel

writeDataRange

writePieChart

writePie3DChart

writeCategoryAxisFormat

writeAxisFormat

writeAxisFormat

writeBar3DPlot

writeBarChart

writeBar3DChart

writeBubbleChart

writeStackedBarChart

writeStackedBar3DChart

writeLineChart

writeTimeSeriesChart

writeHighLowDataset

writeHighLowChart

writeGanttChart

writeCandlestickChart

writeAreaChart

writeScatterChart

writeXyAreaChart

writeXyBarChart

writeXyLineChart

writeMeterChart