Package com.luciad.wms.server

Interface ILcdGXYViewEncoder

All Known Implementing Classes:
TLcdGXYViewGIFEncoder, TLcdGXYViewJPEGEncoder, TLcdGXYViewPNGEncoder, TLcdGXYViewSVGEncoder
public interface ILcdGXYViewEncoder
This interface specifies methods to write a given ILcdGXYView to an OutputStream. The type of encoding is defined by the actual implementation.

Each ILcdGXYViewEncoder has a content type that identifies the encoding approach and that gets advertised in the OGC service capabilities. This is usually the MIME type of the encoded result, but this is not required.

The encoding of the data is performed by the encodeGXYView method. Its return type is used as content type on the HTTP(S) response. This allows implementations to dynamically choose the most appropriate encoding approach and content type for a given ILcdGXYView.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    encodeGXYView(ILcdGXYView aGXYView, OutputStream aOutputStream, ALcdRequestContext aRequestContext)
    Encodes a given ILcdGXYView to the provided OutputStream.
    String
    getContentType()
    Returns a content type that identifies the encoding approach used by this encoder and that gets advertised in the OGC service capabilities.

  • Method Details

    • encodeGXYView

      String encodeGXYView(ILcdGXYView aGXYView, OutputStream aOutputStream, ALcdRequestContext aRequestContext) throws IOException
      Encodes a given ILcdGXYView to the provided OutputStream.
      Parameters:
      aGXYView - the ILcdGXYView to be encoded. You can rely on its getImage method to access the rendered view.
      aOutputStream - the OutputStream to write the encoded view to.
      aRequestContext - an ALcdRequestContext giving access to the request parameters. Can be null.
      Returns:
      the content type used by the encoding. This is set as content type on the HTTP(S) response and cannot be null.
      Throws:
      IOException - if an I/O exception occurs during the encoding
      Since:
      2026.0

    • getContentType

      String getContentType()
      Returns a content type that identifies the encoding approach used by this encoder and that gets advertised in the OGC service capabilities. This is usually the MIME type of the encoded result, but this is not required: it is up to the encodeGXYView method to return the actually used content type for a given ILcdGXYView.
      Returns:
      the content type that identifies the encoding approach used by this encoder