org.opentripplanner.datastore.configure.DataStoreModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
There is a newer version: 2.6.0
package org.opentripplanner.datastore.configure;

import dagger.Module;
import dagger.Provides;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nullable;
import javax.inject.Singleton;
import org.opentripplanner.datastore.OtpDataStore;
import org.opentripplanner.datastore.api.CompositeDataSource;
import org.opentripplanner.datastore.api.FileType;
import org.opentripplanner.datastore.api.GoogleStorageDSRepository;
import org.opentripplanner.datastore.api.OtpDataStoreConfig;
import org.opentripplanner.datastore.base.DataSourceRepository;
import org.opentripplanner.datastore.file.FileDataSourceRepository;
import org.opentripplanner.datastore.https.HttpsDataSourceRepository;
import org.opentripplanner.standalone.config.api.OtpBaseDirectory;

/**
 * This is the global access point to create a data store and create datasource objects(tests). It
 * uses a build pattern to configure the data store before creating it.
 * 
 * Note that opening a data store should not download or open any data sources, only fetch meta-data
 * to figure out what data is available. A data source is accessed (lazy) using streams.
 * 

 * The only available data store is using the local file system to fetch data, but it is designed so
 * individual forks of OTP can provide their own implementation to fetch data from the cloud, mixed
 * with file access.
 * 

 * Implementation details. This class should contain minimal amount of business logic, delegating
 * all tasks to the underlying implementations.
 */
@Module
public abstract class DataStoreModule {

  /**
   * For test only.
   * 
   * Use this to get a composite data source, bypassing the {@link OtpDataStore}.
   */
  public static CompositeDataSource compositeSource(File file, FileType type) {
    return FileDataSourceRepository.compositeSource(file, type);
  }

  /**
   * Connect to data source and prepare to retrieve data.
   */
  @Provides
  @Singleton
  public static OtpDataStore provideDataStore(
    @OtpBaseDirectory File baseDirectory,
    OtpDataStoreConfig config,
    @Nullable @GoogleStorageDSRepository DataSourceRepository gsRepository
  ) {
    List repositories = new ArrayList<>();

    if (gsRepository != null) {
      repositories.add(gsRepository);
    }

    repositories.add(new HttpsDataSourceRepository());

    // The file data storage repository should be last, to allow
    // other repositories to "override" and grab files analyzing the
    // datasource uri passed in
    repositories.add(createFileDataSourceRepository(baseDirectory, config));

    var dataStore = new OtpDataStore(config, repositories);

    // It might not be "best-practice" to open files during application construction,
    // but delegating this to the client(potentially more than one) is a bit messy as well.
    dataStore.open();

    return dataStore;
  }

  private static FileDataSourceRepository createFileDataSourceRepository(
    File baseDirectory,
    OtpDataStoreConfig config
  ) {
    return new FileDataSourceRepository(
      baseDirectory,
      config.gtfsLocalFilePattern(),
      config.netexLocalFilePattern(),
      config.osmLocalFilePattern(),
      config.demLocalFilePattern()
    );
  }
}