Package uk.ac.rdg.resc.edal.wms

Class FeatureInfoPoint

java.lang.Object

uk.ac.rdg.resc.edal.wms.FeatureInfoPoint

public class FeatureInfoPoint
extends Object

Class which encapsulates information pertinent to individual points in a GetFeatureInfo request

Author:

Guy Griffiths

Constructor Summary

Constructors

Constructor	Description
FeatureInfoPoint(String layerName, String featureId, HorizontalPosition position, String timeStr, Object value, Properties properties)	Constructs a FeatureInfoPoint

Method Summary

Modifier and Type	Method	Description
String	getFeatureId()
Properties	getFeatureProperties()
String	getLayerName()
HorizontalPosition	getPosition()
String	getTime()
Object	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureInfoPoint

public FeatureInfoPoint(String layerName,
                        String featureId,
                        HorizontalPosition position,
                        String timeStr,
                        Object value,
                        Properties properties)

Constructs a FeatureInfoPoint

Parameters:

layerName - The layer name to be displayed. If no layer name is required (e.g. all features belong to the same layer), this can be null

featureId - The feature ID/name to be displayed. If this is not required (e.g. there is a single feature) this can be null

position - The position at which the feature is located. This is required to sort multiple feature info points and filter by distance to the clicked point

timeStr - The time associated with the feature. This can be null

value - The value of the feature at the clicked point

properties - Any additional properties associated with the feature

Method Detail

getLayerName

public String getLayerName()

Returns:

The layer name to be displayed. If no layer name is required (e.g. all features belong to the same layer), this can be null

getFeatureId

public String getFeatureId()

Returns:

The feature ID/name to be displayed. If this is not required (e.g. there is a single feature) this can be null

getPosition

public HorizontalPosition getPosition()

Returns:

The position at which the feature is located. This is required to sort multiple feature info points and filter by distance to the clicked point

getTime

public String getTime()

Returns:

The time associated with the feature. This can be null

getValue

public Object getValue()

Returns:

The value of the feature at the clicked point

getFeatureProperties

public Properties getFeatureProperties()

Returns:

A set of additional Properties associated with the feature at the clicked point