TemplateWriter (classic-core 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.AbstractXMLDefinitionWriter
- - org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.ObjectWriter
  - - org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.TemplateWriter

```
public class TemplateWriter
extends ObjectWriter
```
The template writer writes a single template definition to the xml-definition stream. This writer requires report builder hints to be present for all templates.

Author:

Thomas Morgner

Field Summary
- 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
`TemplateWriter(ReportWriterContext reportWriter, org.pentaho.reporting.libraries.xmlns.writer.XmlWriter indentLevel, TemplateDescription template, TemplateDescription parent)`	Creates a new template writer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void write()
Writes the report definition portion.
- Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.parser.extwriter.ObjectWriter
  getClassFactoryCollector, getObjectDescription, getParameterDescription, getParameterNames, isBasicObject, writeParameter
- 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

- Constructor Detail
  - TemplateWriter
```
public TemplateWriter(ReportWriterContext reportWriter,
                      org.pentaho.reporting.libraries.xmlns.writer.XmlWriter indentLevel,
                      TemplateDescription template,
                      TemplateDescription parent)
```
    Creates a new template writer.
    
    Parameters:
    
    reportWriter - the report writer that is used to coordinate the writing.
    
    indentLevel - the current indention level.
    
    template - the template that should be written.
    
    parent - the parent of the template.
- Method Detail
  - write
```
public 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.
    
    Overrides:
    
    write in class ObjectWriter
    
    Throws:
    
    IOException - if there is an I/O problem.
    
    ReportWriterException - if the report serialisation failed.