Class RasterResultParams


  • public class RasterResultParams
    extends java.lang.Object
    The RasterResultParams contains the fields computed by Rasterer.getMapRaster. The MapServer will render the image based on the values for the renderGrid and bounding box specified in this class. This class uses a Builder pattern to manage its arguments and cannot be instantiated directly. Use the Builder class, RasterResultParams.Builder, to create new RasterResultParams objects.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RasterResultParams.Builder
      The RasterResultParams.Builder is used to construct new RasterResultParams instances.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      int depth
      The depth of the chosen images.
      boolean querySuccess
      True if the query was successful.
      double rasterLrLat
      The bounding upper-left, lower-right longitudes and latitudes of the final image.
      double rasterLrLon
      The bounding upper-left, lower-right longitudes and latitudes of the final image.
      double rasterUlLat
      The bounding upper-left, lower-right longitudes and latitudes of the final image.
      double rasterUlLon
      The bounding upper-left, lower-right longitudes and latitudes of the final image.
      java.lang.String[][] renderGrid
      The grid of images to display.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private RasterResultParams()
      Constructor with private access to prevent direct instantiation of a RasterResultParams instance.
      private RasterResultParams​(java.lang.String[][] renderGrid, double rasterUlLon, double rasterUlLat, double rasterLrLon, double rasterLrLat, int depth, boolean querySuccess)  
    • Field Detail

      • renderGrid

        public final java.lang.String[][] renderGrid
        The grid of images to display.
      • rasterUlLon

        public final double rasterUlLon
        The bounding upper-left, lower-right longitudes and latitudes of the final image.
      • rasterUlLat

        public final double rasterUlLat
        The bounding upper-left, lower-right longitudes and latitudes of the final image.
      • rasterLrLon

        public final double rasterLrLon
        The bounding upper-left, lower-right longitudes and latitudes of the final image.
      • rasterLrLat

        public final double rasterLrLat
        The bounding upper-left, lower-right longitudes and latitudes of the final image.
      • depth

        public final int depth
        The depth of the chosen images.
      • querySuccess

        public final boolean querySuccess
        True if the query was successful.
    • Constructor Detail

      • RasterResultParams

        private RasterResultParams()
        Constructor with private access to prevent direct instantiation of a RasterResultParams instance. Use the Builder instead.
      • RasterResultParams

        private RasterResultParams​(java.lang.String[][] renderGrid,
                                   double rasterUlLon,
                                   double rasterUlLat,
                                   double rasterLrLon,
                                   double rasterLrLat,
                                   int depth,
                                   boolean querySuccess)
    • Method Detail

      • queryFailed

        public static RasterResultParams queryFailed()
        Factory method which returns a new RasterResultParams instance representing a failed query.
        Returns:
        A RasterResultParams instance with querySuccess set to false.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object