Package com.luciad.wms.server

Interface ILcdWMSGetFeatureInfoRequestEncoder

All Known Implementing Classes:

TLcdWMSGeoJsonGetFeatureInfoEncoder, TLcdWMSHTMLGetFeatureInfoEncoder, TLcdWMSTextPlainGetFeatureInfoEncoder, TLcdWMSXMLGetFeatureInfoEncoder

public interface ILcdWMSGetFeatureInfoRequestEncoder

This interface specifies methods to write given the features of the TLcdGXYLayerSubsetList of ILcdGXYView to a OutputStream.
The type of encoding is defined by the actual implementations.
Each ILcdWMSFeatureInfoRequestEncoder has a contenttype that identifies the type of data encoded by the implementation. This is usual the MIME - TYPE of the encoded result.

Note that there is a similar interface ILcdWMSFeatureInfoRequestEncoder, which is used for the same purpose but doesn't provide access to information related to the current request. This information can be useful while encoding GetFeatureInfo responses.

Method Summary

Modifier and Type	Method	Description
void	encode(ILcdGXYLayerSubsetList aSelectionSublist, OutputStream aOutputStream, ILcdGXYView aGXYView, TLcdWMSRequestContext aWMSRequestContext)	Encodes the given selection in the TLcdGXYLayerSubsetList from a given ILcdGXYView and sends it to the given OutputStream.
String	getContentType()	Returns the content MIME type of the encoder.

Method Details

getContentType

String getContentType()

Returns the content MIME type of the encoder.

Returns:

the MIME-type as String.

encode

void encode(ILcdGXYLayerSubsetList aSelectionSublist,
 OutputStream aOutputStream,
 ILcdGXYView aGXYView,
 TLcdWMSRequestContext aWMSRequestContext)
     throws jakarta.servlet.ServletException

Encodes the given selection in the TLcdGXYLayerSubsetList from a given ILcdGXYView and sends it to the given OutputStream.

Parameters:

aSelectionSublist - a TLcdGXYLayerSubsetList containing the selection to be encoded.

aOutputStream - the OutputStream to write the output to.

aGXYView - the ILcdGXYView in which the elements are selected .

aWMSRequestContext - a container for the original request and other related request parameters.

Throws:

jakarta.servlet.ServletException - for writing and sending exceptions.