org.opentripplanner.analyst.cluster

Class AnalystClusterRequest

java.lang.Object

org.opentripplanner.analyst.cluster.AnalystClusterRequest

All Implemented Interfaces:

Serializable

public class AnalystClusterRequest
extends Object
implements Serializable

A request sent to an Analyst cluster worker. It has two separate fields for RoutingReqeust or ProfileReqeust to facilitate binding from JSON. Only one of them should be set in a given instance, with the ProfileRequest taking precedence if both are set.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	destinationPointsetId The ID of the destinations pointset
String	directOutputUrl Deprecated.
String	graphId The ID of the graph against which to calculate this request
String	id The id of this particular origin
boolean	includeTimes Should times be included in the results (i.e.
String	jobId The job ID this is associated with
String	outputLocation Where should the job be saved?
ProfileRequest	profileRequest The routing parameters to use for a one-to-many profile request.
int	taskId A unique identifier for this request assigned by the queue/broker system.
String	type The type of this request, provided for compatibility with R5 polymorphic request types.
String	userId The Analyst Cluster user that created this request

Constructor Summary

Constructors

Constructor and Description
AnalystClusterRequest() Used for deserialization from JSON
AnalystClusterRequest(String destinationPointsetId, String graphId, ProfileRequest req) We're now using ProfileRequests for everything (no RoutingRequests for non-transit searches).

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

public final String type

The type of this request, provided for compatibility with R5 polymorphic request types.

See Also:

Constant Field Values

destinationPointsetId

public String destinationPointsetId

The ID of the destinations pointset

userId

public String userId

The Analyst Cluster user that created this request

graphId

public String graphId

The ID of the graph against which to calculate this request

jobId

public String jobId

The job ID this is associated with

id

public String id

The id of this particular origin

directOutputUrl

@Deprecated
public String directOutputUrl

Deprecated.

To where should the result be POSTed

taskId

public int taskId

A unique identifier for this request assigned by the queue/broker system.

outputLocation

public String outputLocation

Where should the job be saved?

profileRequest

public ProfileRequest profileRequest

The routing parameters to use for a one-to-many profile request. Non-profile one-to-many requests are represented by simply setting the time window to zero width, i.e. in profileRequest fromTime == toTime. Non-transit one-to-many requests are represented by setting profileRequest.transitModes to null or empty. In that case only the directModes will be used to reach the destinations on the street.

includeTimes

public boolean includeTimes

Should times be included in the results (i.e. ResultSetWithTimes rather than ResultSet)

Constructor Detail

AnalystClusterRequest

public AnalystClusterRequest(String destinationPointsetId,
                             String graphId,
                             ProfileRequest req)

We're now using ProfileRequests for everything (no RoutingRequests for non-transit searches). An AnalystClusterRequest is a wrapper around a ProfileRequest with some additional settings and context.

AnalystClusterRequest

public AnalystClusterRequest()

Used for deserialization from JSON