Package org.geotools.swing.tool

Class FeatureLayerHelper

Object

InfoToolHelper

FeatureLayerHelper

All Implemented Interfaces:

EventListener, MapBoundsListener

public class FeatureLayerHelper
extends InfoToolHelper

Helper class used by InfoTool to query vector features in a FeatureLayer.

Since:

2.6

Author:

Michael Bedward

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_DISTANCE_FRACTION	Default distance fraction used with line and point features.

Fields inherited from class InfoToolHelper

contentRef, KEY_POSITION, layerRef

Constructor Summary

Constructors

Constructor	Description
FeatureLayerHelper()	No argument constructor required by the helper lookup system.

Method Summary

Modifier and Type	Method	Description
InfoToolResult	getInfo(Position2D pos)	Gets layer data at the specified position.
boolean	isSupportedLayer(Layer layer)	Called by the helper lookup system when selecting a helper for a given layer.
void	setLayer(Layer layer)	Sets the map layer for this helper.

Methods inherited from class InfoToolHelper

clearTransform, getContentToLayerTransform, getLayer, getMapContent, isTransformRequired, isValid, mapBoundsChanged, setMapContent

Methods inherited from class Object

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

Field Detail

DEFAULT_DISTANCE_FRACTION

public static final double DEFAULT_DISTANCE_FRACTION

Default distance fraction used with line and point features. When the user clicks on the map, this tool searches for features within a rectangle of width w centred on the mouse location, where w is the average map side length multiplied by the value of this constant.

See Also:

Constant Field Values

Constructor Detail

FeatureLayerHelper

public FeatureLayerHelper()

No argument constructor required by the helper lookup system.

Method Detail

setLayer

public void setLayer(Layer layer)

Sets the map layer for this helper. The layer argument must be an instance of FeatureLayer.

Overrides:

setLayer in class InfoToolHelper

Parameters:

layer - the map layer

isSupportedLayer

public boolean isSupportedLayer(Layer layer)

Description copied from class: InfoToolHelper

Called by the helper lookup system when selecting a helper for a given layer.

Specified by:

isSupportedLayer in class InfoToolHelper

Parameters:

layer - the layer

Returns:

true is this helper can handle the layer

getInfo

public InfoToolResult getInfo(Position2D pos)
                       throws Exception

Description copied from class: InfoToolHelper

Gets layer data at the specified position. If there are no feature data at the position, an empty InfoToolResult object is returned.

Specified by:

getInfo in class InfoToolHelper

Parameters:

pos - query position

Returns:

layer data

Throws:

Exception - on error querying the layer