PersonMoneyEvent.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * AgentMoneyEvent.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2008 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.api.core.v01.events;

import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.population.Person;

import java.util.Map;

import static org.matsim.core.utils.io.XmlUtils.writeEncodedAttributeKeyValue;

public final class PersonMoneyEvent extends Event implements HasPersonId {

    public static final String EVENT_TYPE = "personMoney";

    public static final String ATTRIBUTE_AMOUNT = "amount";
    public static final String ATTRIBUTE_PURPOSE = "purpose";
    public static final String ATTRIBUTE_TRANSACTION_PARTNER = "transactionPartner";
    public static final String ATTRIBUTE_REFERENCE = "reference";

    private final Id<Person> personId;
    private final double amount;
    private final String purpose;
    private final String transactionPartner;
    private final String reference;

    public PersonMoneyEvent(final double time, final Id<Person> agentId, final double amount, final String purpose,
                final String transactionPartner, final String reference) {
        super(time);
        this.personId = agentId;
        this.amount = amount;
        this.purpose = purpose;
        this.transactionPartner = transactionPartner;
        this.reference = reference;
    }
    @Deprecated // add "purpose" and "transactionPartner" and "reference"
    public PersonMoneyEvent(final double time, final Id<Person> agentId, final double amount) {
        this( time, agentId, amount, null, null, null);
    }

    @Deprecated // add "reference"
    public PersonMoneyEvent(final double time, final Id<Person> agentId, final double amount, final String purpose,
                            final String transactionPartner) {
        this(time, agentId, amount, purpose, transactionPartner, null);
    }

    @Override
    public Id<Person> getPersonId() {
        return this.personId;
    }

    public double getAmount() {
        return this.amount;
    }

    public String getPurpose() {
        return this.purpose;
    }

    public String getTransactionPartner() {
        return this.transactionPartner;
    }

    public String getReference() {
        return this.reference;
    }

    @Override
    public String getEventType() {
        return EVENT_TYPE;
    }

    @Override
    public Map<String, String> getAttributes() {
        Map<String, String> attr = super.getAttributes();
        // personId is treated in upstream
        attr.put(ATTRIBUTE_AMOUNT, Double.toString(this.amount));
        if (this.purpose != null) {
            attr.put(ATTRIBUTE_PURPOSE, this.purpose);
        }
        if (this.transactionPartner != null) {
            attr.put(ATTRIBUTE_TRANSACTION_PARTNER, this.transactionPartner);
        }
        if (this.reference != null) {
            attr.put(ATTRIBUTE_REFERENCE, this.reference);
        }
        return attr;
    }

    @Override
    public void writeAsXML(StringBuilder out) {
        // Writes all common attributes
        writeXMLStart(out);

        out.append("amount=\"").append(this.amount).append("\" ");
        if (this.purpose != null) {
            writeEncodedAttributeKeyValue(out, ATTRIBUTE_PURPOSE, this.purpose);
        }
        if (this.transactionPartner != null) {
            writeEncodedAttributeKeyValue(out, ATTRIBUTE_TRANSACTION_PARTNER, this.transactionPartner);
        }
        if (this.reference != null) {
            writeEncodedAttributeKeyValue(out, ATTRIBUTE_REFERENCE, this.reference);
        }

        writeXMLEnd(out);
    }
}