Inheritance diagram for org.matsim.facilities.MatsimFacilitiesReader:

Public Member Functions
	MatsimFacilitiesReader (final Scenario scenario)

	MatsimFacilitiesReader (final String targetCRS, final Scenario scenario)

	MatsimFacilitiesReader (final String externalInputCRS, final String targetCRS, final ActivityFacilities facilities)

void	putAttributeConverter (Class<?> clazz, AttributeConverter<?> converter)

void	putAttributeConverters (Map< Class<?>, AttributeConverter<?>> converters)

void	startTag (final String name, final Attributes atts, final Stack< String > context)

void	endTag (final String name, final String content, final Stack< String > context)

abstract void	startTag (String name, Attributes atts, Stack< String > context)

final void	setValidating (final boolean validateXml)

final void	setNamespaceAware (final boolean awareness)

final void	setLocalDtdDirectory (final String localDtdDirectory)

final void	readFile (final String filename) throws UncheckedIOException

final void	readURL (final URL url) throws UncheckedIOException

final void	readStream (InputStream stream) throws UncheckedIOException

final void	parse (final URL url) throws UncheckedIOException

final void	parse (final InputStream stream) throws UncheckedIOException

final void	parse (final InputSource input) throws UncheckedIOException

final String	getDoctype ()

final InputSource	resolveEntity (final String publicId, final String systemId)

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

final void	startElement (final String uri, final String localName, final String qName, Attributes atts)

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

final void	error (final SAXParseException ex) throws SAXException

final void	fatalError (final SAXParseException ex) throws SAXException

final void	warning (final SAXParseException ex) throws SAXException

Static Public Member Functions
static double	parseDouble (String value) throws NumberFormatException

Protected Member Functions
void	setDoctype (final String doctype)

Private Attributes
final String	externalInputCRS

final String	targetCRS

CoordinateTransformation	coordinateTransformation

final ActivityFacilities	facilities

MatsimXmlParser	delegate = null

Map< Class<?>, AttributeConverter<?> >	attributeConverters = new HashMap<>()

Static Private Attributes
static final String	FACILITIES_V1 = "facilities_v1.dtd"

static final String	FACILITIES_V2 = "facilities_v2.dtd"

static final Logger	log = LogManager.getLogger(MatsimFacilitiesReader.class)

Detailed Description

A reader for facilities-files of MATSim. This reader recognizes the format of the facilities-file and uses the correct reader for the specific facilities-version, without manual setting.

Author: mrieser

Definition at line 41 of file MatsimFacilitiesReader.java.

Constructor & Destructor Documentation

◆ MatsimFacilitiesReader() [1/3]

org.matsim.facilities.MatsimFacilitiesReader.MatsimFacilitiesReader ( final Scenario scenario )

Creates a new reader for MATSim facilities files. Coordinates are not converted

Parameters

scenario The scenario containing the Facilities-object to store the facilities in.

Definition at line 79 of file MatsimFacilitiesReader.java.

                                                            {
         this(null, scenario);
     }

◆ MatsimFacilitiesReader() [2/3]

org.matsim.facilities.MatsimFacilitiesReader.MatsimFacilitiesReader	(	final String	targetCRS,
		final Scenario	scenario
	)

Creates a new reader for MATSim facilities files. Converts the coordinates to the target CRS, given the CRS information in the container attributes, or, if absent, from the config.

Parameters

targetCRS	the CRS the coordinates should be expressed in
scenario	The scenario containing the Facilities-object to store the facilities in.

Definition at line 91 of file MatsimFacilitiesReader.java.

References org.matsim.core.config.Config.facilities(), org.matsim.api.core.v01.Scenario.getActivityFacilities(), org.matsim.api.core.v01.Scenario.getConfig(), org.matsim.core.config.groups.FacilitiesConfigGroup.getInputCRS(), and org.matsim.facilities.MatsimFacilitiesReader.targetCRS.

                                      {
         this(scenario.getConfig().facilities().getInputCRS(), targetCRS, scenario.getActivityFacilities());
     }

Here is the call graph for this function:

◆ MatsimFacilitiesReader() [3/3]

org.matsim.facilities.MatsimFacilitiesReader.MatsimFacilitiesReader	(	final String	externalInputCRS,
		final String	targetCRS,
		final ActivityFacilities	facilities
	)

Creates a new reader for MATSim facilities files.

Parameters

externalInputCRS	specifies the CRS the coordinates are expressed in. If the CRS is define in the container attributes, this value is ignored
targetCRS	the CRS the coordinates should be expressed in
facilities	The ActivityFacilities-object to store the facilities in.

Definition at line 105 of file MatsimFacilitiesReader.java.

References org.matsim.core.utils.io.MatsimXmlParser.ValidationType.DTD_ONLY, org.matsim.facilities.MatsimFacilitiesReader.externalInputCRS, org.matsim.facilities.MatsimFacilitiesReader.facilities, and org.matsim.facilities.MatsimFacilitiesReader.targetCRS.

                                                  {
         super(ValidationType.DTD_ONLY);
         this.externalInputCRS = externalInputCRS;
         this.targetCRS = targetCRS;
         this.facilities = facilities;
     }

Member Function Documentation

◆ putAttributeConverter()

void org.matsim.facilities.MatsimFacilitiesReader.putAttributeConverter	(	Class<?>	clazz,
		AttributeConverter<?>	converter
	)

Definition at line 115 of file MatsimFacilitiesReader.java.

                                                                                        {
         this.attributeConverters.put(clazz, converter);
     }

◆ putAttributeConverters()

void org.matsim.facilities.MatsimFacilitiesReader.putAttributeConverters ( Map< Class<?>, AttributeConverter<?>> converters )

Definition at line 119 of file MatsimFacilitiesReader.java.

                                                                                         {
         this.attributeConverters.putAll(converters);
     }

◆ startTag() [1/2]

void org.matsim.facilities.MatsimFacilitiesReader.startTag	(	final String	name,
		final Attributes	atts,
		final Stack< String >	context
	)

Definition at line 124 of file MatsimFacilitiesReader.java.

References org.matsim.core.utils.io.MatsimXmlParser.startTag().

                                                                                                 {
         this.delegate.startTag(name, atts, context);
     }

Here is the call graph for this function:

◆ endTag()

void org.matsim.facilities.MatsimFacilitiesReader.endTag	(	final String	name,
		final String	content,
		final Stack< String >	context
	)

Definition at line 129 of file MatsimFacilitiesReader.java.

References org.matsim.core.utils.io.MatsimXmlParser.endTag().

                                                                                              {
         this.delegate.endTag(name, content, context);
     }

Here is the call graph for this function:

◆ setDoctype()

void org.matsim.facilities.MatsimFacilitiesReader.setDoctype ( final String doctype )

protected

Definition at line 134 of file MatsimFacilitiesReader.java.

                                                     {
         super.setDoctype(doctype);
         if (FACILITIES_V1.equals(doctype)) {
             this.delegate = new FacilitiesReaderMatsimV1(this.externalInputCRS, this.targetCRS, this.facilities);
             ((FacilitiesReaderMatsimV1)this.delegate).putAttributeConverters(this.attributeConverters);
             log.info("using facilities_v1-reader.");
         } else if (FACILITIES_V2.equals(doctype)) { // v2 added support for 3D coordinates
             this.delegate = new FacilitiesReaderMatsimV2(this.externalInputCRS, this.targetCRS, this.facilities);
             ((FacilitiesReaderMatsimV2)this.delegate).putAttributeConverters(this.attributeConverters);
             log.info("using facilities_v2-reader.");
         } else {
             throw new IllegalArgumentException("Doctype \"" + doctype + "\" not known.");
         }
     }

◆ startTag() [2/2]

abstract void org.matsim.core.utils.io.MatsimXmlParser.startTag	(	String	name,
		Attributes	atts,
		Stack< String >	context
	)

abstractinherited

Called for each opening xml-tag.

Parameters

name	the name of the xml-tag
atts	the list of attributes and their values
context	a stack containing the path/hierarchy to the current tag

Referenced by org.matsim.core.utils.io.MatsimXmlParser.MatsimXmlParser(), org.matsim.core.utils.io.MatsimXmlParser.startElement(), org.matsim.matrices.MatsimMatricesReader.startTag(), org.matsim.core.config.ConfigReader.startTag(), org.matsim.core.network.io.MatsimNetworkReader.startTag(), org.matsim.counts.MatsimCountsReader.startTag(), org.matsim.core.population.io.PopulationReader.startTag(), org.matsim.pt.transitSchedule.api.TransitScheduleReader.XmlScheduleReader.startTag(), and org.matsim.facilities.MatsimFacilitiesReader.startTag().

◆ setValidating()

final void org.matsim.core.utils.io.MatsimXmlParser.setValidating ( final boolean validateXml )

inherited

Sets, if this parser should validate the read XML or not. Not validating is sometimes useful during development or during some tests with format-extensions that are not yet part of the DTD, but it is strongly discouraged not to validate during production use.

Parameters

validateXml Whether the parsed XML should be validated or not.

Definition at line 117 of file MatsimXmlParser.java.

Referenced by org.matsim.core.events.EventsConverterXML.EventsConverterXML(), and org.matsim.core.events.EventsReaderXMLv1.EventsReaderXMLv1().

                                                                {
         this.isValidating = validateXml;
     }

◆ setNamespaceAware()

final void org.matsim.core.utils.io.MatsimXmlParser.setNamespaceAware ( final boolean awareness )

inherited

Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set to false.

Parameters

awareness true if the parser produced by this code will provide support for XML namespaces; false otherwise.

See also: javax.xml.parsers.SAXParserFactory::setNamespaceAware(boolean)

Definition at line 128 of file MatsimXmlParser.java.

                                                                  {
         this.isNamespaceAware = awareness;
     }

◆ setLocalDtdDirectory()

final void org.matsim.core.utils.io.MatsimXmlParser.setLocalDtdDirectory ( final String localDtdDirectory )

inherited

Sets the directory where to look for DTD and XSD files if they are not found at the location specified in the XML.

Parameters

localDtdDirectory

Definition at line 138 of file MatsimXmlParser.java.

                                                                            {
         this.localDtdBase = localDtdDirectory;
     }

◆ readFile()

final void org.matsim.core.utils.io.MatsimXmlParser.readFile ( final String filename ) throws UncheckedIOException

inherited

Parses the specified file. The file can be gzip-compressed and is decompressed on-the-fly while parsing. A gzip-compressed file must have the ending ".gz" to be correctly recognized. The passed filename may or may not contain the ending ".gz". If no uncompressed file is found with the specified name, the ending ".gz" will be added to the filename and a compressed file will be searched for and read if found.

Parameters

filename The filename of the file to read, optionally ending with ".gz" to force reading a gzip-compressed file.

Exceptions

UncheckedIOException

Implements org.matsim.core.api.internal.MatsimReader.

Definition at line 152 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.IOUtils.getBufferedReader(), and org.matsim.core.utils.io.MatsimXmlParser.parse().

Referenced by org.matsim.utils.gis.matsim2esri.plans.SelectedPlans2ESRIShape.main(), org.matsim.core.utils.io.OsmNetworkReader.parse(), org.matsim.vehicles.MatsimVehicleReader.readFile(), org.matsim.pt.transitSchedule.api.TransitScheduleReader.readFile(), org.matsim.core.events.MatsimEventsReader.readFile(), org.matsim.core.population.io.StreamingPopulationReader.readFile(), org.matsim.core.network.NetworkUtils.readNetwork(), org.matsim.core.population.PopulationUtils.readPopulation(), org.matsim.core.network.algorithms.intersectionSimplifier.RunIntersectionSimplifier.run(), and org.matsim.run.gui.ScheduleValidatorWindow.run().

                                                                                   {
         log.info("starting to parse xml from file " + filename + " ...");
         this.theSource = filename;
         parse(new InputSource(IOUtils.getBufferedReader(filename)));
     }

Here is the call graph for this function:

◆ readURL()

final void org.matsim.core.utils.io.MatsimXmlParser.readURL ( final URL url ) throws UncheckedIOException

inherited

Implements org.matsim.core.api.internal.MatsimReader.

Definition at line 159 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.parse().

Referenced by org.matsim.vehicles.MatsimVehicleReader.readURL(), and org.matsim.core.events.MatsimEventsReader.readURL().

                                                                            {
         parse( url ) ;
     }

Here is the call graph for this function:

◆ readStream()

final void org.matsim.core.utils.io.MatsimXmlParser.readStream ( InputStream stream ) throws UncheckedIOException

inherited

Definition at line 163 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.parse().

                                                                                  {
         parse(stream);
     }

Here is the call graph for this function:

◆ parse() [1/3]

final void org.matsim.core.utils.io.MatsimXmlParser.parse ( final URL url ) throws UncheckedIOException

inherited

Definition at line 167 of file MatsimXmlParser.java.

References org.matsim.core.gbl.Gbl.assertNotNull(), and org.matsim.core.utils.io.IOUtils.getBufferedReader().

Referenced by org.matsim.core.config.ConfigUtils.loadConfig(), org.matsim.core.population.io.StreamingPopulationReader.parse(), org.matsim.core.utils.io.MatsimXmlParser.parse(), org.matsim.core.utils.io.OsmNetworkReader.parse(), org.matsim.core.utils.io.MatsimXmlParser.readFile(), org.matsim.vehicles.MatsimVehicleReader.readStream(), org.matsim.pt.transitSchedule.api.TransitScheduleReader.readStream(), org.matsim.core.events.MatsimEventsReader.readStream(), org.matsim.core.utils.io.MatsimXmlParser.readStream(), org.matsim.pt.transitSchedule.api.TransitScheduleReader.readURL(), org.matsim.core.population.io.StreamingPopulationReader.readURL(), and org.matsim.core.utils.io.MatsimXmlParser.readURL().

                                                                        {
         Gbl.assertNotNull(url);
         this.theSource = url.toString();
         log.info("starting to parse xml from url " + this.theSource + " ...");
         System.out.flush();
         parse(new InputSource(IOUtils.getBufferedReader(this.theSource)));
     }

Here is the call graph for this function:

◆ parse() [2/3]

final void org.matsim.core.utils.io.MatsimXmlParser.parse ( final InputStream stream ) throws UncheckedIOException

inherited

Definition at line 175 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.parse().

                                                                                   {
         this.theSource = "stream";
         parse(new InputSource(stream));
     }

Here is the call graph for this function:

◆ parse() [3/3]

final void org.matsim.core.utils.io.MatsimXmlParser.parse ( final InputSource input ) throws UncheckedIOException

inherited

Definition at line 180 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.ValidationType.DTD_ONLY, and org.matsim.core.utils.io.MatsimXmlParser.ValidationType.NO_VALIDATION.

                                                                                  {
         try {
             boolean validating = this.isValidating && this.validationType != ValidationType.NO_VALIDATION;
             boolean useWstxParser = !validating || this.validationType == ValidationType.DTD_ONLY;
 
             if (useWstxParser) {
                 // use Woodstox-library as XML parser when no validation or only DTD-validation is required, as it is much faster than the default (xerces)
 
                 WstxSAXParserFactory factory = new WstxSAXParserFactory();
                 factory.setValidating(validating);
                 factory.setNamespaceAware(this.isNamespaceAware);
                 factory.setFeature("http://xml.org/sax/features/external-general-entities", false); // prevent XEE attack: https://en.wikipedia.org/wiki/XML_external_entity_attack
 
                 if (validating) {
                     factory.setFeature("http://xml.org/sax/features/validation", true); // required to enable DTD validation in Woodstox
                     SAXParser parser = factory.newSAXParser();
                     XMLReader reader = parser.getXMLReader();
                     reader.setContentHandler(this);
                     reader.setErrorHandler(this);
                     reader.setEntityResolver(this);
                     reader.parse(input);
                 } else {
                     SAXParser parser = factory.newSAXParser();
                     parser.parse(input, this);
                 }
 
             } else {
                 // use the default (Xerces) SAX parser, it is slower than Woodstox, but supports XSD validation
 
                 SAXParserFactory factory = SAXParserFactory.newInstance();
                 factory.setValidating(validating);
                 factory.setNamespaceAware(this.isNamespaceAware);
                 factory.setFeature("http://xml.org/sax/features/external-general-entities", false); // prevent XEE attack: https://en.wikipedia.org/wiki/XML_external_entity_attack
 
                 if (validating) {
                     // enable optional support for XML Schemas
                     factory.setFeature("http://apache.org/xml/features/validation/schema", true);
                     SAXParser parser = factory.newSAXParser();
                     XMLReader reader = parser.getXMLReader();
                     reader.setContentHandler(this);
                     reader.setErrorHandler(this);
                     reader.setEntityResolver(this);
                     reader.parse(input);
                 } else {
                     SAXParser parser = factory.newSAXParser();
                     parser.parse(input, this);
                 }
             }
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         } catch (SAXException | ParserConfigurationException e) {
             throw new UncheckedIOException(new IOException(e));
         }
     }

◆ getDoctype()

final String org.matsim.core.utils.io.MatsimXmlParser.getDoctype ( )

inherited

Definition at line 235 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.doctype.

                                      {
         return this.doctype;
     }

◆ resolveEntity()

final InputSource org.matsim.core.utils.io.MatsimXmlParser.resolveEntity	(	final String	publicId,
		final String	systemId
	)

inherited

Definition at line 248 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.findDtdInClasspath(), org.matsim.core.utils.io.MatsimXmlParser.findDtdInDefaultLocation(), org.matsim.core.utils.io.MatsimXmlParser.findDtdInLocalFilesystem(), org.matsim.core.utils.io.MatsimXmlParser.findDtdInRemoteLocation(), and org.matsim.core.utils.io.MatsimXmlParser.setDoctype().

                                                                                          {
         // ConfigReader* did override this.  Not sure if it did that for good reasons.  kai, jul'16
 
         // extract the last part of the systemId
         int index = systemId.replace('\\', '/').lastIndexOf('/');
         String shortSystemId = systemId.substring(index + 1);
 
         if (this.doctype == null) {
             // this is the first systemId we have to resolve, assume it's the doctype
             // I haven't found any other way to determine the doctype of the currently read file
             setDoctype(shortSystemId);
         }
 
         InputSource source;
         if (this.preferLocalDtds) {
             source = findDtdInLocalFilesystem(shortSystemId);
             if (source == null) {
                 source = findDtdInClasspath(shortSystemId);
             }
             if (source == null) {
                 source = findDtdInDefaultLocation(shortSystemId);
             }
             if (source == null) {
                 source = findDtdInRemoteLocation(systemId);
             }
         } else {
             source = findDtdInRemoteLocation(systemId);
             if (source == null) {
                 source = findDtdInLocalFilesystem(shortSystemId);
             }
             if (source == null) {
                 source = findDtdInClasspath(shortSystemId);
             }
             if (source == null) {
                 source = findDtdInDefaultLocation(shortSystemId);
             }
         }
 
         if (source == null) {
             // We could neither get the remote nor the local version of the dtd, show a warning
             log.warn("Could neither get the DTD from the web nor a local one. " + systemId);
         } else {
             source.setSystemId(systemId);
         }
         return source;
     }

Here is the call graph for this function:

◆ characters()

void org.matsim.core.utils.io.MatsimXmlParser.characters	(	final char []	ch,
		final int	start,
		final int	length
	)		throws SAXException

inherited

Definition at line 352 of file MatsimXmlParser.java.

                                                                                                    {
         // has to be non-final since otherwise the events parser does not work.  Probably ok (this here is just a default implementation). kai, jul'16
 
         StringBuffer buffer = this.buffers.peek();
         if (buffer != null) {
             buffer.append(ch, start, length);
         }
     }

◆ startElement()

final void org.matsim.core.utils.io.MatsimXmlParser.startElement	(	final String	uri,
		final String	localName,
		final String	qName,
		Attributes	atts
	)

inherited

Definition at line 362 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.startTag().

                                                                                                                   {
         // I have not good intuition if making this one non-final might be ok.  kai, jul'16
 
         String tag = (uri.length() == 0) ? qName : localName;
         this.buffers.push(new StringBuffer());
         this.startTag(tag, atts, this.theContext);
         this.theContext.push(tag);
     }

Here is the call graph for this function:

◆ endElement()

final void org.matsim.core.utils.io.MatsimXmlParser.endElement	(	final String	uri,
		final String	localName,
		final String	qName
	)		throws SAXException

inherited

Definition at line 372 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.endTag(), and org.matsim.core.utils.io.MatsimXmlParser.theContext.

                                                                                                                    {
         // I have not good intuition if making this one non-final might be ok.  kai, jul'16
 
         String tag = (uri.length() == 0) ? qName : localName;
         this.theContext.pop();
         StringBuffer buffer = this.buffers.pop();
         this.endTag(tag, buffer.toString(), this.theContext);
     }

Here is the call graph for this function:

◆ error()

final void org.matsim.core.utils.io.MatsimXmlParser.error ( final SAXParseException ex ) throws SAXException

inherited

Definition at line 384 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.getInputSource().

                                                                             {
         if (this.theContext.isEmpty()) {
             System.err.println("Missing DOCTYPE.");
         }
         System.err.println("XML-ERROR: " + getInputSource(ex) + ", line " + ex.getLineNumber() + ", column " + ex.getColumnNumber() + ":");
         System.err.println(ex.toString());
         throw ex;
     }

Here is the call graph for this function:

◆ fatalError()

final void org.matsim.core.utils.io.MatsimXmlParser.fatalError ( final SAXParseException ex ) throws SAXException

inherited

Definition at line 394 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.getInputSource().

                                                                                  {
         System.err.println("XML-FATAL: " + getInputSource(ex) + ", line " + ex.getLineNumber() + ", column " + ex.getColumnNumber() + ":");
         System.err.println(ex.toString());
         throw ex;
     }

Here is the call graph for this function:

◆ warning()

final void org.matsim.core.utils.io.MatsimXmlParser.warning ( final SAXParseException ex ) throws SAXException

inherited

Definition at line 401 of file MatsimXmlParser.java.

References org.matsim.core.utils.io.MatsimXmlParser.getInputSource().

                                                                               {
         System.err.println("XML-WARNING: " + getInputSource(ex) + ", line " + ex.getLineNumber() + ", column " + ex.getColumnNumber() + ":");
         System.err.println(ex.getMessage());
     }

Here is the call graph for this function:

◆ parseDouble()

static double org.matsim.core.utils.io.MatsimXmlParser.parseDouble ( String value ) throws NumberFormatException

staticinherited

Parses a String into a double, taking into account the special encoding for Infinity according to the xsd-specifications for the xs:double data type

Definition at line 426 of file MatsimXmlParser.java.

                                                                                 {
         if ("INF".equals(value)) {
             return Double.POSITIVE_INFINITY;
         }
         if ("-INF".equals(value)) {
             return Double.NEGATIVE_INFINITY;
         }
         if ("NaN".equals(value)) {
             return Double.NaN;
         }
         return Double.parseDouble(value);
     }