org.opentripplanner.ext.transmodelapi.model.timetable.TripMetadataType Maven / Gradle / Ivy

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.5.0

package org.opentripplanner.ext.transmodelapi.model.timetable;

import graphql.Scalars;
import graphql.schema.GraphQLFieldDefinition;
import graphql.schema.GraphQLNonNull;
import graphql.schema.GraphQLObjectType;
import org.opentripplanner.ext.transmodelapi.support.GqlUtil;
import org.opentripplanner.routing.api.response.TripSearchMetadata;

public class TripMetadataType {

  private TripMetadataType() {}

  public static GraphQLObjectType create(GqlUtil gqlUtil) {
    return GraphQLObjectType
        .newObject()
        .name("TripSearchData")
        .description("Trips search metadata.")
        .field(GraphQLFieldDefinition
            .newFieldDefinition()
            .name("searchWindowUsed")
            .description(
                    "This is the time window used by the raptor search. The input searchWindow "
                    + "is an optional parameter and is dynamically assigned if not set. OTP might "
                    + "override the value if it is too small or too large. When paging OTP adjusts "
                    + "it to the appropriate size, depending on the number of itineraries found in "
                    + "the current search window. The scaling of the search window ensures faster "
                    + "paging and limits resource usage. The unit is seconds."
            )
            .type(new GraphQLNonNull(Scalars.GraphQLInt))
            .dataFetcher(e -> ((TripSearchMetadata) e.getSource()).searchWindowUsed.toMinutes())
            .build())
        .field(GraphQLFieldDefinition
            .newFieldDefinition()
            .name("nextDateTime")
            .description("This is the suggested search time for the \"next page\" or time "
                + "window. Insert it together with the 'searchWindowUsed' in the "
                + "request to get a new set of trips following in the time-window "
                + "AFTER the current search.")
            .deprecate("Use pageCursor instead")
            .type(gqlUtil.dateTimeScalar)
            .dataFetcher(e -> ((TripSearchMetadata) e.getSource()).nextDateTime.toEpochMilli())
            .build())
        .field(GraphQLFieldDefinition
            .newFieldDefinition()
            .name("prevDateTime")
            .description("This is the suggested search time for the \"previous page\" or "
                + "time-window. Insert it together with the 'searchWindowUsed' in "
                + "the request to get a new set of trips preceding in the "
                + "time-window BEFORE the current search.")
            .deprecate("Use pageCursor instead")
            .type(gqlUtil.dateTimeScalar)
            .dataFetcher(e -> ((TripSearchMetadata) e.getSource()).prevDateTime.toEpochMilli())
            .build())
        .build();
  }
}