org.ginsim.common.xml

Class XMLHelper

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.ginsim.common.xml.XMLHelper

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

GinmlParser, GsXMLHelper, PerturbationParser, SimulationParametersParser

public abstract class XMLHelper
extends DefaultHandler
implements EntityResolver

Base class for XML parsers. Implementors can define hooks to handle the relevant events generated by the SAX parser.

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BOTH
protected String	curval if set to other than null, characters will be stored here
protected static int	ENDONLY
protected Map	m_call
protected static int	NOCALL
protected String	s_dtd
protected String	s_filename
protected static int	STARTONLY
protected XMLReader	xr

Constructor Summary

Constructors

Constructor and Description
XMLHelper()

Method Summary

Modifier and Type	Method and Description
protected static void	addCall(String tag, int id, int constraint, Map m_call, CallMode mode)
protected static void	addCall(String tag, int id, int constraint, Map m_call, int callmode, boolean readcontent) Deprecated.
protected static void	addCall(String tag, int id, Map m_call)
protected static void	addCall(String tag, int id, Map m_call, CallMode mode)
protected static void	addCall(String tag, int id, Map m_call, int callmode, boolean readcontent) Deprecated.
static void	addEntity(String url, String path)
void	characters(char[] ch, int start, int length) if curVal is not null, read characters will be appended there.
protected void	endElement(int id)
void	endElement(String uri, String localName, String qName)
void	error(SAXParseException e)
protected static String	getAttributeValueWithDefault(Attributes attr, String key, String defValue)
ParsingWarningReport	getWarnings() Get the list of warning encountered during parsing if any.
InputSource	resolveEntity(String publicId, String systemId) do the "entity resolver" job, a bit lazy, this needs some cleanups to become more generalist, but it does the job for GINsim...
protected void	startElement(int id, Attributes attributes)
void	startElement(String uri, String localName, String qName, Attributes attributes)
void	startParsing(File file) start parsing a file.
void	startParsing(File file, boolean b) start parsing a file.
void	startParsing(InputStream is)
void	startParsing(InputStream is, boolean validating)
void	warning(SAXParseException e)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

NOCALL

protected static final int NOCALL

See Also:

Constant Field Values

ENDONLY

protected static final int ENDONLY

See Also:

Constant Field Values

STARTONLY

protected static final int STARTONLY

See Also:

Constant Field Values

BOTH

protected static final int BOTH

See Also:

Constant Field Values

curval

protected String curval

if set to other than null, characters will be stored here

s_dtd

protected String s_dtd

s_filename

protected String s_filename

xr

protected XMLReader xr

m_call

protected Map m_call

Constructor Detail

XMLHelper

public XMLHelper()

Method Detail

addEntity

public static void addEntity(String url,
                             String path)

addCall

@Deprecated
protected static void addCall(String tag,
                                          int id,
                                          int constraint,
                                          Map m_call,
                                          int callmode,
                                          boolean readcontent)

Deprecated.

addCall

protected static void addCall(String tag,
                              int id,
                              Map m_call,
                              CallMode mode)

addCall

protected static void addCall(String tag,
                              int id,
                              int constraint,
                              Map m_call,
                              CallMode mode)

addCall

@Deprecated
protected static void addCall(String tag,
                                          int id,
                                          Map m_call,
                                          int callmode,
                                          boolean readcontent)

Deprecated.

addCall

protected static void addCall(String tag,
                              int id,
                              Map m_call)

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

getWarnings

public ParsingWarningReport getWarnings()

Get the list of warning encountered during parsing if any.

Returns:

the list of warnings or null if none was encountered

characters

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

if curVal is not null, read characters will be appended there. a bit less work for other implementors, they just have to set curVal to null or "" when they need it.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

See Also:

ContentHandler.characters(char[], int, int)

startParsing

public void startParsing(File file,
                         boolean b)
                  throws GsException

start parsing a file.

Parameters:

file -

b -

Throws:

GsException

startParsing

public void startParsing(File file)
                  throws GsException

start parsing a file.

Parameters:

file -

Throws:

GsException

startParsing

public void startParsing(InputStream is)
                  throws GsException

Parameters:

is -

Throws:

GsException

startParsing

public void startParsing(InputStream is,
                         boolean validating)
                  throws GsException

Parameters:

is -

validating -

Throws:

GsException

resolveEntity

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

do the "entity resolver" job, a bit lazy, this needs some cleanups to become more generalist, but it does the job for GINsim...

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Parameters:

publicId -

systemId -

Returns:

an input source for the DTD; or null to use the default

Throws:

SAXException

getAttributeValueWithDefault

protected static String getAttributeValueWithDefault(Attributes attr,
                                                     String key,
                                                     String defValue)

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

startElement

protected void startElement(int id,
                            Attributes attributes)

endElement

protected void endElement(int id)