org.jfree.report.modules.parser.ext
Class TemplateHandler

java.lang.Object
  org.jfree.report.modules.parser.ext.AbstractExtReportParserHandler
      org.jfree.report.modules.parser.ext.TemplateHandler

All Implemented Interfaces:

org.jfree.xml.ElementDefinitionHandler

public class TemplateHandler

extends AbstractExtReportParserHandler

A template handler. A template is a predefined usecase for some DataSources.

Author:

Thomas Morgner.

See Also:

Template

Field Summary

static java.lang.String	BASIC_OBJECT_TAG The basic object tag.
static java.lang.String	COMPOUND_OBJECT_TAG The compound object tag.

Constructor Summary

TemplateHandler(ReportParser parser, java.lang.String finishTag, TemplateDescription template, CommentHintPath path)
Creates a new template handler.

Method Summary

void	characters(char[] ch, int start, int length) Callback to indicate that some character data has been read.
void	endElement(java.lang.String tagName) Callback to indicate that an XML element end tag has been read by the parser.
TemplateDescription	getTemplate() Returns the template description.
void	startElement(java.lang.String tagName, org.xml.sax.Attributes attrs) Callback to indicate that an XML element start tag has been read by the parser.

Methods inherited from class org.jfree.report.modules.parser.ext.AbstractExtReportParserHandler

addComment, getFinishTag, getParser, getParserHints, getReport, getReportParser

Methods inherited from class java.lang.Object

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

Field Detail

COMPOUND_OBJECT_TAG

public static final java.lang.String COMPOUND_OBJECT_TAG

The compound object tag.

See Also:

Constant Field Values

BASIC_OBJECT_TAG

public static final java.lang.String BASIC_OBJECT_TAG

The basic object tag.

See Also:

Constant Field Values

Constructor Detail

TemplateHandler

public TemplateHandler(ReportParser parser,
                       java.lang.String finishTag,
                       TemplateDescription template,
                       CommentHintPath path)

Creates a new template handler. The handler will be deactivated when the finishTag was reached on endElement.

Parameters:

parser - the parser.

finishTag - the finish tag.

template - the template description.

path - the path on where to search for ext-parser comments in the report builder hints.

Method Detail

startElement

public void startElement(java.lang.String tagName,
                         org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException

Callback to indicate that an XML element start tag has been read by the parser.

Parameters:

tagName - the tag name.

attrs - the attributes.

Throws:

org.xml.sax.SAXException - if a parser error occurs or the validation failed.

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Callback to indicate that some character data has been read.

Parameters:

ch - the character array.

start - the start index for the characters.

length - the length of the character sequence.

Throws:

org.xml.sax.SAXException - if a parser error occurs or the validation failed.

endElement

public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException

Callback to indicate that an XML element end tag has been read by the parser.

Parameters:

tagName - the tag name.

Throws:

org.xml.sax.SAXException - if a parser error occurs or the validation failed.

getTemplate

public TemplateDescription getTemplate()

Returns the template description.

Returns:

The template description.