• Home
• org.entur
• netex-parser-java
• 3.1.23
• source code
• ServiceFrameParser.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.entur.netex.loader.parser.ServiceFrameParser Maven / Gradle / Ivy

package org.entur.netex.loader.parser;

import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import org.entur.netex.index.api.NetexEntityIndex;
import org.entur.netex.index.api.NetexEntitiesIndex;
import org.rutebanken.netex.model.DestinationDisplay;
import org.rutebanken.netex.model.DestinationDisplaysInFrame_RelStructure;
import org.rutebanken.netex.model.FlexibleLine;
import org.rutebanken.netex.model.FlexibleStopAssignment;
import org.rutebanken.netex.model.FlexibleStopPlace;
import org.rutebanken.netex.model.GroupOfLines;
import org.rutebanken.netex.model.GroupsOfLinesInFrame_RelStructure;
import org.rutebanken.netex.model.JourneyPattern;
import org.rutebanken.netex.model.JourneyPatternsInFrame_RelStructure;
import org.rutebanken.netex.model.Line;
import org.rutebanken.netex.model.LinesInFrame_RelStructure;
import org.rutebanken.netex.model.Network;
import org.rutebanken.netex.model.NetworksInFrame_RelStructure;
import org.rutebanken.netex.model.PassengerStopAssignment;
import org.rutebanken.netex.model.Route;
import org.rutebanken.netex.model.RoutePoint;
import org.rutebanken.netex.model.RoutePointsInFrame_RelStructure;
import org.rutebanken.netex.model.RoutesInFrame_RelStructure;
import org.rutebanken.netex.model.ScheduledStopPoint;
import org.rutebanken.netex.model.ScheduledStopPointsInFrame_RelStructure;
import org.rutebanken.netex.model.ServiceLink;
import org.rutebanken.netex.model.ServiceLinksInFrame_RelStructure;
import org.rutebanken.netex.model.Service_VersionFrameStructure;
import org.rutebanken.netex.model.StopAssignmentsInFrame_RelStructure;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import jakarta.xml.bind.JAXBElement;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

class ServiceFrameParser extends NetexParser {

    private static final Logger LOG = LoggerFactory.getLogger(ServiceFrameParser.class);

    private final NetexEntityIndex flexibleStopPlaceById;

    private final Collection networks = new ArrayList<>();

    private final Collection groupOfLines = new ArrayList<>();

    private final Collection routes = new ArrayList<>();

    private final Collection flexibleLines = new ArrayList<>();

    private final Collection lines = new ArrayList<>();

    private final Map networkIdByGroupOfLineId = new HashMap<>();

    private final Collection journeyPatterns = new ArrayList<>();

    private final Collection destinationDisplays = new ArrayList<>();

    private final Map quayIdByStopPointRef = new HashMap<>();

    private final Map stopPlaceIdByStopPointRef = new HashMap<>();

    private final Map flexibleStopPlaceByStopPointRef = new HashMap<>();

    private final Collection serviceLinks = new ArrayList<>();

    private final Collection scheduledStopPoints = new ArrayList<>();

    private final Collection routePoints = new ArrayList<>();

    private final Multimap passengerStopAssignmentByStopPointRef = ArrayListMultimap.create();

    private final NoticeParser noticeParser = new NoticeParser();

    ServiceFrameParser(NetexEntityIndex flexibleStopPlaceById) {
        this.flexibleStopPlaceById = flexibleStopPlaceById;
    }

    @Override
    void parse(Service_VersionFrameStructure frame) {
        parseStopAssignments(frame.getStopAssignments());
        parseRoutes(frame.getRoutes());
        parseNetwork(frame.getNetwork());
        parseAdditionalNetworks(frame.getAdditionalNetworks());
        noticeParser.parseNotices(frame.getNotices());
        noticeParser.parseNoticeAssignments(frame.getNoticeAssignments());
        parseLines(frame.getLines());
        parseJourneyPatterns(frame.getJourneyPatterns());
        parseDestinationDisplays(frame.getDestinationDisplays());
        parseServiceLinks(frame.getServiceLinks());
        parseScheduledStopPoints(frame.getScheduledStopPoints());
        parseRoutePoints(frame.getRoutePoints());

        // Keep list sorted alphabetically
        informOnElementIntentionallySkipped(LOG, frame.getCommonSections());
        informOnElementIntentionallySkipped(LOG, frame.getConnections());
        informOnElementIntentionallySkipped(LOG, frame.getDirections());
        informOnElementIntentionallySkipped(LOG, frame.getDisplayAssignments());
        informOnElementIntentionallySkipped(LOG, frame.getFlexibleLinkProperties());
        informOnElementIntentionallySkipped(LOG, frame.getFlexiblePointProperties());
        informOnElementIntentionallySkipped(LOG, frame.getGeneralSections());
        informOnElementIntentionallySkipped(LOG, frame.getGroupsOfLines());
        informOnElementIntentionallySkipped(LOG, frame.getGroupsOfLinks());
        informOnElementIntentionallySkipped(LOG, frame.getGroupsOfPoints());
        informOnElementIntentionallySkipped(LOG, frame.getLineNetworks());
        informOnElementIntentionallySkipped(LOG, frame.getLogicalDisplays());
        informOnElementIntentionallySkipped(LOG, frame.getPassengerInformationEquipments());
        informOnElementIntentionallySkipped(LOG, frame.getRouteLinks());
        informOnElementIntentionallySkipped(LOG, frame.getRoutingConstraintZones());
        informOnElementIntentionallySkipped(LOG, frame.getServiceExclusions());
        informOnElementIntentionallySkipped(LOG, frame.getServicePatterns());
        informOnElementIntentionallySkipped(LOG, frame.getStopAreas());
        informOnElementIntentionallySkipped(LOG, frame.getTariffZones());
        informOnElementIntentionallySkipped(LOG, frame.getTimeDemandTypes());
        informOnElementIntentionallySkipped(LOG, frame.getTimeDemandTypeAssignments());
        informOnElementIntentionallySkipped(LOG, frame.getTimingPoints());
        informOnElementIntentionallySkipped(LOG, frame.getTimingLinks());
        informOnElementIntentionallySkipped(LOG, frame.getTimingLinkGroups());
        informOnElementIntentionallySkipped(LOG, frame.getTimingPatterns());
        informOnElementIntentionallySkipped(LOG, frame.getTransferRestrictions());

        verifyCommonUnusedPropertiesIsNotSet(LOG, frame);
    }

    @Override
    void setResultOnIndex(NetexEntitiesIndex index) {
        // update entities
        index.getDestinationDisplayIndex().putAll(destinationDisplays);
        index.getGroupOfLinesIndex().putAll(groupOfLines);
        index.getJourneyPatternIndex().putAll(journeyPatterns);
        index.getFlexibleLineIndex().putAll(flexibleLines);
        index.getLineIndex().putAll(lines);
        index.getNetworkIndex().putAll(networks);
        noticeParser.setResultOnIndex(index);
        index.getQuayIdByStopPointRefIndex().putAll(quayIdByStopPointRef);
        index.getStopPlaceIdByStopPointRefIndex().putAll(stopPlaceIdByStopPointRef);
        index.getFlexibleStopPlaceIdByStopPointRefIndex().putAll(flexibleStopPlaceByStopPointRef);
        index.getRouteIndex().putAll(routes);
        index.getServiceLinkIndex().putAll(serviceLinks);
        index.getScheduledStopPointIndex().putAll(scheduledStopPoints);
        index.getRoutePointIndex().putAll(routePoints);
        index.getPassengerStopAssignmentsByStopPointRefIndex().putAll(passengerStopAssignmentByStopPointRef);

        // update references
        index.getNetworkIdByGroupOfLineIdIndex().putAll(networkIdByGroupOfLineId);
    }

    private void parseStopAssignments(StopAssignmentsInFrame_RelStructure stopAssignments) {
        if (stopAssignments == null) return;

        for (JAXBElement stopAssignment : stopAssignments.getStopAssignment()) {
            if (stopAssignment.getValue() instanceof PassengerStopAssignment) {
                PassengerStopAssignment assignment = (PassengerStopAssignment) stopAssignment.getValue();

                String stopPointRef = assignment.getScheduledStopPointRef().getValue().getRef();

                passengerStopAssignmentByStopPointRef.put(stopPointRef, assignment);

                if (assignment.getQuayRef() != null) {
                    String quayRef = assignment.getQuayRef().getValue().getRef();
                    quayIdByStopPointRef.put(stopPointRef, quayRef);
                }

                if (assignment.getStopPlaceRef() != null) {
                    String stopPlaceRef = assignment.getStopPlaceRef().getValue().getRef();
                    stopPlaceIdByStopPointRef.put(stopPointRef, stopPlaceRef);
                }
            }
            else if (stopAssignment.getValue() instanceof FlexibleStopAssignment) {
                FlexibleStopAssignment assignment = (FlexibleStopAssignment) stopAssignment.getValue();
                String flexibleStopPlaceRef = assignment.getFlexibleStopPlaceRef().getRef();

                // TODO      - This check belongs to the mapping or as a separate validation
                //           - step. The problem is that we do not want to relay on the
                //           - the order in witch elements are loaded.
                FlexibleStopPlace flexibleStopPlace = flexibleStopPlaceById.get(
                    flexibleStopPlaceRef);

                if (flexibleStopPlace != null) {
                    String stopPointRef = assignment.getScheduledStopPointRef().getValue().getRef();
                    flexibleStopPlaceByStopPointRef.put(stopPointRef, flexibleStopPlace.getId());
                }
                else {
                    LOG.warn(
                        "FlexibleStopPlace {} not found in stop place file.",
                        flexibleStopPlaceRef
                    );
                }
            }
        }
    }

    private void parseRoutes(RoutesInFrame_RelStructure routes) {
        if (routes == null) return;

        for (JAXBElement element : routes.getRoute_()) {
            if (element.getValue() instanceof Route route) {
                this.routes.add(route);
            }
        }
    }

    private void parseNetwork(Network network) {
        if (network == null) return;

        networks.add(network);

        GroupsOfLinesInFrame_RelStructure groupsOfLines = network.getGroupsOfLines();

        if (groupsOfLines != null) {
            parseGroupOfLines(groupsOfLines.getGroupOfLines(), network);
        }
    }

    private void parseAdditionalNetworks(NetworksInFrame_RelStructure additionalNetworks) {
        if (additionalNetworks == null) { return; }

        for (Network additionalNetwork : additionalNetworks.getNetwork()) {
            parseNetwork(additionalNetwork);
        }
    }

    private void parseGroupOfLines(Collection groupOfLines, Network network) {
        for (GroupOfLines group : groupOfLines) {
            networkIdByGroupOfLineId.put(group.getId(), network.getId());
            this.groupOfLines.add(group);
        }
    }

    private void parseLines(LinesInFrame_RelStructure lines) {
        if (lines == null) return;

        for (JAXBElement element : lines.getLine_()) {
            if (element.getValue() instanceof Line) {
                this.lines.add((Line) element.getValue());
            } else if (element.getValue() instanceof FlexibleLine) {
                this.flexibleLines.add((FlexibleLine) element.getValue());
            }
            else {
                informOnElementIntentionallySkipped(LOG, element.getValue());
            }
        }
    }

    private void parseJourneyPatterns(JourneyPatternsInFrame_RelStructure journeyPatterns) {
        if (journeyPatterns == null) return;

        for (JAXBElement pattern : journeyPatterns.getJourneyPattern_OrJourneyPatternView()) {
            if (pattern.getValue() instanceof JourneyPattern) {
                this.journeyPatterns.add((JourneyPattern) pattern.getValue());
            }
            else {
                informOnElementIntentionallySkipped(LOG, pattern.getValue());
            }
        }
    }

    private void parseDestinationDisplays(DestinationDisplaysInFrame_RelStructure destDisplays) {
        if (destDisplays == null) return;

        this.destinationDisplays.addAll(destDisplays.getDestinationDisplay());
    }

    private void parseServiceLinks(ServiceLinksInFrame_RelStructure serviceLinks) {
        if (serviceLinks == null) return;

        this.serviceLinks.addAll(serviceLinks.getServiceLink());
    }

    private void parseScheduledStopPoints(ScheduledStopPointsInFrame_RelStructure scheduledStopPoints) {
        if (scheduledStopPoints == null) return;

        this.scheduledStopPoints.addAll(scheduledStopPoints.getScheduledStopPoint());
    }

    private void parseRoutePoints(RoutePointsInFrame_RelStructure routePoints) {
        if (routePoints == null) return;

        this.routePoints.addAll(routePoints.getRoutePoint());
    }
}