org.matsim.households.HouseholdsWriterV10 Class Reference

Inheritance diagram for org.matsim.households.HouseholdsWriterV10:

Public Member Functions
	HouseholdsWriterV10 (Households households)
void	putAttributeConverters (final Map< Class<?>, AttributeConverter<?>> converters)
void	writeFile (String filename) throws UncheckedIOException
void	run (Household household)
final void	setPrettyPrint (boolean doPrettyPrint)
final void	setIndentationString (String indentationString)
final void	useCompression (final boolean useCompression)

Static Public Attributes
static final String	DEFAULT_DTD_LOCATION = "http://www.matsim.org/files/dtd/"
static final String	MATSIM_NAMESPACE = "http://www.matsim.org/files/dtd"
static final String	XMLNS = "xmlns"
static final String	DEFAULTSCHEMANAMESPACELOCATION = "http://www.w3.org/2001/XMLSchema-instance"

Protected Member Functions
final void	setIndentationLevel (int level)
final void	writeXmlHead () throws UncheckedIOException
final void	writeDoctype (String rootTag, String dtdUrl) throws UncheckedIOException
final void	writeStartTag (String tagname, List< Tuple< String, String >> attributes) throws UncheckedIOException
final void	writeStartTag (String tagname, List< Tuple< String, String >> attributes, boolean closeElement) throws UncheckedIOException
final void	writeStartTag (String tagname, List< Tuple< String, String >> attributes, boolean closeElement, boolean emptyLineAfter) throws UncheckedIOException
final void	writeContent (String content, boolean allowWhitespaces) throws UncheckedIOException
final void	writeEndTag (String tagname) throws UncheckedIOException
final void	writeElement (String tagname, String content) throws UncheckedIOException
final void	openFile (final String filename) throws UncheckedIOException
final void	openOutputStream (OutputStream outputStream)
final void	close () throws UncheckedIOException

Static Protected Member Functions
static Tuple< String, String >	createTuple (String one, String two)
static Tuple< String, String >	createTuple (String one, int two)
static Tuple< String, String >	createTuple (String one, double two)
static Tuple< String, String >	createTuple (String one, boolean two)
static Tuple< String, String >	createTimeTuple (String one, double sec)

Protected Attributes
BufferedWriter	writer = null
Boolean	useCompression = null

Static Protected Attributes
static final String	NL = "\n"

Private Member Functions
void	writeHeader ()
void	writeHouseholds (Households basicHouseholds) throws UncheckedIOException
void	writeIncome (Income income) throws UncheckedIOException
void	writeMembers (List< Id< Person >> memberIds) throws UncheckedIOException

Private Attributes
List< Tuple< String, String > >	atts = new ArrayList<>()
Households	households
final Map< Class<?>, AttributeConverter<?> >	attributeConverters = new HashMap<>()

Static Private Attributes
static final Logger	log = LogManager.getLogger( HouseholdsWriterV10.class )

Detailed Description

Author

dgrether

Definition at line 46 of file HouseholdsWriterV10.java.

Constructor & Destructor Documentation

HouseholdsWriterV10()

org.matsim.households.HouseholdsWriterV10.HouseholdsWriterV10

(

Households

households

)

Definition at line 53 of file HouseholdsWriterV10.java.

References org.matsim.households.HouseholdsWriterV10.households.

                                                      {
        this.households = households;
    }

Member Function Documentation

putAttributeConverters()

void org.matsim.households.HouseholdsWriterV10.putAttributeConverters

(

final Map< Class<?>, AttributeConverter<?>>

converters

)

Definition at line 61 of file HouseholdsWriterV10.java.

                                                                                                {
        this.attributeConverters.putAll( converters );
    }

writeFile()

void org.matsim.households.HouseholdsWriterV10.writeFile

(

String

filename

)

throws UncheckedIOException

Definition at line 65 of file HouseholdsWriterV10.java.

References org.matsim.core.gbl.Gbl.aboutToWrite(), org.matsim.core.utils.io.AbstractMatsimWriter.close(), org.matsim.households.HouseholdsSchemaV10Names.HOUSEHOLDS, org.matsim.core.utils.io.AbstractMatsimWriter.openFile(), org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag(), org.matsim.households.HouseholdsWriterV10.writeHeader(), org.matsim.households.HouseholdsWriterV10.writeHouseholds(), and org.matsim.core.utils.io.MatsimXmlWriter.writeXmlHead().

                                                                       {
        log.info( Gbl.aboutToWrite( " households", filename ) ) ;
        this.openFileAndWritePreamble(filename);
        this.writeHouseholds(this.households);
        this.writeEndAndCloseFile();
    }

Here is the call graph for this function:

writeHeader()

void org.matsim.households.HouseholdsWriterV10.writeHeader ( )

private

Definition at line 85 of file HouseholdsWriterV10.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple(), org.matsim.core.utils.io.MatsimXmlWriter.DEFAULT_DTD_LOCATION, org.matsim.core.utils.io.MatsimXmlWriter.DEFAULTSCHEMANAMESPACELOCATION, org.matsim.households.HouseholdsSchemaV10Names.HOUSEHOLDS, org.matsim.core.utils.io.MatsimXmlWriter.MATSIM_NAMESPACE, org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag(), and org.matsim.core.utils.io.MatsimXmlWriter.XMLNS.

Referenced by org.matsim.households.HouseholdsWriterV10.writeFile().

                              {
        atts.clear();
        atts.add(createTuple(XMLNS, MatsimXmlWriter.MATSIM_NAMESPACE));
        atts.add(createTuple(XMLNS + ":xsi", DEFAULTSCHEMANAMESPACELOCATION));
        atts.add(createTuple("xsi:schemaLocation", MATSIM_NAMESPACE + " " + DEFAULT_DTD_LOCATION + "households_v1.0.xsd"));
        this.writeStartTag(HouseholdsSchemaV10Names.HOUSEHOLDS, atts);
    }

Here is the call graph for this function:

writeHouseholds()

void org.matsim.households.HouseholdsWriterV10.writeHouseholds ( Households  basicHouseholds ) throws UncheckedIOException

private

Definition at line 93 of file HouseholdsWriterV10.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple(), org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.households.Household.getIncome(), org.matsim.households.Household.getMemberIds(), org.matsim.households.Household.getVehicleIds(), org.matsim.households.HouseholdsSchemaV10Names.HOUSEHOLD, org.matsim.households.HouseholdsSchemaV10Names.ID, org.matsim.core.utils.misc.Counter.incCounter(), org.matsim.core.utils.io.AbstractMatsimWriter.NL, org.matsim.core.utils.misc.Counter.printCounter(), org.matsim.households.HouseholdsSchemaV10Names.REFID, org.matsim.households.HouseholdsSchemaV10Names.VEHICLEDEFINITIONID, org.matsim.households.HouseholdsSchemaV10Names.VEHICLES, org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag(), org.matsim.households.HouseholdsWriterV10.writeIncome(), org.matsim.households.HouseholdsWriterV10.writeMembers(), org.matsim.core.utils.io.AbstractMatsimWriter.writer, and org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag().

Referenced by org.matsim.households.HouseholdsWriterV10.writeFile().

                                                                                         {
        Counter counter = new Counter("[HouseholdsWriter] wrote household # ");
        for (Household h : basicHouseholds.getHouseholds().values()) {
            this.writeHousehold(h);
            counter.incCounter();
        }
        counter.printCounter();
    }

Here is the call graph for this function:

writeIncome()

void org.matsim.households.HouseholdsWriterV10.writeIncome ( Income  income ) throws UncheckedIOException

private

Definition at line 134 of file HouseholdsWriterV10.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple(), org.matsim.households.HouseholdsSchemaV10Names.CURRENCY, org.matsim.households.HouseholdsSchemaV10Names.INCOME, org.matsim.households.HouseholdsSchemaV10Names.PERIOD, org.matsim.core.utils.io.MatsimXmlWriter.writeContent(), org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag(), and org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag().

Referenced by org.matsim.households.HouseholdsWriterV10.writeHouseholds().

                                                                        {
        atts.clear();
        if (income.getCurrency() != null) {
            atts.add(createTuple(HouseholdsSchemaV10Names.CURRENCY,income.getCurrency()));
        }
        atts.add(createTuple(HouseholdsSchemaV10Names.PERIOD, income.getIncomePeriod().toString()));
        this.writeStartTag(HouseholdsSchemaV10Names.INCOME, atts);
        this.writeContent(Double.toString(income.getIncome()), true);
        this.writeEndTag(HouseholdsSchemaV10Names.INCOME);
    }

Here is the call graph for this function:

writeMembers()

void org.matsim.households.HouseholdsWriterV10.writeMembers ( List< Id< Person >>  memberIds ) throws UncheckedIOException

private

Definition at line 145 of file HouseholdsWriterV10.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple(), org.matsim.households.HouseholdsSchemaV10Names.MEMBERS, org.matsim.households.HouseholdsSchemaV10Names.PERSONID, org.matsim.households.HouseholdsSchemaV10Names.REFID, org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag(), and org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag().

Referenced by org.matsim.households.HouseholdsWriterV10.writeHouseholds().

                                                                                      {
        this.writeStartTag(HouseholdsSchemaV10Names.MEMBERS, null);
        for (Id<Person> id : memberIds){
            atts.clear();
            atts.add(createTuple(HouseholdsSchemaV10Names.REFID, id.toString()));
            this.writeStartTag(HouseholdsSchemaV10Names.PERSONID, atts, true);
        }
        this.writeEndTag(HouseholdsSchemaV10Names.MEMBERS);
    }

Here is the call graph for this function:

run()

void org.matsim.households.HouseholdsWriterV10.run

(

Household

household

)

Implements org.matsim.households.algorithms.HouseholdAlgorithm.

Definition at line 156 of file HouseholdsWriterV10.java.

                                         {
        writeHousehold(household);
    }

setPrettyPrint()

final void org.matsim.core.utils.io.MatsimXmlWriter.setPrettyPrint ( boolean  doPrettyPrint )

inherited

Set the pretty print flag of the XMLWriter, see comment of flag.

Parameters

doPrettyPrint

Definition at line 74 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.doPrettyPrint.

                                                           {
        this.doPrettyPrint = doPrettyPrint;
    }

setIndentationString()

final void org.matsim.core.utils.io.MatsimXmlWriter.setIndentationString ( String  indentationString )

inherited

Set the String used for indentation in the pretty print xml mode.

Parameters

indentationString

Definition at line 81 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.indentationString.

                                                                     {
        this.indentationString = indentationString;
    }

setIndentationLevel()

final void org.matsim.core.utils.io.MatsimXmlWriter.setIndentationLevel ( int  level )

protectedinherited

Set the indentation level of the writer for pretty print option

Parameters

level

Definition at line 90 of file MatsimXmlWriter.java.

                                                       {
        this.indentationLevel = level;
    }

writeXmlHead()

final void org.matsim.core.utils.io.MatsimXmlWriter.writeXmlHead ( ) throws UncheckedIOException

protectedinherited

Writes the standard xml 1.0 header to the output.

Exceptions

UncheckedIOException

Definition at line 103 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.AbstractMatsimWriter.NL, and org.matsim.core.utils.io.AbstractMatsimWriter.writer.

Referenced by org.matsim.matrices.MatricesWriter.write(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.write(), org.matsim.core.config.ConfigWriter.write(), org.matsim.core.network.io.NetworkWriter.writeContent(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile(), org.matsim.vehicles.VehicleWriterV1.writeFile(), and org.matsim.households.HouseholdsWriterV10.writeFile().

                                                                    {
        try {
            this.writer.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
            if (doPrettyPrint) {
                this.writer.write(NL);
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

writeDoctype()

final void org.matsim.core.utils.io.MatsimXmlWriter.writeDoctype ( String  rootTag, String  dtdUrl  ) throws UncheckedIOException

protectedinherited

Writes the doctype declaration to the output.

Parameters

rootTag	The root tag of the written XML document.
dtdUrl	The location of the document type definition of this XML document.

Exceptions

UncheckedIOException

Definition at line 121 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.AbstractMatsimWriter.NL, and org.matsim.core.utils.io.AbstractMatsimWriter.writer.

Referenced by org.matsim.matrices.MatricesWriter.write(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.write(), org.matsim.core.config.ConfigWriter.write(), org.matsim.core.network.io.NetworkWriter.writeContent(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), and org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile().

                                                                                                 {
        try {
            this.writer.write("<!DOCTYPE " + rootTag + " SYSTEM \"" + dtdUrl + "\">"+NL);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

createTuple() [1/4]

static Tuple<String, String> org.matsim.core.utils.io.MatsimXmlWriter.createTuple ( String  one, String  two  )

staticprotectedinherited

Convenience method to create XML Attributes written by startTag()

Definition at line 132 of file MatsimXmlWriter.java.

Referenced by org.matsim.core.utils.io.MatsimXmlWriter.createTimeTuple(), org.matsim.core.utils.io.MatsimXmlWriter.createTuple(), org.matsim.vehicles.VehicleWriterV1.writeCapacity(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeDepartures(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeDepartures(), org.matsim.vehicles.VehicleWriterV1.writeEngineInformation(), org.matsim.vehicles.VehicleWriterV1.writeFreightCapacity(), org.matsim.households.HouseholdsWriterV10.writeHeader(), org.matsim.households.HouseholdsWriterV10.writeHouseholds(), org.matsim.households.HouseholdsWriterV10.writeIncome(), org.matsim.households.HouseholdsWriterV10.writeMembers(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeMinimalTransferTimes(), org.matsim.vehicles.VehicleWriterV1.writeRootElement(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRouteProfile(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRouteProfile(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitStops(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitStops(), org.matsim.vehicles.VehicleWriterV1.writeVehicles(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                              {
        return new Tuple<>(one, two);
    }

createTuple() [2/4]

static Tuple<String, String> org.matsim.core.utils.io.MatsimXmlWriter.createTuple ( String  one, int  two  )

staticprotectedinherited

Convenience method to create XML Attributes written by startTag()

Definition at line 138 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple().

                                                                            {
        return MatsimXmlWriter.createTuple(one, Integer.toString(two));
    }

Here is the call graph for this function:

createTuple() [3/4]

static Tuple<String, String> org.matsim.core.utils.io.MatsimXmlWriter.createTuple ( String  one, double  two  )

staticprotectedinherited

Convenience method to create XML Attributes written by startTag()

Definition at line 145 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple().

                                                                               {
        if (Double.isNaN(two)) {
            return MatsimXmlWriter.createTuple(one, "NaN");
        }
        if (two == Double.POSITIVE_INFINITY) {
            return MatsimXmlWriter.createTuple(one, "INF");
        }
        if (two == Double.NEGATIVE_INFINITY) {
            return MatsimXmlWriter.createTuple(one, "-INF");
        }
        return MatsimXmlWriter.createTuple(one, Double.toString(two));
    }

Here is the call graph for this function:

createTuple() [4/4]

static Tuple<String, String> org.matsim.core.utils.io.MatsimXmlWriter.createTuple ( String  one, boolean  two  )

staticprotectedinherited

Convenience method to create XML Attributes written by startTag()

Definition at line 161 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple().

                                                                                {
        return MatsimXmlWriter.createTuple(one, Boolean.toString(two));
    }

Here is the call graph for this function:

createTimeTuple()

static Tuple<String, String> org.matsim.core.utils.io.MatsimXmlWriter.createTimeTuple ( String  one, double  sec  )

staticprotectedinherited

Convenience method to create XML Attributes written by startTag()

Definition at line 168 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.createTuple(), and org.matsim.core.utils.misc.Time.writeTime().

Referenced by org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeDepartures(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeDepartures(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRouteProfile(), and org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRouteProfile().

                                                                                   {
        return MatsimXmlWriter.createTuple(one, Time.writeTime(sec));
    }

Here is the call graph for this function:

writeStartTag() [1/3]

final void org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag ( String  tagname, List< Tuple< String, String >>  attributes  ) throws UncheckedIOException

protectedinherited

Writes a start tag with all attributes on the writer

Parameters

tagname
attributes

Exceptions

UncheckedIOException

Definition at line 184 of file MatsimXmlWriter.java.

Referenced by org.matsim.pt.transitSchedule.TransitScheduleWriterV1.write(), org.matsim.vehicles.VehicleWriterV1.writeCapacity(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeDepartures(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeDepartures(), org.matsim.vehicles.VehicleWriterV1.writeEngineInformation(), org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile(), org.matsim.vehicles.VehicleWriterV1.writeFreightCapacity(), org.matsim.households.HouseholdsWriterV10.writeHeader(), org.matsim.households.HouseholdsWriterV10.writeHouseholds(), org.matsim.households.HouseholdsWriterV10.writeIncome(), org.matsim.households.HouseholdsWriterV10.writeMembers(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeMinimalTransferTimes(), org.matsim.vehicles.VehicleWriterV1.writeRootElement(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRouteProfile(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRouteProfile(), org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitStops(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitStops(), org.matsim.vehicles.VehicleWriterV1.writeVehicles(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                                                                          {
        this.writeStartTag(tagname, attributes, false, false);
    }

writeStartTag() [2/3]

final void org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag ( String  tagname, List< Tuple< String, String >>  attributes, boolean  closeElement  ) throws UncheckedIOException

protectedinherited

Definition at line 188 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag().

                                                                                                                                                {
        this.writeStartTag(tagname, attributes, closeElement, false);
    }

Here is the call graph for this function:

writeStartTag() [3/3]

final void org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag ( String  tagname, List< Tuple< String, String >>  attributes, boolean  closeElement, boolean  emptyLineAfter  ) throws UncheckedIOException

protectedinherited

Definition at line 192 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.indent(), org.matsim.core.utils.io.AbstractMatsimWriter.NL, and org.matsim.core.utils.io.AbstractMatsimWriter.writer.

                                                                                                                                                                         {
        try {
        if (doPrettyPrint) {
            this.writer.write(NL);
            indent();
            this.indentationLevel++;
        }
            this.writer.write("<" + tagname);
            if (attributes != null) {
                for (Tuple<String, String> t : attributes){
                    this.writer.write(" " + t.getFirst() + "=\"" + encodeAttributeValue(t.getSecond()) + "\"");
                }
            }
            if (closeElement) {
                this.writer.write("/>");
                if (doPrettyPrint) {
                    this.indentationLevel--;
                }
            }
            else {
                this.writer.write(">");
            }
            if (emptyLineAfter) {
                this.writer.write(NL);
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

writeContent()

final void org.matsim.core.utils.io.MatsimXmlWriter.writeContent ( String  content, boolean  allowWhitespaces  ) throws UncheckedIOException

protectedinherited

Definition at line 223 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.indent(), org.matsim.core.utils.io.AbstractMatsimWriter.NL, and org.matsim.core.utils.io.AbstractMatsimWriter.writer.

Referenced by org.matsim.vehicles.VehicleWriterV1.writeEngineInformation(), org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile(), org.matsim.households.HouseholdsWriterV10.writeIncome(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitRoute(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                                                           {
        try {
            if (doPrettyPrint) {
                this.noWhitespaces = !allowWhitespaces;
                if (!this.noWhitespaces) {
                    this.writer.write(NL);
                    this.indentationLevel++;
                    indent();
                }
            }
            writer.write(encodeContent(content));
            if (!this.noWhitespaces) {
                this.indentationLevel--;
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

writeEndTag()

final void org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag ( String  tagname ) throws UncheckedIOException

protectedinherited

Writes a XML end tag with the given name to the given writer instance

Parameters

tagname

Exceptions

UncheckedIOException

Definition at line 247 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.indent(), org.matsim.core.utils.io.AbstractMatsimWriter.NL, and org.matsim.core.utils.io.AbstractMatsimWriter.writer.

Referenced by org.matsim.pt.transitSchedule.TransitScheduleWriterV1.write(), org.matsim.vehicles.VehicleWriterV1.writeCapacity(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeDepartures(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeDepartures(), org.matsim.vehicles.VehicleWriterV1.writeEngineInformation(), org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile(), org.matsim.households.HouseholdsWriterV10.writeFile(), org.matsim.vehicles.VehicleWriterV1.writeFreightCapacity(), org.matsim.households.HouseholdsWriterV10.writeHouseholds(), org.matsim.households.HouseholdsWriterV10.writeIncome(), org.matsim.households.HouseholdsWriterV10.writeMembers(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeMinimalTransferTimes(), org.matsim.vehicles.VehicleWriterV1.writeRootElement(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeRouteProfile(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeRouteProfile(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.writeTransitStops(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitStops(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                                 {
        try {
            if (doPrettyPrint) {
                this.indentationLevel--;
                if (!this.noWhitespaces) {
                    this.writer.write(NL);
                    indent();
                }
                else {
                    this.noWhitespaces = false;
                }
            }
            this.writer.write("</" + tagname + ">");
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

writeElement()

final void org.matsim.core.utils.io.MatsimXmlWriter.writeElement ( String  tagname, String  content  ) throws UncheckedIOException

protectedinherited

Writes an element including start and end tag on the writer

Parameters

tagname
content

Exceptions

UncheckedIOException

Definition at line 271 of file MatsimXmlWriter.java.

References org.matsim.core.utils.io.MatsimXmlWriter.indent(), org.matsim.core.utils.io.AbstractMatsimWriter.NL, and org.matsim.core.utils.io.AbstractMatsimWriter.writer.

                                                                                                 {
        //start tag
        try {
            if (doPrettyPrint) {
                this.writer.write(NL);
                indent();
                this.indentationLevel++;
            }
            this.writer.write("<" + tagname + ">");
                if (doPrettyPrint) {
                    this.indentationLevel--;
                }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }

        //content
        try {
            writer.write(encodeContent(content));
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }

        //end tag
        try {
            this.writer.write("</" + tagname + ">");
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

useCompression()

final void org.matsim.core.utils.io.AbstractMatsimWriter.useCompression ( final boolean  useCompression )

inherited

Sets whether the file should be gzip-compressed or not. Must be set before the file is opened for writing. If not set explicitly, the usage of compression is defined by the ending of the filename.

Parameters

useCompression

Definition at line 58 of file AbstractMatsimWriter.java.

References org.matsim.core.utils.io.AbstractMatsimWriter.useCompression.

                                                                   {
        this.useCompression = useCompression;
    }

openFile()

final void org.matsim.core.utils.io.AbstractMatsimWriter.openFile ( final String  filename ) throws UncheckedIOException

protectedinherited

Opens the specified file for writing.

Parameters

filename

Exceptions

UncheckedIOException

Definition at line 68 of file AbstractMatsimWriter.java.

References org.matsim.core.utils.io.AbstractMatsimWriter.assertNotAlreadyOpen(), and org.matsim.core.utils.io.IOUtils.getBufferedWriter().

Referenced by org.matsim.matrices.MatricesWriter.write(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.write(), org.matsim.core.network.io.NetworkChangeEventsWriter.write(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.write(), org.matsim.core.config.ConfigWriter.write(), org.matsim.core.population.io.PopulationWriter.write(), org.matsim.vehicles.VehicleWriterV1.writeFile(), org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile(), org.matsim.households.HouseholdsWriterV10.writeFile(), and org.matsim.core.network.io.NetworkWriter.writeFile().

                                                                                     {
        assertNotAlreadyOpen();
        if (this.useCompression == null) {
            this.writer = IOUtils.getBufferedWriter(filename);
        } else {
            this.writer = IOUtils.getBufferedWriter(filename + ".gz");
        }
    }

Here is the call graph for this function:

openOutputStream()

final void org.matsim.core.utils.io.AbstractMatsimWriter.openOutputStream ( OutputStream  outputStream )

protectedinherited

Uses the specified OutputStream for writing.

Definition at line 81 of file AbstractMatsimWriter.java.

References org.matsim.core.utils.io.AbstractMatsimWriter.assertNotAlreadyOpen().

Referenced by org.matsim.pt.transitSchedule.TransitScheduleWriterV2.write(), org.matsim.core.population.io.PopulationWriter.write(), and org.matsim.core.network.io.NetworkWriter.writeStream().

                                                                     {
        assertNotAlreadyOpen();
        try {
            if (this.useCompression == null || this.useCompression) {
                this.writer = new BufferedWriter(new OutputStreamWriter(outputStream, StandardCharsets.UTF_8));
            } else {
                this.writer = new BufferedWriter(new OutputStreamWriter(new GZIPOutputStream(outputStream), StandardCharsets.UTF_8));
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

close()

final void org.matsim.core.utils.io.AbstractMatsimWriter.close ( ) throws UncheckedIOException

protectedinherited

Closes the file if it is still open.

Exceptions

UncheckedIOException

Definition at line 105 of file AbstractMatsimWriter.java.

Referenced by org.matsim.matrices.MatricesWriter.write(), org.matsim.pt.transitSchedule.TransitScheduleWriterV1.write(), org.matsim.core.network.io.NetworkChangeEventsWriter.write(), org.matsim.core.config.ConfigWriter.write(), org.matsim.core.population.io.PopulationWriter.write(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.writeFile(), org.matsim.vehicles.VehicleWriterV1.writeFile(), and org.matsim.households.HouseholdsWriterV10.writeFile().

                                                             {
        if (this.writer != null) {
            try {
                this.writer.flush();
                this.writer.close();
            } catch (IOException e) {
                throw new UncheckedIOException(e);
            } finally {
                this.writer = null;
            }
        }
    }

Member Data Documentation

log

final Logger org.matsim.households.HouseholdsWriterV10.log = LogManager.getLogger( HouseholdsWriterV10.class )

staticprivate

Definition at line 47 of file HouseholdsWriterV10.java.

atts

List<Tuple<String, String> > org.matsim.households.HouseholdsWriterV10.atts = new ArrayList<>()

private

Definition at line 49 of file HouseholdsWriterV10.java.

households

Households org.matsim.households.HouseholdsWriterV10.households

private

Definition at line 50 of file HouseholdsWriterV10.java.

Referenced by org.matsim.households.HouseholdsWriterV10.HouseholdsWriterV10().

attributeConverters

final Map<Class<?>,AttributeConverter<?> > org.matsim.households.HouseholdsWriterV10.attributeConverters = new HashMap<>()

private

Definition at line 51 of file HouseholdsWriterV10.java.

DEFAULT_DTD_LOCATION

final String org.matsim.core.utils.io.MatsimXmlWriter.DEFAULT_DTD_LOCATION = "http://www.matsim.org/files/dtd/"

staticinherited

The default location where dtds are stored on the internet.

Definition at line 41 of file MatsimXmlWriter.java.

Referenced by org.matsim.households.HouseholdsWriterV10.writeHeader(), org.matsim.core.population.io.ParallelPopulationWriterHandlerV6.writeHeaderAndStartElement(), and org.matsim.vehicles.VehicleWriterV1.writeRootElement().

MATSIM_NAMESPACE

final String org.matsim.core.utils.io.MatsimXmlWriter.MATSIM_NAMESPACE = "http://www.matsim.org/files/dtd"

staticinherited

The namespace used in the matsim xml formats

Definition at line 45 of file MatsimXmlWriter.java.

Referenced by org.matsim.core.utils.io.MatsimJaxbXmlWriter.setMarshallerProperties(), org.matsim.households.HouseholdsWriterV10.writeHeader(), and org.matsim.vehicles.VehicleWriterV1.writeRootElement().

XMLNS

final String org.matsim.core.utils.io.MatsimXmlWriter.XMLNS = "xmlns"

staticinherited

Constant for the xml namespace attribute

Definition at line 49 of file MatsimXmlWriter.java.

Referenced by org.matsim.households.HouseholdsWriterV10.writeHeader(), and org.matsim.vehicles.VehicleWriterV1.writeRootElement().

DEFAULTSCHEMANAMESPACELOCATION

final String org.matsim.core.utils.io.MatsimXmlWriter.DEFAULTSCHEMANAMESPACELOCATION = "http://www.w3.org/2001/XMLSchema-instance"

staticinherited

Default location of the namespace of xml schema

Definition at line 53 of file MatsimXmlWriter.java.

Referenced by org.matsim.households.HouseholdsWriterV10.writeHeader(), and org.matsim.vehicles.VehicleWriterV1.writeRootElement().

NL

final String org.matsim.core.utils.io.AbstractMatsimWriter.NL = "\n"

staticprotectedinherited

The Unix newline character.

Definition at line 41 of file AbstractMatsimWriter.java.

Referenced by org.matsim.core.network.io.NetworkChangeEventsWriter.write(), org.matsim.core.utils.io.MatsimXmlWriter.writeContent(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeDepartures(), org.matsim.core.utils.io.MatsimXmlWriter.writeDoctype(), org.matsim.core.utils.io.MatsimXmlWriter.writeElement(), org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag(), org.matsim.core.network.io.NetworkChangeEventsWriter.writeEvent(), org.matsim.households.HouseholdsWriterV10.writeHouseholds(), org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitStops(), and org.matsim.core.utils.io.MatsimXmlWriter.writeXmlHead().

writer

BufferedWriter org.matsim.core.utils.io.AbstractMatsimWriter.writer = null

protectedinherited

The writer output can be written to.

Definition at line 44 of file AbstractMatsimWriter.java.

Referenced by org.matsim.core.utils.io.MatsimXmlWriter.indent(), org.matsim.matrices.MatricesWriter.write(), org.matsim.core.network.io.NetworkChangeEventsWriter.write(), org.matsim.core.config.ConfigWriter.write(), org.matsim.core.population.io.PopulationWriter.write(), org.matsim.core.network.io.NetworkChangeEventsWriter.writeChangeValue(), org.matsim.core.network.io.NetworkWriter.writeContent(), org.matsim.core.utils.io.MatsimXmlWriter.writeContent(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeData(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeDepartures(), org.matsim.core.utils.io.MatsimXmlWriter.writeDoctype(), org.matsim.core.utils.io.MatsimXmlWriter.writeElement(), org.matsim.core.utils.io.MatsimXmlWriter.writeEndTag(), org.matsim.core.network.io.NetworkChangeEventsWriter.writeEvent(), org.matsim.households.HouseholdsWriterV10.writeHouseholds(), org.matsim.core.population.io.PopulationWriter.writePerson(), org.matsim.core.utils.io.MatsimXmlWriter.writeStartTag(), org.matsim.core.config.ConfigWriter.writeStream(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitLine(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitRoute(), org.matsim.pt.transitSchedule.TransitScheduleWriterV2.writeTransitStops(), and org.matsim.core.utils.io.MatsimXmlWriter.writeXmlHead().

useCompression

Boolean org.matsim.core.utils.io.AbstractMatsimWriter.useCompression = null

protectedinherited

Whether or not the output is gzip-compressed. If null, the usage of compression is decided by the filename (whether it ends with .gz or not).

Definition at line 49 of file AbstractMatsimWriter.java.

Referenced by org.matsim.core.utils.io.AbstractMatsimWriter.useCompression().

---

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

• households/HouseholdsWriterV10.java