org.openstreetmap.josm.io.remotecontrol.handler

Class LoadAndZoomHandler

java.lang.Object

org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler

org.openstreetmap.josm.io.remotecontrol.handler.LoadAndZoomHandler

public class LoadAndZoomHandler
extends RequestHandler

Handler for load_and_zoom and zoom requests.

Since:

3707

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler

RequestHandler.RawURLParseRequestHandler, RequestHandler.RequestHandlerBadRequestException, RequestHandler.RequestHandlerErrorException, RequestHandler.RequestHandlerException, RequestHandler.RequestHandlerForbiddenException

Field Summary

Fields

Modifier and Type	Field and Description
static String	command The remote control command name used to load data and zoom.
static String	command2 The remote control command name used to zoom.
private double	maxlat
private double	maxlon
private double	minlat
private double	minlon
private Set<SimplePrimitiveId>	toSelect

Fields inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler

args, content, contentType, globalConfirmationDefault, globalConfirmationKey, loadInNewLayerDefault, loadInNewLayerKey, myCommand, request, sender

Constructor Summary

Constructors

Constructor and Description
LoadAndZoomHandler()

Method Summary

Modifier and Type	Method and Description
String[]	getMandatoryParams()
String[]	getOptionalParams()
String	getPermissionMessage() Get a specific message to ask the user for permission for the operation requested via remote control.
PermissionPrefWithDefault	getPermissionPref() Get a PermissionPref object containing the name of a special permission preference to individually allow the requested operation and an error message to be displayed when a disabled operation is requested.
String	getUsage()
String[]	getUsageExamples()
String[]	getUsageExamples(String cmd) Returns usage examples for the given command.
protected void	handleRequest() Handle a specific command sent as remote control.
protected void	validateRequest() Validates the request before attempting to perform it.
protected void	zoom(Collection<OsmPrimitive> primitives, Bounds bbox)

Methods inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler

checkMandatoryParams, checkPermission, getContent, getContentType, getRequestParameter, handle, isLoadInNewLayer, parseArgs, setCommand, setSender, setUrl

Methods inherited from class java.lang.Object

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

Field Detail

command

public static final String command

The remote control command name used to load data and zoom.

See Also:

Constant Field Values

command2

public static final String command2

The remote control command name used to zoom.

See Also:

Constant Field Values

minlat

private double minlat

maxlat

private double maxlat

minlon

private double minlon

maxlon

private double maxlon

toSelect

private final Set<SimplePrimitiveId> toSelect

Constructor Detail

LoadAndZoomHandler

public LoadAndZoomHandler()

Method Detail

getPermissionMessage

public String getPermissionMessage()

Description copied from class: RequestHandler

Get a specific message to ask the user for permission for the operation requested via remote control. This message will be displayed to the user if the preference remotecontrol.always-confirm is true.

Specified by:

getPermissionMessage in class RequestHandler

Returns:

the message

getMandatoryParams

public String[] getMandatoryParams()

Specified by:

getMandatoryParams in class RequestHandler

getOptionalParams

public String[] getOptionalParams()

Overrides:

getOptionalParams in class RequestHandler

getUsage

public String getUsage()

Overrides:

getUsage in class RequestHandler

getUsageExamples

public String[] getUsageExamples()

Overrides:

getUsageExamples in class RequestHandler

getUsageExamples

public String[] getUsageExamples(String cmd)

Description copied from class: RequestHandler

Returns usage examples for the given command. To be overriden only my handlers that define several commands.

Overrides:

getUsageExamples in class RequestHandler

Parameters:

cmd - The command asked

Returns:

Usage examples for the given command

handleRequest

protected void handleRequest()
                      throws RequestHandler.RequestHandlerErrorException

Description copied from class: RequestHandler

Handle a specific command sent as remote control. This method of the subclass will do the real work.

Specified by:

handleRequest in class RequestHandler

Throws:

RequestHandler.RequestHandlerErrorException - if an error occurs while processing request

zoom

protected void zoom(Collection<OsmPrimitive> primitives,
                    Bounds bbox)

getPermissionPref

public PermissionPrefWithDefault getPermissionPref()

Description copied from class: RequestHandler

Get a PermissionPref object containing the name of a special permission preference to individually allow the requested operation and an error message to be displayed when a disabled operation is requested. Default is not to check any special preference. Override this in a subclass to define permission preference and error message.

Specified by:

getPermissionPref in class RequestHandler

Returns:

the preference name and error message or null

validateRequest

protected void validateRequest()
                        throws RequestHandler.RequestHandlerBadRequestException

Description copied from class: RequestHandler

Validates the request before attempting to perform it.

Specified by:

validateRequest in class RequestHandler

Throws:

RequestHandler.RequestHandlerBadRequestException - if request is invalid