org.onebusaway.gtfs.serialization.GtfsReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of onebusaway-gtfs Show documentation
Show all versions of onebusaway-gtfs Show documentation
A Java library for reading and writing General Transit Feed Spec feeds
/**
* Copyright (C) 2011 Brian Ferris
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onebusaway.gtfs.serialization;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.onebusaway.csv_entities.CsvEntityContext;
import org.onebusaway.csv_entities.CsvEntityReader;
import org.onebusaway.csv_entities.CsvInputSource;
import org.onebusaway.csv_entities.CsvTokenizerStrategy;
import org.onebusaway.csv_entities.EntityHandler;
import org.onebusaway.csv_entities.schema.DefaultEntitySchemaFactory;
import org.onebusaway.gtfs.impl.GtfsDaoImpl;
import org.onebusaway.gtfs.model.Agency;
import org.onebusaway.gtfs.model.AgencyAndId;
import org.onebusaway.gtfs.model.FareAttribute;
import org.onebusaway.gtfs.model.FareRule;
import org.onebusaway.gtfs.model.FeedInfo;
import org.onebusaway.gtfs.model.Frequency;
import org.onebusaway.gtfs.model.IdentityBean;
import org.onebusaway.gtfs.model.Pathway;
import org.onebusaway.gtfs.model.Route;
import org.onebusaway.gtfs.model.ServiceCalendar;
import org.onebusaway.gtfs.model.ServiceCalendarDate;
import org.onebusaway.gtfs.model.ShapePoint;
import org.onebusaway.gtfs.model.Stop;
import org.onebusaway.gtfs.model.StopTime;
import org.onebusaway.gtfs.model.Transfer;
import org.onebusaway.gtfs.model.Trip;
import org.onebusaway.gtfs.services.GenericMutableDao;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class GtfsReader extends CsvEntityReader {
private final Logger _log = LoggerFactory.getLogger(GtfsReader.class);
public static final String KEY_CONTEXT = GtfsReader.class.getName()
+ ".context";
private List> _entityClasses = new ArrayList>();
private GtfsReaderContextImpl _context = new GtfsReaderContextImpl();
private GenericMutableDao _entityStore = new GtfsDaoImpl();
private List _agencies = new ArrayList();
private Map, Map> _agencyIdsByEntityClassAndId = new HashMap, Map>();
private String _defaultAgencyId;
private Map _agencyIdMapping = new HashMap();
private boolean _overwriteDuplicates = false;
public GtfsReader() {
_entityClasses.add(Agency.class);
_entityClasses.add(ShapePoint.class);
_entityClasses.add(Route.class);
_entityClasses.add(Stop.class);
_entityClasses.add(Trip.class);
_entityClasses.add(StopTime.class);
_entityClasses.add(ServiceCalendar.class);
_entityClasses.add(ServiceCalendarDate.class);
_entityClasses.add(FareAttribute.class);
_entityClasses.add(FareRule.class);
_entityClasses.add(Frequency.class);
_entityClasses.add(Pathway.class);
_entityClasses.add(Transfer.class);
_entityClasses.add(FeedInfo.class);
CsvTokenizerStrategy tokenizerStrategy = new CsvTokenizerStrategy();
tokenizerStrategy.getCsvParser().setTrimInitialWhitespace(true);
setTokenizerStrategy(tokenizerStrategy);
setTrimValues(true);
/**
* Prep the Entity Schema Factories
*/
DefaultEntitySchemaFactory schemaFactory = createEntitySchemaFactory();
setEntitySchemaFactory(schemaFactory);
CsvEntityContext ctx = getContext();
ctx.put(KEY_CONTEXT, _context);
addEntityHandler(new EntityHandlerImpl());
}
public List getAgencies() {
return _agencies;
}
public void setAgencies(List agencies) {
_agencies = new ArrayList(agencies);
}
public void setDefaultAgencyId(String feedId) {
_defaultAgencyId = feedId;
}
public String getDefaultAgencyId() {
if (_defaultAgencyId != null)
return _defaultAgencyId;
if (_agencies.size() > 0)
return _agencies.get(0).getId();
throw new NoDefaultAgencyIdException();
}
public void addAgencyIdMapping(String fromAgencyId, String toAgencyId) {
_agencyIdMapping.put(fromAgencyId, toAgencyId);
}
public GenericMutableDao getEntityStore() {
return _entityStore;
}
public void setEntityStore(GenericMutableDao entityStore) {
_entityStore = entityStore;
}
public List> getEntityClasses() {
return _entityClasses;
}
public void setEntityClasses(List> entityClasses) {
_entityClasses = entityClasses;
}
public void setOverwriteDuplicates(boolean overwriteDuplicates) {
_overwriteDuplicates = overwriteDuplicates;
}
public void run() throws IOException {
run(getInputSource());
}
public void run(CsvInputSource source) throws IOException {
List> classes = getEntityClasses();
_entityStore.open();
for (Class entityClass : classes) {
_log.info("reading entities: " + entityClass.getName());
readEntities(entityClass, source);
_entityStore.flush();
}
_entityStore.close();
}
/****
* Protected Methods
****/
protected DefaultEntitySchemaFactory createEntitySchemaFactory() {
return GtfsEntitySchemaFactory.createEntitySchemaFactory();
}
protected Object getEntity(Class entityClass, Serializable id) {
if (entityClass == null)
throw new IllegalArgumentException("entity class must not be null");
if (id == null)
throw new IllegalArgumentException("entity id must not be null");
return _entityStore.getEntityForId(entityClass, id);
}
protected String getTranslatedAgencyId(String agencyId) {
String id = _agencyIdMapping.get(agencyId);
if (id != null)
return id;
return agencyId;
}
protected String getAgencyForEntity(Class entityType, String entityId) {
Map agencyIdsByEntityId = _agencyIdsByEntityClassAndId.get(entityType);
if (agencyIdsByEntityId != null) {
String id = agencyIdsByEntityId.get(entityId);
if (id != null)
return id;
}
throw new EntityReferenceNotFoundException(entityType, entityId);
}
/****
* Private Internal Classes
****/
private class EntityHandlerImpl implements EntityHandler {
public void handleEntity(Object entity) {
if (entity instanceof Agency) {
Agency agency = (Agency) entity;
if (agency.getId() == null) {
if (_defaultAgencyId == null)
agency.setId(agency.getName());
else
agency.setId(_defaultAgencyId);
}
// If we already have this agency from a previous load, then we don't
// add it or save it to the entity store
if (_agencies.contains(agency))
return;
_agencies.add((Agency) entity);
} else if (entity instanceof Pathway) {
Pathway pathway = (Pathway) entity;
registerAgencyId(Pathway.class, pathway.getId());
} else if (entity instanceof Route) {
Route route = (Route) entity;
registerAgencyId(Route.class, route.getId());
} else if (entity instanceof Trip) {
Trip trip = (Trip) entity;
registerAgencyId(Trip.class, trip.getId());
} else if (entity instanceof Stop) {
Stop stop = (Stop) entity;
registerAgencyId(Stop.class, stop.getId());
} else if (entity instanceof FareAttribute) {
FareAttribute fare = (FareAttribute) entity;
registerAgencyId(FareAttribute.class, fare.getId());
}
if (entity instanceof IdentityBean) {
_entityStore.saveEntity(entity);
}
}
private void registerAgencyId(Class entityType, AgencyAndId id) {
Map agencyIdsByEntityId = _agencyIdsByEntityClassAndId.get(entityType);
if (agencyIdsByEntityId == null) {
agencyIdsByEntityId = new HashMap();
_agencyIdsByEntityClassAndId.put(entityType, agencyIdsByEntityId);
}
if (agencyIdsByEntityId.containsKey(id.getId()) && !_overwriteDuplicates) {
throw new DuplicateEntityException(entityType, id);
}
agencyIdsByEntityId.put(id.getId(), id.getAgencyId());
}
}
private class GtfsReaderContextImpl implements GtfsReaderContext {
public Object getEntity(Class entityClass, Serializable id) {
return GtfsReader.this.getEntity(entityClass, id);
}
public String getDefaultAgencyId() {
return GtfsReader.this.getDefaultAgencyId();
}
public List getAgencies() {
return GtfsReader.this.getAgencies();
}
public String getAgencyForEntity(Class entityType, String entityId) {
return GtfsReader.this.getAgencyForEntity(entityType, entityId);
}
public String getTranslatedAgencyId(String agencyId) {
return GtfsReader.this.getTranslatedAgencyId(agencyId);
}
}
}