Package org.dbunit.dataset.xml

Class FlatDtdProducer

java.lang.Object

org.dbunit.dataset.xml.FlatDtdProducer

All Implemented Interfaces:

IDataSetProducer, EntityResolver, DeclHandler, LexicalHandler

public class FlatDtdProducer
extends Object
implements IDataSetProducer, EntityResolver, DeclHandler, LexicalHandler

Produces a DataSet from a flat DTD. Only external DTDs are supported and for the root element only the following declarations are supported.

• ANY: like <!Element dataset ANY>
• sequences: like <!Element dataset (first*,second,third?)gt;
• choices: like <!Element dataset (first|second+|third)>

Combinations of sequences and choices are not support nor are #PCDATA or EMPTY declarations.

Since:

Apr 27, 2003

Version:

$Revision$ $Date$

Author:

Manuel Laflamme, Last changed by: $Author$

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY	Constant for the value "ANY"
static final String	IMPLIED	Constant for the value "#IMPLIED"
static final String	REQUIRED	Constant for the value "#REQUIRED"

Constructor Summary

Constructors

Constructor	Description
FlatDtdProducer()	Default constructor.
FlatDtdProducer(InputSource inputSource)	Creates a producer that reads the DTD from the given input source.

Method Summary

Modifier and Type	Method	Description
void	attributeDecl(String elementName, String attributeName, String type, String mode, String value)
protected String	cleanupTableName(String tableName)	Strips DTD content-model syntax (parentheses, occurrence indicators) from the given table name, as parsed from an ELEMENT declaration.
void	comment(char[] ch, int start, int length)
void	elementDecl(String name, String model)
void	endCDATA()
void	endDTD()
void	endEntity(String name)
void	externalEntityDecl(String name, String publicId, String systemId)
void	internalEntityDecl(String name, String value)
void	produce()	Process this dataset source.
InputSource	resolveEntity(String publicId, String systemId)
void	setConsumer(IDataSetConsumer consumer)	Sets the consumer notified of this producer's dataset content.
static void	setDeclHandler(XMLReader xmlReader, DeclHandler handler)	Registers the given handler as the given XML reader's declaration handler.
static void	setLexicalHandler(XMLReader xmlReader, LexicalHandler handler)	Registers the given handler as the given XML reader's lexical handler.
void	startCDATA()
void	startDTD(String name, String publicId, String systemId)
void	startEntity(String name)

Methods inherited from class java.lang.Object

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

Field Details

REQUIRED

public static final String REQUIRED

Constant for the value "#REQUIRED"

See Also:

• Constant Field Values

IMPLIED

public static final String IMPLIED

Constant for the value "#IMPLIED"

See Also:

• Constant Field Values

ANY

public static final String ANY

Constant for the value "ANY"

See Also:

• Constant Field Values

Constructor Details

FlatDtdProducer

public FlatDtdProducer()

Default constructor.

FlatDtdProducer

public FlatDtdProducer(InputSource inputSource)

Creates a producer that reads the DTD from the given input source.

Parameters:

inputSource - the DTD input source.

Method Details

setDeclHandler

public static void setDeclHandler(XMLReader xmlReader,
 DeclHandler handler)
                           throws SAXNotRecognizedException,
SAXNotSupportedException

Registers the given handler as the given XML reader's declaration handler.

Parameters:

xmlReader - the XML reader to configure.

handler - the declaration handler to register.

Throws:

SAXNotRecognizedException - if the reader does not recognize the declaration-handler property.

SAXNotSupportedException - if the reader does not support the declaration-handler property.

setLexicalHandler

public static void setLexicalHandler(XMLReader xmlReader,
 LexicalHandler handler)
                              throws SAXNotRecognizedException,
SAXNotSupportedException

Registers the given handler as the given XML reader's lexical handler.

Parameters:

xmlReader - the XML reader to configure.

handler - the lexical handler to register.

Throws:

SAXNotRecognizedException - if the reader does not recognize the lexical-handler property.

SAXNotSupportedException - if the reader does not support the lexical-handler property.

setConsumer

public void setConsumer(IDataSetConsumer consumer)
                 throws DataSetException

Description copied from interface: IDataSetProducer

Sets the consumer notified of this producer's dataset content.

Specified by:

setConsumer in interface IDataSetProducer

Parameters:

consumer - the consumer to notify.

Throws:

DataSetException - if the consumer cannot be set.

produce

public void produce()
             throws DataSetException

Description copied from interface: IDataSetProducer

Process this dataset source. During the processing, the IDataSetProducer will provide information about the dataset through the specified event listener.

This method is synchronous: it will not return until processing has ended. If a client application wants to terminate parsing early, it should throw an exception from the listener.

Specified by:

produce in interface IDataSetProducer

Throws:

DataSetException - if processing the dataset source fails.

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

elementDecl

public void elementDecl(String name,
 String model)
                 throws SAXException

Specified by:

elementDecl in interface DeclHandler

Throws:

SAXException

attributeDecl

public void attributeDecl(String elementName,
 String attributeName,
 String type,
 String mode,
 String value)
                   throws SAXException

Specified by:

attributeDecl in interface DeclHandler

Throws:

SAXException

internalEntityDecl

public void internalEntityDecl(String name,
 String value)
                        throws SAXException

Specified by:

internalEntityDecl in interface DeclHandler

Throws:

SAXException

externalEntityDecl

public void externalEntityDecl(String name,
 String publicId,
 String systemId)
                        throws SAXException

Specified by:

externalEntityDecl in interface DeclHandler

Throws:

SAXException

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)
              throws SAXException

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

cleanupTableName

protected String cleanupTableName(String tableName)

Strips DTD content-model syntax (parentheses, occurrence indicators) from the given table name, as parsed from an ELEMENT declaration.

Parameters:

tableName - the raw table name to clean up.

Returns:

the cleaned-up table name.

startEntity

public void startEntity(String name)
                 throws SAXException

Specified by:

startEntity in interface LexicalHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Specified by:

endEntity in interface LexicalHandler

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Throws:

SAXException