org.opentripplanner.datastore.api.OtpDataStoreConfig Maven / Gradle / Ivy
package org.opentripplanner.datastore.api;
import java.net.URI;
import java.util.List;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import org.opentripplanner.datastore.OtpDataStore;
/**
* The {@link OtpDataStore} config, needed to create a store. This should be provided by the OTP
* application.
*/
public interface OtpDataStoreConfig {
/**
* Save the build issue report to this location (URI). If {@code null} the {@code baseDirectory}
* + {@code /report} is used.
*/
URI reportDirectory();
/**
* Local file system path to Google Cloud Platform service accounts credentials file. The
* credentials is used to access GCS urls. When using GCS from outside of the bucket cluster you
* need to provide a path the the service credentials.
*
* This is a path to a file on the local file system, not an URI.
*
* Optional. May return {@code null}.
*/
String gsCredentials();
/**
* Array of URIs to the open street map pbf files (the pbf format is the only one supported).
*
* This parameter is optional. If {@code null} OSM files are loaded from {@code baseDirectory}.
*/
List osmFiles();
/**
* Array of URIs to elevation data files.
*
* This parameter is optional. If {@code null} DEM files are loaded from {@code baseDirectory}.
*/
List demFiles();
/**
* Array of URIs to GTFS data files .
*
* This parameter is optional. If {@code null} GTFS files are loaded from {@code baseDirectory}.
*/
List gtfsFiles();
/**
* Array of URIs to Netex data files.
*
* This parameter is optional. If {@code null} Netex files are loaded from {@code baseDirectory}.
*/
List netexFiles();
/**
* The URI to the graph object file to load and/or save.
*/
URI graph();
/**
* The URI to the street graph object file to load and/or save.
*/
URI streetGraph();
/**
* The URI to the stop consolidation data source.
*/
@Nullable
URI stopConsolidation();
/**
*
* A pattern to lookup local GTFS files
*/
Pattern gtfsLocalFilePattern();
/**
* A pattern to lookup local NeTEx files.
*/
Pattern netexLocalFilePattern();
/**
* A pattern to lookup local Open Street Map extracts.
*/
Pattern osmLocalFilePattern();
/**
* A pattern to lookup local DEM files.
*/
Pattern demLocalFilePattern();
}