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

java.lang.Object
  org.jfree.report.modules.parser.ext.AbstractExtReportParserHandler
      org.jfree.report.modules.parser.ext.BasicStyleKeyHandler
          org.jfree.report.modules.parser.ext.CompoundStyleKeyHandler

All Implemented Interfaces:

org.jfree.xml.ElementDefinitionHandler

public class CompoundStyleKeyHandler

extends BasicStyleKeyHandler

A compound style-key handler. Handles the creation of compound objects, which should be stored in the element style sheet.

Author:

Thomas Morgner.

Field Summary

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

Constructor Summary

CompoundStyleKeyHandler(ReportParser parser, java.lang.String finishTag, java.lang.String name, java.lang.Class c)
Creates a new handler.

Method Summary

void	characters(char[] ch, int start, int length) Callback to indicate that some character data has been read.
protected CommentHintPath	createCommentKey(java.lang.Object name) Creates a new comment hint path for the given name by appending it to a copy of the current path.
void	endElement(java.lang.String tagName) Callback to indicate that an XML element end tag has been read by the parser.
CommentHintPath	getCommentPath() Returns the current comment hint path for this handler.
java.lang.Object	getValue() Returns the value.
void	setCommentPath(CommentHintPath commentPath) Defines the comment hint path that should be used in this handler.
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.BasicStyleKeyHandler

getKeyfactory, getKeyValueClass, getStyleKey

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 name.

See Also:

Constant Field Values

BASIC_OBJECT_TAG

public static final java.lang.String BASIC_OBJECT_TAG

The basic object tag name.

See Also:

Constant Field Values

Constructor Detail

CompoundStyleKeyHandler

public CompoundStyleKeyHandler(ReportParser parser,
                               java.lang.String finishTag,
                               java.lang.String name,
                               java.lang.Class c)
                        throws org.xml.sax.SAXException

Creates a new handler.

Parameters:

parser - the parser.

finishTag - the finish tag.

name - the name.

c - the class.

Throws:

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

Method Detail

getCommentPath

public CommentHintPath getCommentPath()

Returns the current comment hint path for this handler.

Returns:

the comment hint path.

setCommentPath

public void setCommentPath(CommentHintPath commentPath)

Defines the comment hint path that should be used in this handler. The comment hint path is used to store xml comments in the report builder hints collection.

Parameters:

commentPath - the comment hint path that should be used in this handler.

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.

Specified by:

startElement in interface org.jfree.xml.ElementDefinitionHandler

Overrides:

startElement in class BasicStyleKeyHandler

Parameters:

tagName - the tag name.

attrs - the attributes.

Throws:

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

createCommentKey

protected CommentHintPath createCommentKey(java.lang.Object name)

Creates a new comment hint path for the given name by appending it to a copy of the current path.

Parameters:

name - the name of the new path segment.

Returns:

the new comment path.

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.

Specified by:

characters in interface org.jfree.xml.ElementDefinitionHandler

Overrides:

characters in class BasicStyleKeyHandler

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.

Specified by:

endElement in interface org.jfree.xml.ElementDefinitionHandler

Overrides:

endElement in class BasicStyleKeyHandler

Parameters:

tagName - the tag name.

Throws:

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

getValue

public java.lang.Object getValue()

Returns the value.

Overrides:

getValue in class BasicStyleKeyHandler

Returns:

The value.