Package com.luciad.wmts.server

Interface ILcdWMTSGetLegendGraphicRequestEncoder

All Known Implementing Classes:
TLcdDefaultWMTSGetLegendGraphicEncoder
public interface ILcdWMTSGetLegendGraphicRequestEncoder
Creates and encodes legend graphics to a specific content type. The type of encoding is defined by the actual implementations.
Each ILcdWMTSLegendGraphicRequestEncoder has a content type that identifies the type of data encoded by the implementation. This is usually the MIME - TYPE of the encoded result.
Since:
2022.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    encode(TLcdWMTSGetLegendGraphicRequestContext aWMTSGetLegendGraphicRequestContext, OutputStream aOutputStream)
    Encodes the legend graphic for a given TLcdWMTSGetLegendGraphicRequestContext 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

      boolean encode(TLcdWMTSGetLegendGraphicRequestContext aWMTSGetLegendGraphicRequestContext, OutputStream aOutputStream) throws IOException
      Encodes the legend graphic for a given TLcdWMTSGetLegendGraphicRequestContext and sends it to the given OutputStream.
      Parameters:
      aWMTSGetLegendGraphicRequestContext - a container for all relevant information that might be useful when generating legends.
      aOutputStream - the OutputStream to write the output to.
      Returns:
      True if the encoder can handle this case, false if it does not.
      Throws:
      IOException - for any I/O Exceptions.