org.opentrafficsim.kpi.sampling

Class Query

java.lang.Object

org.opentrafficsim.kpi.sampling.Query

All Implemented Interfaces:

Identifiable

public final class Query
extends Object
implements Identifiable

A query defines which subset of trajectory information should be included. This is in terms of space-time regions, and in terms of meta data of trajectories, e.g. only include trajectories of trucks.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Sep 21, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
Query(Sampler<?> sampler, String description, MetaDataSet metaDataSet)
Query(Sampler<?> sampler, String description, MetaDataSet metaDataSet, Duration interval)
Query(Sampler<?> sampler, String description, MetaDataSet metaDataSet, Frequency updateFrequency)
Query(Sampler<?> sampler, String description, MetaDataSet metaDataSet, Frequency updateFrequency, Duration interval)
Query(Sampler<?> sampler, String id, String description, MetaDataSet metaDataSet)
Query(Sampler<?> sampler, String id, String description, MetaDataSet metaDataSet, Duration interval)
Query(Sampler<?> sampler, String id, String description, MetaDataSet metaDataSet, Frequency updateFrequency)
Query(Sampler<?> sampler, String id, String description, MetaDataSet metaDataSet, Frequency updateFrequency, Duration interval)

Method Summary

Modifier and Type	Method and Description
void	addSpaceTimeRegion(KpiLaneDirection laneDirection, Length startPosition, Length endPosition, Time startTime, Time endTime) Defines a region in space and time for which this query is valid.
void	addSpaceTimeRegionLink(LinkDataInterface link, KpiGtuDirectionality direction, Length startPosition, Length endPosition, Time startTime, Time endTime) Defines a region in space and time for which this query is valid.
boolean	equals(Object obj)
String	getDescription()
String	getId() return the unique id for the query.
Duration	getInterval()
Iterator<Map.Entry<MetaDataType<?>,Set<?>>>	getMetaDataSetIterator()
Sampler<?>	getSampler()
Iterator<SpaceTimeRegion>	getSpaceTimeIterator()
<T> List<TrajectoryGroup>	getTrajectoryGroups(Time endTime) Returns a list of TrajectoryGroups in accordance with the query.
<T> List<TrajectoryGroup>	getTrajectoryGroups(Time startTime, Time endTime) Returns a list of TrajectoryGroups in accordance with the query.
Frequency	getUpdateFrequency()
int	hashCode()
int	metaDataSize()
int	spaceTimeRegionSize()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Query

public Query(Sampler<?> sampler,
             String id,
             String description,
             MetaDataSet metaDataSet)

Parameters:

sampler - sampler

id - id

description - description

metaDataSet - meta data

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String id,
             String description,
             MetaDataSet metaDataSet,
             Duration interval)

Parameters:

sampler - sampler

id - id

description - description

metaDataSet - meta data

interval - interval to gather statistics over

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String id,
             String description,
             MetaDataSet metaDataSet,
             Frequency updateFrequency)

Parameters:

sampler - sampler

id - id

description - description

metaDataSet - meta data

updateFrequency - update frequency

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String id,
             String description,
             MetaDataSet metaDataSet,
             Frequency updateFrequency,
             Duration interval)

Parameters:

sampler - sampler

id - id

description - description

metaDataSet - meta data

updateFrequency - update frequency

interval - interval to gather statistics over

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String description,
             MetaDataSet metaDataSet)

Parameters:

sampler - sampler

description - description

metaDataSet - meta data

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String description,
             MetaDataSet metaDataSet,
             Duration interval)

Parameters:

sampler - sampler

description - description

metaDataSet - meta data

interval - interval to gather statistics over

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String description,
             MetaDataSet metaDataSet,
             Frequency updateFrequency)

Parameters:

sampler - sampler

description - description

metaDataSet - meta data

updateFrequency - update frequency

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Query

public Query(Sampler<?> sampler,
             String description,
             MetaDataSet metaDataSet,
             Frequency updateFrequency,
             Duration interval)

Parameters:

sampler - sampler

description - description

metaDataSet - meta data

updateFrequency - update frequency

interval - interval to gather statistics over

Throws:

NullPointerException - if sampling, description or metaDataSet is null

Method Detail

getId

public String getId()

return the unique id for the query.

Specified by:

getId in interface Identifiable

Returns:

String; the unique id for the query

getDescription

public String getDescription()

Returns:

description

getUpdateFrequency

public Frequency getUpdateFrequency()

Returns:

updateFrequency.

getInterval

public Duration getInterval()

Returns:

interval.

metaDataSize

public int metaDataSize()

Returns:

number of meta data entries

getMetaDataSetIterator

public Iterator<Map.Entry<MetaDataType<?>,Set<?>>> getMetaDataSetIterator()

Returns:

iterator over meta data entries, removal is not allowed

addSpaceTimeRegionLink

public void addSpaceTimeRegionLink(LinkDataInterface link,
                                   KpiGtuDirectionality direction,
                                   Length startPosition,
                                   Length endPosition,
                                   Time startTime,
                                   Time endTime)

Defines a region in space and time for which this query is valid. All lanes in the link are included.

Parameters:

link - link

direction - direction

startPosition - start position

endPosition - end position

startTime - start time

endTime - end time

addSpaceTimeRegion

public void addSpaceTimeRegion(KpiLaneDirection laneDirection,
                               Length startPosition,
                               Length endPosition,
                               Time startTime,
                               Time endTime)

Defines a region in space and time for which this query is valid.

Parameters:

laneDirection - lane direction

startPosition - start position

endPosition - end position

startTime - start time

endTime - end time

spaceTimeRegionSize

public int spaceTimeRegionSize()

Returns:

number of space-time regions

getSpaceTimeIterator

public Iterator<SpaceTimeRegion> getSpaceTimeIterator()

Returns:

iterator over space-time regions, removal is not allowed

getTrajectoryGroups

public <T> List<TrajectoryGroup> getTrajectoryGroups(Time endTime)

Returns a list of TrajectoryGroups in accordance with the query. Each TrajectoryGroup contains Trajectory objects pertaining to a SpaceTimeRegion from the query. A Trajectory is only included if all the meta data of this query accepts the trajectory. This method uses Time.ZERO as start.

Type Parameters:

T - underlying class of meta data type and its value

Parameters:

endTime - end time of interval to get trajectory groups for

Returns:

list of trajectory groups in accordance with the query

getTrajectoryGroups

public <T> List<TrajectoryGroup> getTrajectoryGroups(Time startTime,
                                                     Time endTime)

Returns a list of TrajectoryGroups in accordance with the query. Each TrajectoryGroup contains Trajectory objects pertaining to a SpaceTimeRegion from the query. A Trajectory is only included if all the meta data of this query accepts the trajectory.

Type Parameters:

T - underlying class of meta data type and its value

Parameters:

startTime - start time of interval to get trajectory groups for

endTime - start time of interval to get trajectory groups for

Returns:

list of trajectory groups in accordance with the query

getSampler

public Sampler<?> getSampler()

Returns:

sampling.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object