com.pb.routing.gra.persistentupdate.update

Class SegmentUpdate

java.lang.Object

com.pb.routing.gra.persistentupdate.update.SegmentUpdate

All Implemented Interfaces:

Update, Serializable

public final class SegmentUpdate
extends Object
implements Update

Segment updates are changes applied to a corresponding segment. for a particular segment, you can: exclude the segment, set the speed of the segment or change (increase or decrease) the speed of the segment by a value or percentage.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static SegmentUpdate	buildSegmentExclude(String segmentId, boolean exclude) This method can be used to create a segment update which exclude the specified segment from the route\matrix calculation.
static SegmentUpdate	buildSegmentRoadTypeUpdate(String segmentId, RoadType roadType) This is a roadtype update where you can change the roadType of the segment by specifying the new RoadType.
static SegmentUpdate	buildSegmentSpeedAdjustment(String segmentId, Velocity speedAdjustment) This is a speed update where you define a change in the speed of the segment by specifying the change in Velocity.
static SegmentUpdate	buildSegmentSpeedPercentageUpdate(String segmentId, int percentage) This method can be used to create a segment speed update where you define an increase in the speed of the segment by specifying a percentage, to increase(positive value) or decrease(negative value) the speed.
static SegmentUpdate	buildSegmentSpeedUpdate(String segmentId, Velocity speed) This method can be used to create a segment speed update where you can update speed of the segment by specifying a Velocity
int	getPercentage() Return the speed percentage set for update.
RoadType	getRoadType() Return the roadType set for update.
String	getSegmentId() Returns the segment Id for which the update was created.
Velocity	getSpeed() Return the speed set for update.
Velocity	getSpeedAdjustment() Return the speed adjustment set for update.
boolean	isExclude() Check if the segment is excluded.

Methods inherited from class java.lang.Object

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

Method Detail

buildSegmentExclude

public static SegmentUpdate buildSegmentExclude(String segmentId,
                                                boolean exclude)
                                         throws RoutingException

This method can be used to create a segment update which exclude the specified segment from the route\matrix calculation. To exclude a segment you need to specify the segmentId and set exclude to true in order to exclude the segment.

Parameters:

segmentId - must be a valid segment id in the form a:b.

exclude - Boolean true or false

Returns:

Throws:

RoutingException

buildSegmentSpeedPercentageUpdate

public static SegmentUpdate buildSegmentSpeedPercentageUpdate(String segmentId,
                                                              int percentage)
                                                       throws RoutingException

This method can be used to create a segment speed update where you define an increase in the speed of the segment by specifying a percentage, to increase(positive value) or decrease(negative value) the speed.

Parameters:

segmentId - must be a valid segment id in the form a:b

percentage - integer value must be less than 100, greater than -100 and !=0

Returns:

Throws:

RoutingException

buildSegmentSpeedUpdate

public static SegmentUpdate buildSegmentSpeedUpdate(String segmentId,
                                                    Velocity speed)
                                             throws RoutingException

This method can be used to create a segment speed update where you can update speed of the segment by specifying a Velocity

Parameters:

segmentId - must be a valid segment id in the form a:b

speed - Velocity speed must be greater than 0

Returns:

Throws:

RoutingException

buildSegmentSpeedAdjustment

public static SegmentUpdate buildSegmentSpeedAdjustment(String segmentId,
                                                        Velocity speedAdjustment)
                                                 throws RoutingException

This is a speed update where you define a change in the speed of the segment by specifying the change in Velocity. Speed values can be increased(positive value) or decreases(negative value). The speed adjustment should not result in a negative speed value.

Parameters:

segmentId - must be a valid segment id in the form a:b

speedAdjustment - Velocity speed should not be equal to 0

Returns:

Throws:

RoutingException

buildSegmentRoadTypeUpdate

public static SegmentUpdate buildSegmentRoadTypeUpdate(String segmentId,
                                                       RoadType roadType)
                                                throws RoutingException

This is a roadtype update where you can change the roadType of the segment by specifying the new RoadType.

Parameters:

segmentId - must be a valid segment id in the form a:b

roadType - RoadType

Returns:

Throws:

RoutingException

getSegmentId

public String getSegmentId()

Returns the segment Id for which the update was created.

Returns:

segmentId

isExclude

public boolean isExclude()

Check if the segment is excluded.

Returns:

true or false

getSpeed

public Velocity getSpeed()

Return the speed set for update.

Returns:

Velocity

getSpeedAdjustment

public Velocity getSpeedAdjustment()

Return the speed adjustment set for update.

Returns:

Velocity

getPercentage

public int getPercentage()

Return the speed percentage set for update.

Returns:

integer percentage value.

getRoadType

public RoadType getRoadType()

Return the roadType set for update.

Returns:

RoadType