Package com.vividsolutions.wms

Class MapImageFormatChooser

  • public class MapImageFormatChooser
extends Object
    A Utility class to select the optimal Map Format based on some preferences.
    Author:
    Chris Hodgson chodgson@refractions.net

    • Field Detail

      • IMAGE_FORMATS

        public static final String[][] IMAGE_FORMATS

    • Constructor Detail

      • MapImageFormatChooser

        public MapImageFormatChooser()
        Creates a new instance of MapImageFormatChooser.

      • MapImageFormatChooser

        public MapImageFormatChooser​(String wmsVersion)
        Creates a new instance of MapImageFormatChooser.

    • Method Detail

      • isKnownFormat

        public static boolean isKnownFormat​(String format)
        Returns true if the specified format is known by the MapFormatChooser, false otherwise. The MapFormatChooser can only reliably select between formats which it knows; it will only return an unknown format if there are no known formats to select from. [UT] changed to accept WMS 1.0 and 1.1.1 image formats
        Parameters:
        format - the format which is in question
        Returns:
        true if the specified format is known by the MapFormatChooser, false otherwise

      • setTransparencyRequired

        public void setTransparencyRequired​(boolean transparencyRequired)
        Sets whether tranparency is required in the image format. If transparency is required it takes priority over lossy compression. However, if no format that supports transparency is available, the next best format will be selected.
        Parameters:
        transparencyRequired - true if the image format chosen needs to support transparency

      • setPreferLossyCompression

        public void setPreferLossyCompression​(boolean useLossy)
        Sets whether lossy compression is preferred over non-lossy compression. Lossy compression would generally only be preferred over a slow connection, and also note that image formats which use lossy compression generally don't support transparency - in this case the transparency requirement takes priority.
        Parameters:
        useLossy - true if lossy compression is preferrable

      • chooseFormat

        public String chooseFormat​(String[] formats)
        Returns a format String from the Array of available formats which best matches the requirements and preferences specified. If there are no image formats available which can be used by the WMS image handling code, then null is returned.
        Parameters:
        formats - the array of available formats to choose from
        Returns:
        the chosen format string from Array of available formats, or null if none of the available formats are known