com.supermap.services.components.spi

Interface MapProvider

    • Method Detail

      • getNames

        java.util.List<java.lang.String> getNames()
        

        Gets all the map names corresponding to the current map service provider.

        Returns:
        The list of map names.
      • getMapParameter

        MapParameter getMapParameter(java.lang.String mapName)
        

        Gets the status of a map (the map parameters) after outputting map images last time.

        Parameters:
        mapName - The specified map name.
        Returns:
        Map parameters.
      • clearCache

        void clearCache(java.lang.String mapName,
                      Rectangle2D bounds)
        

        Clears the cache corresponding to a specified area.

        Parameters:
        mapName -
        bounds -
      • getMapImage

        MapImage getMapImage(MapParameter mapParameter,
                           ImageOutputOption outputOption)
        

        Gets map images according to map parameters and image output settings.

        Parameters:
        mapParameter - Map parameters.
        outputOption - Image output settings.
        Returns:
        The map image object.
      • getResource

        java.lang.String getResource(java.lang.String mapName,
                                   ResourceParameter resourceParameter)
        

        Gets the resource image of a specified map according to a resource image parameter.

        Parameters:
        mapName - The map name.
        resourceParameter - The resource image parameter.
        Returns:
        The resource image address.
      • getResource

        byte[] getResource(java.lang.String mapName,
                         ResourceParameter resourceParameter,
                         Point2D[] points)
        

        Gets the resource image of a specified map according to a resource image parameter.

        Parameters:
        mapName - The map name.
        resourceParameter - The resource image parameter.
        points - The points used to draw resource images.
        Returns:
        Binary stream of the image.
      • measureDistance

        MeasureResult measureDistance(java.lang.String mapName,
                                    Point2D[] points,
                                    MeasureParameter measureParam)
        

        Measures distances on a specified map based on 2D geographic coordinates and a measuring parameter.

        Parameters:
        mapName - The map name.
        points - The array of 2D geographic coordinates.
        measureParam - The measuring parameter.
        Returns:
        Measurement result object.
      • measureArea

        MeasureResult measureArea(java.lang.String mapName,
                                Point2D[] points,
                                MeasureParameter measureParam)
        

        Measures areas on a specified map based on 2D geographic coordinates and a measuring parameter.

        Parameters:
        mapName - The map name.
        points - The array of 2D geographic coordinates.
        measureParam - The measuring parameter.
        Returns:
        Measurement result object.
      • queryByDistance

        QueryResult queryByDistance(java.lang.String mapName,
                                  Geometry geometry,
                                  double distance,
                                  QueryParameterSet queryParameterSet)
        

        Queries all the geometric objects on a specified map whose distances to a specified geometry are within a certain value.

        Which means to query all the geometries within a circle whose center is the specified geometry.

        Parameters:
        mapName - The map name.
        geometry - The geometric object.
        distance - The querying distance.
        queryParameterSet - Query parameters can query multiple layers of a map. The query parameters in a single layer can be set in queryParameterSet.queryParams[i] .
        Returns:
        Query result object.
      • queryByGeometry

        QueryResult queryByGeometry(java.lang.String mapName,
                                  Geometry geometry,
                                  SpatialQueryMode spatialQueryMode,
                                  QueryParameterSet queryParameterSet)
        

        Queries geometric objects that satisfy a certain spatial relationship with a specified geometric object and meet query conditions on a specified map.

        Parameters:
        mapName - The map name.
        geometry - The geometric object, which has spatial information and shape information, but no attribute information.
        spatialQueryMode - The spatial query mode, which defines several spatial relationships between geometries, and it allows users to construct filter conditions to perform querying. For example, searching spatial objects which are contained in specified region object, or which have a disjoint or adjacent relationship with the specified region object.
        queryParameterSet - Query parameters can query multiple layers of a map. The query parameters in a single layer can be set in queryParameterSet.queryParams[i] .
        Returns:
        Query result object.
      • queryByBounds

        QueryResult queryByBounds(java.lang.String mapName,
                                Rectangle2D bounds,
                                QueryParameterSet queryParameterSet)
        

        Queries the geometries in the specified range on the map.

        Parameters:
        mapName - The map name.
        bounds - The specified query bounds.
        queryParameters - Query parameters can query multiple layers of a map. The query parameters in a single layer can be set in queryParameters.queryParams[i] .
        Returns:
        Query result object.
      • queryBySQL

        QueryResult queryBySQL(java.lang.String mapName,
                             QueryParameterSet queryParameterSet)
        

        Performs SQL query on specified map.

        Parameters:
        mapName - The map name.
        queryParameterSet - Query parameters can query multiple layers of a map. The query parameters in a single layer can be set in queryParameterSet.queryParams[i] .
        Returns:
        Query result object.
      • setDefaultMapParameter

        MapParameter setDefaultMapParameter(MapParameter mapParameter)
        

        Sets the default map parameters.

        Parameters:
        mapParameter - Map parameters.
        Returns:
        The map parameter object.
      • getDefaultMapParameter

        MapParameter getDefaultMapParameter(java.lang.String mapName)
        

        Gets the default map parameters of the specified map.

        Retrieval of the initial default map parameter depends on the type of the service accessed. For example, if the GIS functions provided by SuperMap Objects Java are accessed, the initial default map parameter is obtained from a workspace file; if the GIS functions of a WMS service are accessed, the default map parameter is determined in the WMS service.

        Parameters:
        mapName - The map name.
        Returns:
        The map parameter object.
      • viewEntire

        MapImage viewEntire(java.lang.String layerName,
                          MapParameter mapParameter,
                          ImageOutputOption outputOption)
        

        Displays a map in the Full Extent mode according to map layer name, map parameters and image output settings.

        The full geographic map extent to display is the minimum circumscribed rectangle of the specified layer.

        Parameters:
        layerName - Layer name, used to determine the full map extent.
        mapParameter - Map parameters.
        outputOption - Image output settings.
        Returns:
        The Map object.
      • getOverview

        Overview getOverview(MapParameter mapParameter,
                           ImageOutputOption outputOption)
        

        Gets eagle-eye map according to map parameters and image output settings.

        Parameters:
        mapParameter - Map parameters.
        outputOption - Image output settings.
        Returns:
        Eagle-eye object.
      • findNearest

        QueryResult findNearest(java.lang.String mapName,
                              Geometry geometry,
                              double maxDistance,
                              QueryParameterSet queryParameterSet)
        

        Queries the nearest geometric object on a specified map whose distance to a specified geometry is within a certain value. When limit the number of returned geometric objects (specified by QueryParameterSet.expectCount), the query result is the expectCount features nearest to the center in the records. There is no orders of expectCount.

        Parameters:
        mapName - The map name.
        geometry - The geometric object.
        maxDistance - The maximum distance, of which the unit is identical with that of the map specified with mapName parameter.
        queryParameterSet - Query parameters can query multiple layers of a map. The query parameters in a single layer can be set in queryParameterSet.queryParams[i] .
        Returns:
        Query result object.
      • support

        boolean support(java.lang.String mapName,
                      MapCapability capability)
        
        Determines whether the map supports the specified function.
        Parameters:
        mapName - The map name.
        capability - Function type.
        Returns:
        true means to support; otherwise, false.
        Since:
        7.0.1
      • getVectorStyle

        VectorStyle getVectorStyle(java.lang.String mapName,
                                 java.lang.String[] layerNames,
                                 VectorStyleType type)
        
        Gets the specified vector layer style in the specified map.
        Parameters:
        mapName - The map name.
        layerNames - The layer name.
        type - The vector style type.
        Returns:
        Vector layer style.
        Since:
        8.0.3
      • updateMap

        boolean updateMap(MapParameter mapParameter)
        
        Updates the map status permanently, which will do a persistence in the disk.
        Parameters:
        mapParameter - The map status to update to.
        Returns:
        Whether the update is successful.