FacilitiesConfigGroup.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * FacilitiesConfigGroup.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007 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.core.config.groups;

import java.net.URL;
import java.util.Map;

import org.matsim.core.config.ConfigGroup;
import org.matsim.core.config.ReflectiveConfigGroup;

public final class FacilitiesConfigGroup extends ReflectiveConfigGroup {

    public static final String GROUP_NAME = "facilities";

    private static final String INPUT_FILE= "inputFacilitiesFile";
    private static final String INPUT_FACILITY_ATTRIBUTES_FILE = "inputFacilityAttributesFile";
    private static final String INPUT_CRS = "inputCRS";
    private static final String INSISTING_ON_USING_DEPRECATED_ATTRIBUTE_FILE = "insistingOnUsingDeprecatedFacilitiesAttributeFile" ;

    private String inputFile = null;
    private String inputFacilitiesAttributesFile = null;
    private String inputCRS = null;
    private boolean insistingOnUsingDeprecatedPersonAttributeFile = false ;

    // following params are required only if activitiesFacilities are generated internally (e.g., FacilitiesSource.onePerActivityLocationInPlansFile). Amit Jan'18
    private String idPrefix = "f_auto_";
//  private boolean removingLinksAndCoordinates = true;
//  private boolean assigningOpeningTime = false;
//  private boolean assigningLinksToFacilitiesIfMissing = true;

    private static final String FACILITIES_SOURCE = "facilitiesSource";
    public enum FacilitiesSource {none, fromFile, setInScenario, onePerActivityLinkInPlansFile,
        onePerActivityLinkInPlansFileExceptWhenCoordinatesAreGiven, onePerActivityLocationInPlansFile}

    private FacilitiesSource facilitiesSource = FacilitiesSource.none;
//  private boolean addEmptyActivityOption = false;

//  private static final String ADD_EMPTY_ACTIVITY_OPTIONS = "addEmptyActivityOption";
    private static final String ID_PREFIX="idPrefix";
//  private static final String REMOVING_LINKS_AND_COORDINATES = "removingLinksAndCoordinates";
//  private static final String ASSIGNING_OPENING_TIME = "assigningOpeningTime";
//  private static final String ASSIGNING_LINKS_TO_FACILITIES_IF_MISSING="assigningLinksToFacilitiesIfMissing";

    public static final String FACILITIES_ATTRIBUTES_DEPRECATION_MESSAGE = "using the separate facilities attribute file is deprecated.  Add the information directly into each facility, using " +
            "the Attributable feature.  If you insist on continuing to use the separate facility attribute file, set " +
            "insistingOnUsingDeprecatedFacilityAttributeFile to true.  The file will then be read, but the values " +
            "will be entered into each facility using Attributable, and written as such to output_facilities.";

    public FacilitiesConfigGroup() {
        super(GROUP_NAME);
    }

    @Override
    public Map<String,String> getComments() {
        final Map<String,String> comments = super.getComments();

        comments.put( INPUT_CRS , "The Coordinates Reference System in which the coordinates are expressed in the input file." +
                " At import, the coordinates will be converted to the coordinate system defined in \"global\", and will" +
                "be converted back at export. If not specified, no conversion happens." );

        {
            StringBuilder options = new StringBuilder();
            for ( FacilitiesSource source : FacilitiesSource.values() ) {
                options.append(source);
                options.append(' ');
            }
            comments.put(FACILITIES_SOURCE, "This defines how facilities should be created. Possible values: "+options.toString());
        }

        comments.put( ID_PREFIX, "A prefix to be used for auto-generated IDs.");

//      comments.put(ONE_FACILITY_PER_LINK, "Sets whether all activities on a link should be collected within one ActivityFacility." +
//              " Default is 'true'. If set to 'false', for each coordinate found in the population's activities a separate ActivityFacility will be created.");

//      comments.put(REMOVING_LINKS_AND_COORDINATES, "If set to 'true' (which is the default), the link and coordinate attributes " +
//              "are replaced by null reference in the activities, as this information is now available via the facility.");
//
//      comments.put(ADD_EMPTY_ACTIVITY_OPTIONS, "If set to 'true', empty activity option will be created.");
//
//      comments.put(ASSIGNING_OPENING_TIME, "If set to 'true', opening time will be assigned to activity facilities from ActivityParams. Default is false. This will NOT override option 'addEmptyActivityOption'.");

//      comments.put(ASSIGNING_LINKS_TO_FACILITIES_IF_MISSING, "Default is 'true'. In the case that a facility has no link assigned, the ActivityFacility can be assigned to the closest link." +
//              " If there should be only one ActivityFacility per link and if no link-assignment should be done, set to 'false'." +
//              "This will create a new ActivityFacility at the coordinate and the facility will not be assigned to a link.");
        return comments;
    }

    /* direct access */

    @StringGetter( INPUT_FILE )
    public String getInputFile() {
        return this.inputFile;
    }
    @StringSetter( INPUT_FILE )
    public void setInputFile(final String inputFile) {
        this.inputFile = inputFile;
    }

    public URL getInputFileURL(URL context) {
        return ConfigGroup.getInputFileURL(context, this.inputFile);
    }

    @StringGetter( INPUT_FACILITY_ATTRIBUTES_FILE )
    @Deprecated // I think that this should be phased out; use Attributes inside each facility.  kai, mar'19
    public String getInputFacilitiesAttributesFile() {
        return this.inputFacilitiesAttributesFile;
    }

    @StringSetter( INPUT_FACILITY_ATTRIBUTES_FILE )
    @Deprecated // I think that this should be phased out; use Attributes inside each facility.  kai, mar'19
    public void setInputFacilitiesAttributesFile(String inputFacilitiesAttributesFile) {
        this.inputFacilitiesAttributesFile = inputFacilitiesAttributesFile;
    }

    @StringGetter( INPUT_CRS )
    public String getInputCRS() {
        return inputCRS;
    }

    @StringSetter( INPUT_CRS )
    public void setInputCRS(String inputCRS) {
        this.inputCRS = inputCRS;
    }

    @StringGetter(ID_PREFIX)
    public String getIdPrefix() {
        return idPrefix;
    }

    @StringSetter(ID_PREFIX)
    public void setIdPrefix(String idPrefix) {
        this.idPrefix = idPrefix;
    }

//  @StringGetter(ONE_FACILITY_PER_LINK)
//  public boolean isOneFacilityPerLink() {
//      return oneFacilityPerLink;
//  }
//
//  @StringSetter(ONE_FACILITY_PER_LINK)
//  public void setOneFacilityPerLink(boolean oneFacilityPerLink) {
//      this.oneFacilityPerLink = oneFacilityPerLink;
//  }

//  @StringGetter(REMOVING_LINKS_AND_COORDINATES)
//  public boolean isRemovingLinksAndCoordinates() {
//      return removingLinksAndCoordinates;
//  }

//  @StringSetter(REMOVING_LINKS_AND_COORDINATES)
//  public void setRemovingLinksAndCoordinates(boolean removingLinksAndCoordinates) {
//      this.removingLinksAndCoordinates = removingLinksAndCoordinates;
//  }
//
//  public boolean isAssigningOpeningTime() {
//      return assigningOpeningTime;
//  }
//
//  public void setAssigningOpeningTime(boolean assigningOpeningTime) {
//      this.assigningOpeningTime = assigningOpeningTime;
//  }

//  @StringGetter(ASSIGNING_LINKS_TO_FACILITIES_IF_MISSING)
//  public boolean isAssigningLinksToFacilitiesIfMissing() {
//      return assigningLinksToFacilitiesIfMissing;
//  }

//  @StringSetter(ASSIGNING_LINKS_TO_FACILITIES_IF_MISSING)
//  public void setAssigningLinksToFacilitiesIfMissing(boolean assigningLinksToFacilitiesIfMissing) {
//      this.assigningLinksToFacilitiesIfMissing = assigningLinksToFacilitiesIfMissing;
//  }

    @StringGetter(FACILITIES_SOURCE)
    public FacilitiesSource getFacilitiesSource() {
        return this.facilitiesSource;
    }

    @StringSetter(FACILITIES_SOURCE)
    public void setFacilitiesSource(FacilitiesSource facilitiesSource) {
        this.facilitiesSource = facilitiesSource;
    }

    @StringSetter(INSISTING_ON_USING_DEPRECATED_ATTRIBUTE_FILE)
    public final void setInsistingOnUsingDeprecatedFacilitiesAttributeFile( boolean val ) {
        this.insistingOnUsingDeprecatedPersonAttributeFile = val ;
    }
    @StringGetter(INSISTING_ON_USING_DEPRECATED_ATTRIBUTE_FILE)
    public final boolean isInsistingOnUsingDeprecatedFacilitiesAttributeFile() {
        return insistingOnUsingDeprecatedPersonAttributeFile;
    }

//  public boolean isAddEmptyActivityOption() {
//      return addEmptyActivityOption;
//  }
//
//  public void setAddEmptyActivityOption(boolean addEmptyActivityOption) {
//      this.addEmptyActivityOption = addEmptyActivityOption;
//  }
}