Class Source

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private static class  Source.ZoomBoundFunction
      A common function for zoom constraints
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String attribution
      The attribution to display for the user
      private Bounds bounds
      The bounds of the data.
      private int maxZoom
      The maximum zoom supported
      private int minZoom
      The minimum zoom supported
      private java.lang.String name
      The name of the source
      private static java.lang.String[] NO_URLS  
      private java.lang.String promoteId
      The property to use as a feature id.
      private Scheme scheme
      The tile scheme
      private SourceType sourceType
      The type of the source
      private int tileSize
      The tile size
      private java.lang.String[] tileUrls
      The tile urls.
      private boolean volatileCache
      true if the tiles should not be cached
      private static java.lang.String WMS_BBOX
      WMS servers should contain a "{bbox-epsg-3857}" parameter for the bbox
      private static java.util.function.IntFunction<java.lang.Integer> ZOOM_BOUND_FUNCTION
      Constrain the min/max zooms to be between 0 and 30, as per tilejson spec
    • Constructor Summary

      Constructors 
      Constructor Description
      Source​(java.lang.String name, jakarta.json.JsonObject data)
      Create a new Source object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      java.lang.String getAttributionText()
      Get the attribution for this source
      Bounds getBounds()
      Get the bounds for this source
      int getMaxZoom()
      Get the max zoom
      int getMinZoom()
      Get the minimum zoom
      java.lang.String getName()
      Get the source name
      java.util.List<java.lang.String> getUrls()
      Get the URLs that can be used to get vector data
      int hashCode()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • WMS_BBOX

        private static final java.lang.String WMS_BBOX
        WMS servers should contain a "{bbox-epsg-3857}" parameter for the bbox
        See Also:
        Constant Field Values
      • NO_URLS

        private static final java.lang.String[] NO_URLS
      • ZOOM_BOUND_FUNCTION

        private static final java.util.function.IntFunction<java.lang.Integer> ZOOM_BOUND_FUNCTION
        Constrain the min/max zooms to be between 0 and 30, as per tilejson spec
      • name

        private final java.lang.String name
        The name of the source
      • minZoom

        private final int minZoom
        The minimum zoom supported
      • maxZoom

        private final int maxZoom
        The maximum zoom supported
      • tileUrls

        private final java.lang.String[] tileUrls
        The tile urls. These usually have replaceable fields.
      • attribution

        private final java.lang.String attribution
        The attribution to display for the user
      • bounds

        private final Bounds bounds
        The bounds of the data. We should not request data outside of the bounds
      • promoteId

        private final java.lang.String promoteId
        The property to use as a feature id. Can be parameterized
      • volatileCache

        private final boolean volatileCache
        true if the tiles should not be cached
      • tileSize

        private final int tileSize
        The tile size
    • Constructor Detail

      • Source

        public Source​(java.lang.String name,
                      jakarta.json.JsonObject data)
        Create a new Source object
        Parameters:
        name - The name of the source object
        data - The data to set the source information with
    • Method Detail

      • getBounds

        public Bounds getBounds()
        Get the bounds for this source
        Returns:
        The bounds where this source can be used
      • getName

        public java.lang.String getName()
        Get the source name
        Returns:
        the name
      • getUrls

        public java.util.List<java.lang.String> getUrls()
        Get the URLs that can be used to get vector data
        Returns:
        The urls
      • getMinZoom

        public int getMinZoom()
        Get the minimum zoom
        Returns:
        The min zoom (default 0)
      • getMaxZoom

        public int getMaxZoom()
        Get the max zoom
        Returns:
        The max zoom (default 22)
      • getAttributionText

        public java.lang.String getAttributionText()
        Get the attribution for this source
        Returns:
        The attribution text. May be null.
      • toString

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

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object