Eclipse SUMO - Simulation of Urban MObility
GenericSAXHandler Class Reference

A handler which converts occuring elements and attributes into enums. More...

#include <GenericSAXHandler.h>

Inheritance diagram for GenericSAXHandler:
Collaboration diagram for GenericSAXHandler:

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occurred. More...
 
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 The inherited method called when a tag is being closed. More...
 
 GenericSAXHandler (StringBijection< int >::Entry *tags, int terminatorTag, StringBijection< int >::Entry *attrs, int terminatorAttr, const std::string &file, const std::string &expectedRoot="")
 Constructor. More...
 
const std::string & getFileName () const
 returns the current file name More...
 
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed. More...
 
void setFileName (const std::string &name)
 Sets the current file name. More...
 
void startElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE::Attributes &attrs)
 The inherited method called when a new tag opens. More...
 
virtual ~GenericSAXHandler ()
 Destructor. More...
 

SAX ErrorHandler callbacks

class SUMOSAXReader
 
void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings. More...
 
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors. More...
 
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors. More...
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message. More...
 
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Callback method for an opening tag to implement by derived classes. More...
 
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes. More...
 
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes. More...
 
void setSchemaSeen (const bool schemaSeen=true)
 
XMLCh * convert (const std::string &name) const
 converts from c++-string into unicode More...
 
int convertTag (const std::string &tag) const
 Converts a tag from its string into its numerical representation. More...
 

attributes parsing

typedef std::map< int, XMLCh * > AttrMap
 
AttrMap myPredefinedTags
 
std::map< int, std::string > myPredefinedTagsMML
 the map from ids to their string representation More...
 

elements parsing

typedef std::map< std::string, int > TagMap
 
TagMap myTagMap
 
std::vector< std::string > myCharactersVector
 A list of character strings obtained so far to build the complete characters string at the end. More...
 
GenericSAXHandlermyParentHandler
 The handler to give control back to. More...
 
int myParentIndicator
 The tag indicating that control should be given back. More...
 
std::string myFileName
 The name of the currently parsed file. More...
 
std::string myExpectedRoot
 The root element to expect, empty string disables the check. More...
 
bool mySchemaSeen
 whether the reader has already seen a schema More...
 
 GenericSAXHandler (const GenericSAXHandler &s)
 invalidated copy constructor More...
 
const GenericSAXHandleroperator= (const GenericSAXHandler &s)
 invalidated assignment operator More...
 

Detailed Description

A handler which converts occuring elements and attributes into enums.

Normally, when using a standard SAX-handler, we would have to compare the incoming XMLCh*-element names with the ones we can parse. The same applies to parsing the attributes. This was assumed to be very time consuming, that's why we derive our handlers from this class.

The idea behind this second handler layer was avoid repeated conversion from strings/whatever to XMLCh* and back again. The usage is quite straight forward, the only overhead is the need to define the enums - both elements and attributes within "SUMOXMLDefinitions". Still, it maybe helps to avoid typos.

This class implements the SAX-callback and offers a new set of callbacks which must be implemented by derived classes. Instead of XMLCh*-values, element names are supplied to the derived classes as enums (int).

Also, this class allows to retrieve attributes using enums (int) within the implemented "myStartElement" method.

Basically, GenericSAXHandler is not derived within SUMO directly, but via SUMOSAXHandler which knows all tags/attributes used by SUMO. It is still kept separate for an easier maintainability and later extensions.

Definition at line 67 of file GenericSAXHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::map<int, XMLCh*> GenericSAXHandler::AttrMap
private

Definition at line 285 of file GenericSAXHandler.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap
private

Definition at line 299 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ GenericSAXHandler() [1/2]

GenericSAXHandler::GenericSAXHandler ( StringBijection< int >::Entry *  tags,
int  terminatorTag,
StringBijection< int >::Entry *  attrs,
int  terminatorAttr,
const std::string &  file,
const std::string &  expectedRoot = "" 
)

Constructor.

This constructor gets the lists of known tag and attribute names with their enums (sumotags and sumoattrs in most cases). The end of the list is signaled by terminatorTag/terminatorAttr respectively.

The attribute names are converted into XMLCh* and stored within an internal container. This container is cleared within the destructor.

Parameters
[in]tagsThe list of known tags
[in]terminatorTagThe tag which signales the end of tags (usually the last entry)
[in]attrsThe list of known attributes
[in]terminatorAttrThe attr which signales the end of attrs (usually the last entry)
[in]fileThe name of the processed file
[in]expectedRootThe expected root element, empty string disables the check
Todo:
Why are both lists non-const and given as pointers?

Definition at line 40 of file GenericSAXHandler.cpp.

References convert(), myPredefinedTags, myPredefinedTagsMML, and myTagMap.

◆ ~GenericSAXHandler()

GenericSAXHandler::~GenericSAXHandler ( )
virtual

Destructor.

Definition at line 60 of file GenericSAXHandler.cpp.

References myPredefinedTags.

◆ GenericSAXHandler() [2/2]

GenericSAXHandler::GenericSAXHandler ( const GenericSAXHandler s)
private

invalidated copy constructor

Member Function Documentation

◆ buildErrorMessage()

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
protected

Builds an error message.

The error message includes the file name and the line/column information as supported by the given SAXParseException

Parameters
[in]exceptionThe name of the currently processed file
Returns
A string describing the given exception

Definition at line 186 of file GenericSAXHandler.cpp.

References getFileName(), and transcode().

Referenced by error(), fatalError(), and warning().

◆ characters()

void GenericSAXHandler::characters ( const XMLCh *const  chars,
const XERCES3_SIZE_t  length 
)

The inherited method called when characters occurred.

The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon as the element ends.

Todo:

recheck/describe what happens with characters when a new element is opened

describe characters processing in the class' head

Definition at line 169 of file GenericSAXHandler.cpp.

References myCharactersVector, and StringUtils::transcode().

◆ convert()

XMLCh * GenericSAXHandler::convert ( const std::string &  name) const
private

converts from c++-string into unicode

Todo:
recheck encoding
Parameters
[in]nameThe string to convert
Returns
The string converted into a XMLCh-string

Definition at line 80 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler().

◆ convertTag()

int GenericSAXHandler::convertTag ( const std::string &  tag) const
private

Converts a tag from its string into its numerical representation.

Returns the enum-representation stored for the given tag. If the tag is not known, SUMO_TAG_NOTHING is returned.

Parameters
[in]tagThe string to convert
Returns
The int-value that represents the string, SUMO_TAG_NOTHING if the named attribute is not known

Definition at line 176 of file GenericSAXHandler.cpp.

References myTagMap, and SUMO_TAG_NOTHING.

Referenced by endElement(), and startElement().

◆ endElement()

void GenericSAXHandler::endElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname 
)

The inherited method called when a tag is being closed.

This method calls the user-implemented methods myCharacters with the previously collected and converted characters.

Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 120 of file GenericSAXHandler.cpp.

References convertTag(), myCharacters(), myCharactersVector, myEndElement(), myParentHandler, myParentIndicator, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, SUMO_TAG_NOTHING, and StringUtils::transcode().

◆ error()

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Parameters
[in]exceptionThe occurred exception to process
Exceptions
ProcessErrorOn any call

Definition at line 205 of file GenericSAXHandler.cpp.

References buildErrorMessage().

Referenced by MSRouteHandler::addFlowPerson(), MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::myStartElement().

◆ fatalError()

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Exceptions
ProcessErrorOn any call
Parameters
[in]exceptionThe occurred exception to process

Definition at line 211 of file GenericSAXHandler.cpp.

References buildErrorMessage().

◆ getFileName()

◆ myCharacters()

void GenericSAXHandler::myCharacters ( int  element,
const std::string &  chars 
)
protectedvirtual

Callback method for characters to implement by derived classes.

Called by "endElement" (see there).

Parameters
[in]elementThe opened element, given as a int
[in]charsThe complete embedded character string @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_OpenDrive, and NIImporter_ITSUMO::Handler.

Definition at line 221 of file GenericSAXHandler.cpp.

Referenced by endElement().

◆ myEndElement()

◆ myStartElement()

void GenericSAXHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual

Callback method for an opening tag to implement by derived classes.

Called by "startElement" (see there).

Parameters
[in]elementThe element that contains the characters, given as a int
[in]attrsThe SAX-attributes, wrapped as SUMOSAXAttributes @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_OpenStreetMap::RelationHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenDrive, NIImporter_Vissim::NIVissimXMLHandler_ConflictArea, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, GUINet::DiscoverAttributes, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, PCLoaderOSM::EdgesHandler, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, PCLoaderOSM::RelationsHandler, NIImporter_Vissim::NIVissimXMLHandler_Parkplatzdefinition, GNEParametersDialog::ParametersOptions::GNEParameterHandler, MSTriggeredRerouter, PCLoaderOSM::NodesHandler, SAXWeightsHandler, NIImporter_Vissim::NIVissimXMLHandler_Zuflussdefinition, NIImporter_MATSim::EdgesHandler, NLHandler, MSCalibrator, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, MSLaneSpeedTrigger, NIImporter_SUMO, NIImporter_MATSim::NodesHandler, NIImporter_ITSUMO::Handler, PCLoaderXML, NIXMLEdgesHandler, NIXMLNodesHandler, SUMORouteHandler, TrajectoriesHandler, GNEAdditionalHandler, NIXMLPTHandler, PCNetProjectionLoader, RORouteHandler, ROJTRTurnDefLoader, ODDistrictHandler, ShapeHandler, MSRouteHandler, RONetHandler, MSStateHandler, NIXMLConnectionsHandler, ODAmitranHandler, NIXMLTrafficLightsHandler, NIXMLTypesHandler, PCTypeDefHandler, AGActivityGenHandler, GUISettingsHandler, ROMARouteHandler, and RODFDetectorHandler.

Definition at line 217 of file GenericSAXHandler.cpp.

Referenced by SUMOSAXReader::parseNext(), and startElement().

◆ operator=()

const GenericSAXHandler& GenericSAXHandler::operator= ( const GenericSAXHandler s)
private

invalidated assignment operator

◆ registerParent()

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)

Assigning a parent handler which is enabled when the specified tag is closed.

Definition at line 161 of file GenericSAXHandler.cpp.

References myParentHandler, myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

◆ setFileName()

void GenericSAXHandler::setFileName ( const std::string &  name)

Sets the current file name.

Parameters
[in]nameThe name of the currently processed file
Todo:
Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 68 of file GenericSAXHandler.cpp.

References myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), NITypeLoader::load(), PCNetProjectionLoader::load(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), main(), and XMLSubSys::runParser().

◆ setSchemaSeen()

void GenericSAXHandler::setSchemaSeen ( const bool  schemaSeen = true)
inlineprotected

Definition at line 254 of file GenericSAXHandler.h.

References mySchemaSeen.

Referenced by SUMOSAXReader::LocalSchemaResolver::resolveEntity().

◆ startElement()

void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const XERCES_CPP_NAMESPACE::Attributes &  attrs 
)

The inherited method called when a new tag opens.

The method parses the supplied XMLCh*-qname using the internal name/enum-map to obtain the enum representation of the attribute name.

Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the attributes.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 93 of file GenericSAXHandler.cpp.

References convertTag(), FileHelpers::getConfigurationRelative(), getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), myCharactersVector, myExpectedRoot, myPredefinedTags, myPredefinedTagsMML, mySchemaSeen, myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, and StringUtils::transcode().

◆ warning()

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)

Handler for XML-warnings.

The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.

Parameters
[in]exceptionThe occurred exception to process

Definition at line 199 of file GenericSAXHandler.cpp.

References buildErrorMessage(), and WRITE_WARNING.

Friends And Related Function Documentation

◆ SUMOSAXReader

friend class SUMOSAXReader
friend

Definition at line 205 of file GenericSAXHandler.h.

Field Documentation

◆ myCharactersVector

std::vector<std::string> GenericSAXHandler::myCharactersVector
private

A list of character strings obtained so far to build the complete characters string at the end.

Definition at line 306 of file GenericSAXHandler.h.

Referenced by characters(), endElement(), and startElement().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
private

The root element to expect, empty string disables the check.

Definition at line 318 of file GenericSAXHandler.h.

Referenced by startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
private

The name of the currently parsed file.

Definition at line 315 of file GenericSAXHandler.h.

Referenced by getFileName(), and setFileName().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
private

The handler to give control back to.

Definition at line 309 of file GenericSAXHandler.h.

Referenced by endElement(), and registerParent().

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator
private

The tag indicating that control should be given back.

Definition at line 312 of file GenericSAXHandler.h.

Referenced by endElement(), and registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
private

Definition at line 288 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), startElement(), and ~GenericSAXHandler().

◆ myPredefinedTagsMML

std::map<int, std::string> GenericSAXHandler::myPredefinedTagsMML
private

the map from ids to their string representation

Definition at line 291 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), SUMOSAXReader::parseNext(), and startElement().

◆ mySchemaSeen

bool GenericSAXHandler::mySchemaSeen
private

whether the reader has already seen a schema

Definition at line 321 of file GenericSAXHandler.h.

Referenced by setSchemaSeen(), and startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
private

Definition at line 302 of file GenericSAXHandler.h.

Referenced by convertTag(), and GenericSAXHandler().


The documentation for this class was generated from the following files: