com.supermap.services.providers

Class RestSpatialAnalystProvider

    • Constructor Detail

      • RestSpatialAnalystProvider

        public RestSpatialAnalystProvider()

        The constructor.

      • RestSpatialAnalystProvider

        public RestSpatialAnalystProvider(RestSpatialAnalystProviderSetting setting)

        The constructor.

        Parameters:
        setting - The parameter object for setting Rest spatial analysis service provider.

    • Method Detail

      • getDatasetNames

        public java.util.List<java.lang.String> getDatasetNames(java.lang.String datasourceName)
        Description copied from interface: SpatialAnalystProvider

        Gets the list of dataset names in a specified datasource.

        Specified by:
        getDatasetNames in interface SpatialAnalystProvider
        Parameters:
        datasourceName - The name of the datasource.
        Returns:
        The list of dataset names.

      • getDatasetInfo

        public DatasetInfo getDatasetInfo(java.lang.String datasourceName,
                         java.lang.String datasetName)
        Description copied from interface: SpatialAnalystProvider

        Gets information about a specified dataset in a datasource.

        Specified by:
        getDatasetInfo in interface SpatialAnalystProvider
        Parameters:
        datasourceName - The name of the datasource.
        datasetName - The dataset name.
        Returns:
        The dataset information.

      • deleteDataset

        public boolean deleteDataset(java.lang.String datasourceName,
                    java.lang.String datasetName)
        Description copied from interface: SpatialAnalystProvider

        Deletes the result dataset created after the analysis.

        Specified by:
        deleteDataset in interface SpatialAnalystProvider
        Parameters:
        datasourceName - The name of the datasource which includes the analysis results.
        datasetName - The dataset name of the analysis results.
        Returns:
        True, if successful; Otherwise false.

      • buffer

        public GeometrySpatialAnalystResult buffer(Geometry geometry,
                                  BufferAnalystParameter bufferAnalystparameter,
                                  GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Creates a buffer for a geometric object and returns a region object if the creation is successful; otherwise null is returned.

        Specified by:
        buffer in interface SpatialAnalystProvider
        Parameters:
        geometry - Geometric object needed to create buffer.
        bufferAnalystparameter - The buffer analysis parameter. Required. It is used to specify information needed to perform a buffer analysis, such as the buffer distance, the endpoint type of the buffer, etc. Please see BufferAnalystParameter class.
        resultSetting - The buffer analysis result setting.
        Returns:
        Returns the created buffer polygon object if successful, and returns a null value if it fails.

      • buffer

        public DatasetSpatialAnalystResult buffer(java.lang.String dataset,
                                 QueryParameter filterQueryParameter,
                                 BufferAnalystParameter bufferAnalystParameter,
                                 BufferResultSetting setting)
        Description copied from interface: SpatialAnalystProvider

        Creates buffer based on dataset.

        Specified by:
        buffer in interface SpatialAnalystProvider
        Parameters:
        dataset - Dataset identifier.
        filterQueryParameter - The filter parameter. Optional. With this parameter set, buffers will be created only for the objects that meet the filter condition.
        bufferAnalystParameter - The buffer analysis parameter. Required. It is used to specify information needed to perform a buffer analysis, such as the buffer distance, the endpoint type of the buffer, etc. Please see BufferAnalystParameter class.
        Returns:
        The buffer analysis result.

      • erase

        public DatasetSpatialAnalystResult erase(java.lang.String sourceDataset,
                                QueryParameter sourceDatasetFilter,
                                java.lang.String operateDataset,
                                QueryParameter operateDatasetFilter,
                                DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs an erase operation on two datasets.

        Specified by:
        erase in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The identifier of the dataset to be erased (the first dataset). The type of this dataset can be any of the following: point, line, or region.
        sourceDatasetFilter - The filter query parameter for the first dataset. It can be null.
        operateDataset - The identifier of the dataset used for erasing (the second dataset). It must be the region type.
        operateDatasetFilter - The filter query parameter for the second dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The erase analysis result.

      • erase

        public DatasetSpatialAnalystResult erase(java.lang.String sourceDataset,
                                QueryParameter sourceDatasetFilter,
                                Geometry[] operateGeometries,
                                DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the erase operation on a dataset by using specified region objects to implement an overlay analysis on a dataset and geometric objects.

        Specified by:
        erase in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The identifier of the dataset to be erased (the first dataset). The type of this dataset can be any of the following: point, line, or region.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateGeometries - The identifier of the dataset used for erasing (the second dataset). It must be the region type.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • erase

        public GeometrySpatialAnalystResult erase(Geometry sourceGeometry,
                                 Geometry operateGeometry,
                                 GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the erase operation on two geometric objects to implement an overlay analysis on two geometric objects.

        Specified by:
        erase in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The geometric object to be erased. Its type can be point, line, or region.
        operateGeometry - The Geometry used for erasing. It must be of the region type.
        resultSetting - The result setting for spatial analysis on geometric objects.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • identity

        public DatasetSpatialAnalystResult identity(java.lang.String sourceDataset,
                                   QueryParameter sourceDatasetFilter,
                                   java.lang.String operateDataset,
                                   QueryParameter operateDatasetFilter,
                                   DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the identity overlay operation on datasets, generating a dataset with all objects in the source dataset and objects resulted from intersecting the two datasets.

        Specified by:
        identity in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The identifier of the dataset to be operated on (the first dataset). The type of this dataset can be any of the following: point, line, or region.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The ID of the operating dataset (the second dataset). It must be of the region type.
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • identity

        public DatasetSpatialAnalystResult identity(java.lang.String sourceDataset,
                                   QueryParameter sourceDatasetFilter,
                                   Geometry[] operateGeometries,
                                   DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the identity operation on a dataset using specified region objects, implementing an overlay analysis on a dataset and geometric objects.

        Specified by:
        identity in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The identifier of the dataset to be operated on (the first dataset). The type of this dataset can be any of the following: point, line, or region.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateGeometries - The ID of the operating dataset (the second dataset). It must be the region type.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • identity

        public GeometrySpatialAnalystResult identity(Geometry sourceGeometry,
                                    Geometry operateGeometry,
                                    GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the identity operation with a source geometric object and an operating geometric object to implement an overlay analysis on two geometric objects.

        Specified by:
        identity in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The geometric object to be operated. Its type can be point, line, or region.
        operateGeometry - The Geometry used for identity operation. It must be of the region type.
        resultSetting - The result setting for spatial analysis on geometric objects.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • intersect

        public DatasetSpatialAnalystResult intersect(java.lang.String sourceDataset,
                                    QueryParameter sourceDatasetFilter,
                                    java.lang.String operateDataset,
                                    QueryParameter operateDatasetFilter,
                                    DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the intersect overlay operation on datasets, with the objects generated from intersecting the two datasets retained in the result dataset.

        Specified by:
        intersect in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The identifier of the dataset to be operated on (the first dataset). The type of this dataset can be any of the following: point, line, or region.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The ID of the operating dataset (the second dataset). It must be of the region type.
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • intersect

        public DatasetSpatialAnalystResult intersect(java.lang.String sourceDataset,
                                    QueryParameter sourceDatasetFilter,
                                    Geometry[] operateGeometries,
                                    DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the intersect overlay operation on a dataset and geometric objects, with the objects generated from intersecting the dataset and the operating objects retained in the result dataset.

        Specified by:
        intersect in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The identifier of the dataset to be operated on (the first dataset). The type of this dataset can be any of the following: point, line, or region.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateGeometries - The ID of the operating dataset (the second dataset). It must be the region type.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • intersect

        public GeometrySpatialAnalystResult intersect(Geometry sourceGeometry,
                                     Geometry operateGeometry,
                                     GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the intersect overlay operation on two geometric objects, with the objects generated from intersecting the two datasets retained in the result dataset.

        Specified by:
        intersect in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The operating geometric object. It must be of the region type.
        operateGeometry - The Geometry used for identity operation. It must be of the region type.
        resultSetting - The result setting for spatial analysis on geometric objects.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • union

        public DatasetSpatialAnalystResult union(java.lang.String sourceDataset,
                                QueryParameter sourceDatasetFilter,
                                java.lang.String operateDataset,
                                QueryParameter operateDatasetFilter,
                                DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the union overlay operation on two region datasets, with all the objects from the operated dataset and the operating dataset retained in the result dataset. The intersect and split operations are also performed on the intersected parts during the process.

        Specified by:
        union in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The dataset to be operated on. It must be of the region type.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The ID of the operating dataset (the second dataset). It must be of the region type.
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • union

        public DatasetSpatialAnalystResult union(java.lang.String sourceDataset,
                                QueryParameter sourceDatasetFilter,
                                Geometry[] operateGeometries,
                                DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the union overlay operation on a dataset and geometric objects, with all the objects from the operated dataset and the operating geometric objects retained in the result dataset.The intersect and split operations are also performed on the intersected parts during the process.

        Specified by:
        union in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The dataset to be operated on. It must be of the region type.
        sourceDatasetFilter - The filter parameter for querying the source dataset.
        operateGeometries - The operate geometric objects.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result.

      • union

        public GeometrySpatialAnalystResult union(Geometry sourceGeometry,
                                 Geometry operateGeometry,
                                 GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the union overlay operation on two region objects, with all the objects from the operated object and the operating object retained in the result dataset.The intersect and split operations are also performed on the intersected parts during the process.

        Specified by:
        union in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The operating geometric object. It must be of the region type.
        operateGeometry - The Geometry used for identity operation. It must be of the region type.
        resultSetting - The result setting for spatial analysis on geometric objects.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • update

        public DatasetSpatialAnalystResult update(java.lang.String sourceDataset,
                                 QueryParameter sourceDatasetFilter,
                                 java.lang.String operateDataset,
                                 QueryParameter operateDatasetFilter,
                                 DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the update overlay operation on two region datasets, replacing the source dataset with the operating dataset at places where the two overlap.It is accomplished by an erasing process followed by a pasting process.

        Specified by:
        update in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The dataset to be operated on. It must be of the region type.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The ID of the operating dataset (the second dataset). It must be of the region type.
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • update

        public DatasetSpatialAnalystResult update(java.lang.String sourceDataset,
                                 QueryParameter sourceDatasetFilter,
                                 Geometry[] operateGeometries,
                                 DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the update overlay operation on a dataset using region geometric objects, implementing an overlay analysis on a dataset and region objects.

        Specified by:
        update in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The dataset to be operated on. It must be of the region type.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateGeometries - The operating geometric objects. They must be of the region type.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • update

        public GeometrySpatialAnalystResult update(Geometry sourceGeometry,
                                  Geometry operateGeometry,
                                  GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the update overlay operation on two region geometric objects, implementing an overlay analysis on geometric objects.

        Specified by:
        update in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The operating geometric object. It must be of the region type.
        operateGeometry - The Geometry used for identity operation. It must be of the region type.
        resultSetting - The result setting for spatial analysis on geometric objects.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • clip

        public DatasetSpatialAnalystResult clip(java.lang.String sourceDataset,
                               QueryParameter sourceDatasetFilter,
                               java.lang.String operateDataset,
                               QueryParameter operateDatasetFilter,
                               DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs a clip operation by using two datasets.

        Specified by:
        clip in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The ID of the dataset to be clipped (the first dataset). It can be of the point, line, or region type.
        sourceDatasetFilter - The filter query parameter for the first dataset. It can be null.
        operateDataset - The identifier of the dataset that is used to clip (the second dataset). The type of this dataset must be region.
        operateDatasetFilter - The filter query parameter for the second dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • getRelativePosition3D

        public SpatialQuery3DResult getRelativePosition3D(java.lang.String sourceDataset,
                                         QueryParameter sourceDatasetFilter,
                                         java.lang.String operateDataset,
                                         QueryParameter operateDatasetFilter,
                                         DatasetSpatialQuery3DResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Analyzes the spatial relationship between two model data by performing 3D spatial queries on source dataset and operating dataset.

        Specified by:
        getRelativePosition3D in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The source dataset identifier (also known as the first dataset). The type is model dataset.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The target dataset identifier (also known as the second dataset). The type is model dataset. When setting the fields of result dataset, if both the sourceDataset and operateDataset have the same field such as "Code", the result dataset will save the "Code" field from sourceDataset as "Code_1" and save the "Code" from the operateDataset as "Code_2" automatically .
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - 3D spatial analysis result settings.
        Returns:
        Spatial analysis query result .

      • getRelativePosition3D

        public SpatialQuery3DResult getRelativePosition3D(java.lang.String sourceDataset,
                                         QueryParameter sourceDatasetFilter,
                                         Geometry operateGeometry,
                                         double bottomAltitude,
                                         double extendedHeight,
                                         DatasetSpatialQuery3DResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Analyzes the spatial relationship between two model data by performing 3D spatial queries on source dataset and operating dataset.

        Specified by:
        getRelativePosition3D in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The source dataset identifier (also known as the first dataset). The type is model dataset.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateGeometry - The geometric object used for 3D spatial analysis.
        resultSetting - 3D spatial analysis result settings.
        Returns:
        Spatial analysis query result .

      • spatialQuery3D

        public SpatialQuery3DResult spatialQuery3D(java.lang.String sourceDataset,
                                  QueryParameter sourceDatasetFilter,
                                  java.lang.String operateDataset,
                                  QueryParameter operateDatasetFilter,
                                  PositionMode posMode,
                                  DatasetSpatialQuery3DResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Analyzes the spatial relationship between two model data by performing 3D spatial queries on source dataset and operating dataset.

        Specified by:
        spatialQuery3D in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The source dataset identifier (also known as the first dataset). The type is model dataset.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The target dataset identifier (also known as the second dataset). The type is model dataset. When setting the fields of result dataset, if both the sourceDataset and operateDataset have the same field such as "Code", the result dataset will save the "Code" field from sourceDataset as "Code_1" and save the "Code" from the operateDataset as "Code_2" automatically .
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - 3D spatial analysis result settings.
        Returns:
        Spatial analysis query result .

      • spatialQuery3D

        public SpatialQuery3DResult spatialQuery3D(java.lang.String sourceDataset,
                                  QueryParameter sourceDatasetFilter,
                                  Geometry operateGeometry,
                                  double bottomAltitude,
                                  double extendedHeight,
                                  PositionMode posMode,
                                  DatasetSpatialQuery3DResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Analyzes the spatial relationship between two model data by performing 3D spatial queries on source dataset and operating dataset.

        Specified by:
        spatialQuery3D in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The source dataset identifier (also known as the first dataset). The type is model dataset.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        resultSetting - 3D spatial analysis result settings.
        Returns:
        Spatial analysis query result .

      • clip

        public DatasetSpatialAnalystResult clip(java.lang.String sourceDataset,
                               QueryParameter sourceDatasetFilter,
                               Geometry[] operateGeometries,
                               DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs a clip operation to a dataset by using specified region objects.

        Specified by:
        clip in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The ID of the dataset to be clipped (the first dataset). It can be of the point, line, or region type.
        sourceDatasetFilter - The filter query parameter for the first dataset. It can be null.
        operateGeometries - The array of the region objects that are used to clip.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • clip

        public GeometrySpatialAnalystResult clip(Geometry sourceGeometry,
                                Geometry operateGeometry,
                                GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs a clip operation by using two Geometry objects.

        Specified by:
        clip in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The Geometry object to be clipped. Its type can be either line or area.
        operateGeometry - The Geometry object that is used to clip. Its type must be region.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • xor

        public DatasetSpatialAnalystResult xor(java.lang.String sourceDataset,
                              QueryParameter sourceDatasetFilter,
                              java.lang.String operateDataset,
                              QueryParameter operateDatasetFilter,
                              DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the xor operation, i.e., the Exclusive Or operation, on two region datasets, implementing an overlay analysis on two datasets.

        Specified by:
        xor in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The dataset to be operated on. It must be of the region type.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateDataset - The ID of the operating dataset. It must be of the region type.
        operateDatasetFilter - The filter parameter for querying the operating dataset. It can be null.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source dataset.

      • xor

        public DatasetSpatialAnalystResult xor(java.lang.String sourceDataset,
                              QueryParameter sourceDatasetFilter,
                              Geometry[] operateGeometries,
                              DatasetOverlayResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the xor operation, i.e., the Exclusive Or operation, on a dataset using region geometric objects, implementing an overlay analysis on a dataset and geometric objects.

        Specified by:
        xor in interface SpatialAnalystProvider
        Parameters:
        sourceDataset - The dataset to be operated on. It must be of the region type.
        sourceDatasetFilter - The filter query parameter for the source dataset. It can be null.
        operateGeometries - The operating geometric objects. They must be of the region type.
        resultSetting - The result setting for overlay analysis on datasets.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • xor

        public GeometrySpatialAnalystResult xor(Geometry sourceGeometry,
                               Geometry operateGeometry,
                               GeometrySpatialAnalystResultSetting resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Performs the xor operation, i.e., the Exclusive Or operation, on two geometric objects, implementing an overlay analysis on two geometric objects.

        Specified by:
        xor in interface SpatialAnalystProvider
        Parameters:
        sourceGeometry - The operating geometric object. It must be of the region type.
        operateGeometry - The Geometry used for identity operation. It must be of the region type.
        resultSetting - The result setting for spatial analysis on geometric objects.
        Returns:
        The overlay analysis result dataset, whose attribute table structure is the same as that of the source geometric object.

      • extractIsoline

        public DatasetSpatialAnalystResult extractIsoline(java.lang.String pointDataset,
                                         QueryParameter filterQueryParameter,
                                         java.lang.String zValueField,
                                         double resolution,
                                         ExtractParameter parameter,
                                         DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Extracts isolines from a point dataset. The implementation principle of this method is to perform interpolation on the point dataset first and obtain a raster dataset (the intermediate result of the implementation). Then isolines are extracted from the raster dataset.

        Specified by:
        extractIsoline in interface SpatialAnalystProvider
        Parameters:
        pointDataset - The identifier of the point dataset for this analysis (datasetName@datasourceName).
        zValueField - The name of the elevation field.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter for extracting isolines. Required. It is used to set the smoothness, the resampling interval, etc. Please see ExtractParameter class.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoline

        public DatasetSpatialAnalystResult extractIsoline(java.lang.String pointDataset,
                                         QueryParameter filterQueryParameter,
                                         java.lang.String zValueField,
                                         double resolution,
                                         ExtractParameter parameter,
                                         DataReturnOption resultSetting,
                                         InterpolateType terrainInterpolateType)
        Description copied from interface: SpatialAnalystProvider

        Extracts isolines from a point dataset. The implementation principle of this method is to perform interpolation on the point dataset first and obtain a raster dataset (the intermediate result of the implementation). Then isolines are extracted from the raster dataset.

        Specified by:
        extractIsoline in interface SpatialAnalystProvider
        Parameters:
        pointDataset - The identifier of the point dataset for this analysis (datasetName@datasourceName).
        zValueField - The name of the elevation field.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter for extracting isolines. Required. It is used to set the smoothness, the resampling interval, etc. Please see ExtractParameter class.
        terrainInterpolateType - Interpolation analysis method.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoline

        public DatasetSpatialAnalystResult extractIsoline(java.lang.String gridDataset,
                                         ExtractParameter parameter,
                                         DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Extracts the isolines from the grid dataset.

        Specified by:
        extractIsoline in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The identifier of the raster dataset for this analysis.
        parameter - The parameter for extracting isolines. Required. It is used to set the smoothness, the resampling interval, etc. Please see ExtractParameter class.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoline

        public DatasetSpatialAnalystResult extractIsoline(Point2D[] points,
                                         double[] zValues,
                                         double resolution,
                                         ExtractParameter parameter,
                                         DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Extracts isolines from a 3D point set. The implementation principle of this method is to first perform an interpolation analysis on the points using the 3rd dimension information, such as elevation and temperature, aside from the coordinate data stored in the point set. A raster dataset (an intermediate result dataset) is obtained. Isolines are then extracted from the raster dataset.

        Specified by:
        extractIsoline in interface SpatialAnalystProvider
        Parameters:
        points - The array of the points for analyzing.
        zValues - The array of Z values of the points. This array must have the same length with the length of the points array.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter object for surface analysis. Please see ExtractParameter class.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoline

        public DatasetSpatialAnalystResult extractIsoline(Point2D[] points,
                                         double[] zValues,
                                         double resolution,
                                         ExtractParameter parameter,
                                         DataReturnOption resultSetting,
                                         InterpolateType terrainInterpolateType)
        Description copied from interface: SpatialAnalystProvider

        Extracts isolines from a 3D point set. The implementation principle of this method is to first perform an interpolation analysis on the points using the 3rd dimension information, such as elevation and temperature, aside from the coordinate data stored in the point set. A raster dataset (an intermediate result dataset) is obtained. Isolines are then extracted from the raster dataset.

        Specified by:
        extractIsoline in interface SpatialAnalystProvider
        Parameters:
        points - The array of the points for analyzing.
        zValues - The array of Z values of the points. This array must have the same length with the length of the points array.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter object for surface analysis. Please see ExtractParameter class.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        terrainInterpolateType - Interpolation analysis method.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoregion

        public DatasetSpatialAnalystResult extractIsoregion(java.lang.String pointDataset,
                                           QueryParameter filterQueryParameter,
                                           java.lang.String zValueField,
                                           double resolution,
                                           ExtractParameter parameter,
                                           DataReturnOption resultSetting,
                                           InterpolateType terrainInterpolateType)
        Description copied from interface: SpatialAnalystProvider

        Extracts isoregions from a point dataset. The implementation principle of this method is to first perform interpolation on the point dataset and obtain a raster dataset (the intermediate result of the implementation). Then isoregions are extracted from the raster dataset.

        Specified by:
        extractIsoregion in interface SpatialAnalystProvider
        Parameters:
        pointDataset - The identifier of the point dataset for this analysis (datasetName@datasourceName).
        zValueField - The name of the elevation field.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter for extracting isoregions. Required. It is used to set the smoothness, the resampling interval, etc. Please see ExtractParameter class.
        terrainInterpolateType - Interpolation analysis method.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoregion

        public DatasetSpatialAnalystResult extractIsoregion(java.lang.String pointDataset,
                                           QueryParameter filterQueryParameter,
                                           java.lang.String zValueField,
                                           double resolution,
                                           ExtractParameter parameter,
                                           DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Extracts isoregions from a point dataset. The implementation principle of this method is to first perform interpolation on the point dataset and obtain a raster dataset (the intermediate result of the implementation). Then isoregions are extracted from the raster dataset.

        Specified by:
        extractIsoregion in interface SpatialAnalystProvider
        Parameters:
        pointDataset - The identifier of the point dataset for this analysis (datasetName@datasourceName).
        zValueField - The name of the elevation field.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter for extracting isoregions. Required. It is used to set the smoothness, the resampling interval, etc. Please see ExtractParameter class.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoregion

        public DatasetSpatialAnalystResult extractIsoregion(java.lang.String gridDataset,
                                           ExtractParameter parameter,
                                           DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Extracts isoregions from a raster dataset.

        Specified by:
        extractIsoregion in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The identifier of the raster dataset for this analysis.
        parameter - The parameter for extracting isoregions. Required. It is used to set the smoothness, the resampling interval, etc. Please see ExtractParameter class.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoregion

        public DatasetSpatialAnalystResult extractIsoregion(Point2D[] points,
                                           double[] zValues,
                                           double resolution,
                                           ExtractParameter parameter,
                                           DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Extracts isoregions from a 3D point set. The implementation principle of this method is to first perform an interpolation analysis on the points using the 3rd dimension information, such as elevation and temperature, aside from the coordinate data stored in the point set. A raster dataset (an intermediate result dataset) is obtained. Isoregions are then extracted from the raster dataset.

        Specified by:
        extractIsoregion in interface SpatialAnalystProvider
        Parameters:
        points - The array of the points for analyzing.
        zValues - The array of Z values of the points. This array must have the same length with the length of the points array.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter object for surface analysis. Please see ExtractParameter class.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • extractIsoregion

        public DatasetSpatialAnalystResult extractIsoregion(Point2D[] points,
                                           double[] zValues,
                                           double resolution,
                                           ExtractParameter parameter,
                                           DataReturnOption resultSetting,
                                           InterpolateType terrainInterpolateType)
        Description copied from interface: SpatialAnalystProvider

        Extracts isoregions from a 3D point set. The implementation principle of this method is to first perform an interpolation analysis on the points using the 3rd dimension information, such as elevation and temperature, aside from the coordinate data stored in the point set. A raster dataset (an intermediate result dataset) is obtained. Isoregions are then extracted from the raster dataset.

        Specified by:
        extractIsoregion in interface SpatialAnalystProvider
        Parameters:
        points - The array of the points for analyzing.
        zValues - The array of Z values of the points. This array must have the same length with the length of the points array.
        resolution - The resolution of the intermediate raster dataset.
        parameter - The parameter object for surface analysis. Please see ExtractParameter class.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        terrainInterpolateType - Interpolation analysis method.
        Returns:
        Returns the information according to the result setting for surface analysis.

      • interpolate

        public InterpolationResult interpolate(InterpolationParameter interpolationParameter)
        Description copied from interface: SpatialAnalystProvider

        Used to gets raster dataset by performing interpolation analysis on discrete point data. Interpolation analysis can forecast the values around the sampling points and know the whole distribution of the data in the target region, the sampling points don’t only reflect the values of themselves, but the whole region.

        Specified by:
        interpolate in interface SpatialAnalystProvider
        Parameters:
        interpolationParameter - The interpolation parameter object. Please see InterpolationParameter class.
        Returns:
        Returns the raster dataset resulted from the interpolation analysis.

      • generateSpatialData

        public DatasetSpatialAnalystResult generateSpatialData(GenerateSpatialDataParameter generateSpatialDataParameter,
                                              DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Executes the dynamic segmentation.

        The general process of dynamic segmentation is:

        1. Prepare the route dataset and event table
        2. Recreate the dynamic segmentation result according to the route dataseta and event table, namely, a spatial dataset
        3. Display the spatial data on client side
        Specified by:
        generateSpatialData in interface SpatialAnalystProvider
        Parameters:
        generateSpatialDataParameter - The parameter for dynamic segmentation function, including route dataset name, route identifier field, event table dataset name, route identifier field in event table dataset, scale field of point event table, start and end scale field of line event table, offset field, error information field, etc.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        The dynamic segmentation result, namely, a spatial dataset.

      • calculateAspect

        public DatasetSpatialAnalystResult calculateAspect(java.lang.String gridDataset,
                                          TerrainAnalystSetting terrainAnalystSetting,
                                          DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Calculates aspect, and returns the aspect grid dataset, i.e., aspect map.

        Aspect is the direction a slope faces. It is the steepest downslope direction at a certain location on terrain surface. Slope aspect is measured in degrees. It ranges from 0 (the north direction) to 360 degrees with the clockwise direction as the positive direction.

        Specified by:
        calculateAspect in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The identifier of the raster dataset for aspect analysis.
        terrainAnalystSetting - The environment setting of terrain analysis.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        Returns the result information of aspect analysis.

      • calculateCurvature

        public java.util.List<DatasetSpatialAnalystResult> calculateCurvature(java.lang.String gridDataset,
                                                             double zFactor,
                                                             java.lang.String profileCurvatureName,
                                                             java.lang.String planCurvatureName,
                                                             DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Calculates the curvature.

        Specified by:
        calculateCurvature in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The grid dataset identifiers of slope analysis.
        zFactor - The specified elevation scale factor. The z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. For example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). In general, z-factor is used for a calculation involves x,y,z. The default value is 1, which means the x,y and z units are in the same units of measure.
        profileCurvatureName - The name of the output profile curvature dataset.
        planCurvatureName - The name of the output plane curvature dataset.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        The curvature calculation result.

      • calculateSlope

        public DatasetSpatialAnalystResult calculateSlope(java.lang.String gridDataset,
                                         TerrainAnalystSetting terrainAnalystSetting,
                                         SlopeType slopeType,
                                         double zFactor,
                                         DataReturnOption resultSetting)
        Description copied from interface: SpatialAnalystProvider

        Calculates slope, and returns the slope grid dataset, i.e., slope map.

        Slope is the included angle formed by the tangent surface of a point on Earth and the horizontal surface. Every cell in a slope map has a slope value. A greater slope indicates steeper terrain. Slope can be measured in degrees, radians, or percentages. It is used to calculate the average slope values of the cell surfaces in a grid dataset. The values in the calculation result range from 0 to 90 degrees.

        Specified by:
        calculateSlope in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The identifier of the raster dataset for slope analysis.
        terrainAnalystSetting - The environment setting of terrain analysis.
        slopeType - The unit type of the specified slope. The default angle is DEGREE.
        zFactor - The specified elevation scale factor. The z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. For example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). In general, z-factor is used for a calculation involves x,y,z. The default value is 1, which means the x,y and z units are in the same units of measure.
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        Returns:
        Returns the result information of slope analysis.

      • computeSurfaceArea

        public double computeSurfaceArea(java.lang.String gridDataset,
                        Geometry region)
        Description copied from interface: SpatialAnalystProvider

        Surface area calculation. It calculates the total surface area of a 3D curved surface within a selected polygon region. The curved surface is simulated by a grid dataset.

        Specified by:
        computeSurfaceArea in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The raster dataset identifier used to calculate the surface area.
        region - The polygon used to calculate the surface area.
        Returns:
        Surface area calculation result.

      • computeSurfaceDistance

        public double computeSurfaceDistance(java.lang.String gridDataset,
                            Geometry line)
        Description copied from interface: SpatialAnalystProvider

        Calculates surface distance. It is used to calculate curved surface distance along specified line segments or polyline segments on a 3D curved surface simulated by a grid dataset.

        Specified by:
        computeSurfaceDistance in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The raster dataset identifier used to calculate the surface area.
        line - The 2D line used to calculate the surface distance.
        Returns:
        Surface area calculation result.

      • calculateProfile

        public ProfileResult calculateProfile(java.lang.String gridDataset,
                             Geometry line,
                             double resampleTolerance)
        Description copied from interface: SpatialAnalystProvider

        Analyzes the profile for a grid dataset.

        Specified by:
        calculateProfile in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The specified grid dataset for profile analysis.
        line - The specified start and end range for the profile. It is a line.
        resampleTolerance - The specified tolerance for resampling.
        Returns:
        The profile analysis result.

      • calculateProfile

        public ProfileResult calculateProfile(java.lang.String gridDataset,
                             java.lang.String lineDataset,
                             double resampleTolerance)
        Description copied from interface: SpatialAnalystProvider

        Analyzes the profile for a grid dataset.

        Specified by:
        calculateProfile in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The specified grid dataset for profile analysis.
        lineDataset - The specified dataset to calculate the aspect. It is a line dataset.
        resampleTolerance - The specified tolerance for resampling.
        Returns:
        The profile analysis result.

      • calculatePlumbProfile

        public DatasetSpatialAnalystResult calculatePlumbProfile(Point2D startPoint,
                                                Point2D endPoint,
                                                java.lang.String[] modelDatasets,
                                                java.lang.String surfaceGrid,
                                                boolean returnRecordsetOrDataset)
        Description copied from interface: SpatialAnalystProvider

        Performs the profile analysis for the terrain or model according to the specified profile line.

        Specified by:
        calculatePlumbProfile in interface SpatialAnalystProvider
        Parameters:
        startPoint - The start point of the specified secant line.
        endPoint - The end point of the specified secant line.
        modelDatasets - The specified model dataset collection. Optional, but at least specifies a surface raster dataset or a model dataset.
        surfaceGrid - The specified surface raster dataset. Optional, but at least specifies a surface raster dataset or a model dataset.
        returnRecordsetOrDataset - Returns the dataset or recordset. The default is recordset.
        Returns:

      • costPathLine

        public CostPathLineResult costPathLine(java.lang.String gridDataset,
                              Point2D sourcePoint,
                              Point2D targetPoint,
                              SmoothMethod smoothMethod,
                              int smoothDegree,
                              DataReturnOption resultSetting,
                              double maxUpslopeDegree,
                              double maxDownslopeDegree)
        Description copied from interface: SpatialAnalystProvider

        Raster shortest path analysis.

        Performs the least cost path grid analysis according to given parameters. This method calculates the least-cost paths between specified sources and target points.

        Specified by:
        costPathLine in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The specified cost distance. It is a raster dataset. The value of each cell in this dataset represents the cost to travel through this cell.
        sourcePoint - The specific source point.
        targetPoint - The specified target point.
        smoothMethod - The specified smoothing method for processing the least-cost paths.
        smoothDegree - The specified smooth degree. 1 indicates that the result will not be smoothed. A greater value will result in a greater smoothness and a lower efficiency. The recommended range is [1,3].
        resultSetting - The result setting parameter, including whether to return the record, whether to generate result dataset, etc.
        maxUpslopeDegree - The specified maximum uphill angle when calculating the shortest route between two points (source and target).
        maxDownslopeDegree - The specified maximum downhill angle when calculating the shortest route between two points (source and target).
        Returns:
        The least-cost path result.

      • cutFill

        public CutFillResult cutFill(java.lang.String gridDataset,
                    java.lang.String afterCutFillDataset,
                    java.lang.String resultDataset,
                    boolean deleteExistResultDataset,
                    boolean buildPyramid)
        Description copied from interface: SpatialAnalystProvider

        Rater cut and fill calculation.

        Surface materials on the Earth surface usually move as they are eroded and deposited, which result in accumulation of surface materials in some area and loss in some other. In an engineering project, the loss of surface materials is called "Cut", and the increase of surface materials is called "Fill". A grid cut and fill calculation requires two input grid datasets: the dataset before a cutting and filling operation and the one after. The value of each cell in the result dataset is the difference between the values of the corresponding cell in the two input datasets. A positive cell value indicates that the surface material at that cell has reduced; a negative cell value indicates the surface material there has increased. The two input grid datasets must have the same coordinate system and projection, so that a point on the Earth would have the same coordinates in the two datasets. If the coordinate systems of the two grid datasets are not the same, an erroneous result may be produced. Theoretically, the spatial extents of the two input grid datasets should be the same. If not, only the overlapped part will participate in the cut and fill calculation. If a cell in a grid dataset has a null value, the corresponding cell in the result dataset will have a null value too.

        Specified by:
        cutFill in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The original grid dataset used in cut and fill.
        afterCutFillDataset - The grid dataset after the cut and fill operation.
        resultDataset - The result dataset after the cut and fill analysis.
        deleteExistResultDataset - Whether to delete the existing dataset if the name of the result dataset named by users is the same as that of an existing dataset.
        buildPyramid - Whether creating image pyramid or not for the result raster dataset.
        Returns:
        Cut and fill calculation result.

      • cutFill

        public CutFillResult cutFill(java.lang.String gridDataset,
                    Geometry region,
                    double baseAltitude,
                    java.lang.String resultDataset,
                    boolean deleteExistResultDataset,
                    boolean buildPyramid)
        Description copied from interface: SpatialAnalystProvider

        Cut and fill for a selected region.

        It can be applied when a region with ridges and valleys is to be flattened. The user can specify the region to be flattened and the target elevation. This method can be used to calculate the filled area, the cut area, the fill volume, and the cut volume.

        Specified by:
        cutFill in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The original grid dataset used in cut and fill.
        region - Cut and fill area.
        baseAltitude - The result elevation of the specified region to be cut and filled.
        resultDataset - The result dataset after the cut and fill analysis.
        deleteExistResultDataset - Whether to delete the existing dataset if the name of the result dataset named by users is the same as that of an existing dataset.
        buildPyramid - Whether creating image pyramid or not for the result raster dataset.
        Returns:
        Cut and fill calculation result.

      • cutFill

        public CutFillResult cutFill(java.lang.String gridDataset,
                    Geometry line3d,
                    double bufferRadius,
                    boolean isRoundHead,
                    java.lang.String resultDataset,
                    boolean deleteExistResultDataset,
                    boolean buildPyramid)
        Description copied from interface: SpatialAnalystProvider

        Incline cut and fill.

        The incline cut and fill. This function calculates the volume needed to be cut and filled to create a slope on the terrain surface. The principle is similar to cutting and filling for a selected region. It makes use of specifying cut and fill route, buffer radius to construct the required filled area, cut area, fill volume, and cut volume.

        Specified by:
        cutFill in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The original grid dataset used in cut and fill.
        line3d - The specified cut and fill route.
        bufferRadius - The buffer radius of the specified cut and fill route.
        isRoundHead - Whether to use a round buffer for the cut and fill route.
        resultDataset - The result dataset after the cut and fill analysis.
        deleteExistResultDataset - Whether to delete the existing dataset if the name of the result dataset named by users is the same as that of an existing dataset.
        buildPyramid - Whether creating image pyramid or not for the result raster dataset.
        Returns:
        Cut and fill calculation result.

      • cutFill

        public double cutFill(java.lang.String gridDataset,
             double volume,
             boolean isFill,
             Geometry validRegion)
        Description copied from interface: SpatialAnalystProvider

        Back-calculates cut and fill.

        That is calculating the expected elevation after performing cut and fill according to the specified volume for filling or cutting.

        Specified by:
        cutFill in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The specified grid data to be cut and filled.
        volume - The specified volume for filling or cutting. The value is a value greater than 0, and if set to less than or equal to 0, an exception will be thrown.
        isFill - Specifies whether to do fill and cut calculation. True, calculate; false, otherwise.
        validRegion - The valid region. After specified this region, the cut and fill operation will be conducted in this region. If this parameter is null, the cut and fill operation will be conducted in the whole grid dataset.
        Returns:
        The elevation after cut or fill.

      • cutFill

        public CutFillResult cutFill(java.lang.String gridDataset,
                    Geometry3D region3d,
                    java.lang.String resultDataset,
                    boolean deleteExistResultDataset,
                    boolean buildPyramid)
        Description copied from interface: SpatialAnalystProvider

        3D region Cut and Fill.

        It can be applied when a region with ridges and valleys is to be cut and filled into a specified expected 3D region. The filled area, the cut area, the fill volume, and the cut volume can be calculated.

        Specified by:
        cutFill in interface SpatialAnalystProvider
        Returns:
        Cut and fill calculation result.

      • flood

        public GeometrySpatialAnalystResult flood(java.lang.String gridDataset,
                                 double floodHeigth,
                                 Geometry validRegion)
        Description copied from interface: SpatialAnalystProvider

        Calculates the flood area according to the given elevation.

        The flood area calculation is based on DEM. Cells that have elevation lower than the given water elevation will be flooded. The flood area can be converted to the region data. The source DEM data isn't modified. The flood area is easy to be calculated by the flood region.

        Specified by:
        flood in interface SpatialAnalystProvider
        Parameters:
        gridDataset - DEM data for calculating the flood area.
        floodHeigth - The water elevation.
        validRegion - The valid region. Only this region is calculated.
        Returns:
        Flood analysis result.

      • extractValleyLine

        public DatasetSpatialAnalystResult extractValleyLine(java.lang.String gridDataset,
                                            Geometry extractRegion,
                                            java.lang.String targetDatasource,
                                            java.lang.String resultGridName,
                                            boolean deleteExistResultDataset)
        Description copied from interface: SpatialAnalystProvider

        Extracts the valley line.

        Specified by:
        extractValleyLine in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The specified DEM data on which to extract the valley lines.
        targetDatasource - Used to store the result dataset. If set to null, the result will be stored into the same datasource with that of surfaceGrid dataset.
        resultGridName - The name of the result dataet.
        deleteExistResultDataset - Whether to delete the existing result dataset.
        Returns:
        The analysis result.

      • extractRidgeLine

        public DatasetSpatialAnalystResult extractRidgeLine(java.lang.String gridDataset,
                                           Geometry extractRegion,
                                           java.lang.String targetDatasource,
                                           java.lang.String resultGridName,
                                           boolean deleteExistResultDataset)
        Description copied from interface: SpatialAnalystProvider

        Extracts the ridge line.

        Specified by:
        extractRidgeLine in interface SpatialAnalystProvider
        Parameters:
        gridDataset - The specified DEM data on which to extract the ridge lines.
        targetDatasource - Used to store the result dataset. If set to null, the result will be stored into the same datasource with that of surfaceGrid dataset.
        resultGridName - The name of the result dataet.
        deleteExistResultDataset - Whether to delete the existing result dataset.
        Returns:
        The analysis result.

      • locatePoint

        public GeometrySpatialAnalystResult locatePoint(Route sourceRoute,
                                       double measure,
                                       double offset,
                                       boolean isIgnoreGap)
        Description copied from interface: SpatialAnalystProvider

        Gets the point object of M specified by the route object.

        Specified by:
        locatePoint in interface SpatialAnalystProvider
        Parameters:
        sourceRoute - The route object.
        measure - The specified M value.
        offset - The offset of result point.
        isIgnoreGap - Whether to ignore the distances between parts.
        Returns:
        The point object of M specified by the route object.

      • locatePoint

        public GeometrySpatialAnalystResult locatePoint(java.lang.String datasetName,
                                       java.lang.String routeIdField,
                                       java.lang.String routeId,
                                       double measure,
                                       double offset,
                                       boolean isIgnoreGap)
        Description copied from interface: SpatialAnalystProvider

        Gets the point object of M specified by the route object.

        Specified by:
        locatePoint in interface SpatialAnalystProvider
        Parameters:
        datasetName - The dataset name.
        routeIdField - The route ID field.
        routeId - The route object identifier.
        measure - The specified M value.
        offset - The offset of result point.
        isIgnoreGap - Whether to ignore the distances between parts.
        Returns:
        The point object of M specified by the route object.

      • locateLine

        public GeometrySpatialAnalystResult locateLine(Route sourceRoute,
                                      double startMeasure,
                                      double endMeasure)
        Description copied from interface: SpatialAnalystProvider

        Returns the corresponding line objects with the given start and end M values.

        Specified by:
        locateLine in interface SpatialAnalystProvider
        Parameters:
        sourceRoute - The route object.
        startMeasure - The specified start M value.
        endMeasure - The specified end M value.
        Returns:
        The corresponding line objects with the given start and end M values.

      • locateLine

        public GeometrySpatialAnalystResult locateLine(java.lang.String datasetName,
                                      java.lang.String routeIdField,
                                      java.lang.String routeId,
                                      double startMeasure,
                                      double endMeasure)
        Description copied from interface: SpatialAnalystProvider

        Returns the corresponding line objects with the given start and end M values.

        Specified by:
        locateLine in interface SpatialAnalystProvider
        Parameters:
        datasetName - The dataset name.
        routeIdField - The route ID field.
        routeId - The route object identifier.
        startMeasure - The specified start M value.
        endMeasure - The specified end M value.
        Returns:
        The corresponding line objects with the given start and end M values.

      • calculateMeasureAtPoint

        public RouteCalculateMeasureResult calculateMeasureAtPoint(Route sourceRoute,
                                                  Point2D point,
                                                  double tolerance,
                                                  boolean isIgnoreGap)
        Description copied from interface: SpatialAnalystProvider

        Calculates the M value of the specified point with the specified route object.

        Specified by:
        calculateMeasureAtPoint in interface SpatialAnalystProvider
        Parameters:
        sourceRoute - The route object.
        point - The specified point object.
        tolerance - The tolerance.
        isIgnoreGap - Whether to ignore the distances between parts.
        Returns:
        The M value of the specified point object.

      • getDataSourceInfos

        protected void getDataSourceInfos()

      • executeMathAnalystExpression

        public DatasetSpatialAnalystResult executeMathAnalystExpression(java.lang.String expression,
                                                       Geometry extractRegion,
                                                       boolean isZip,
                                                       boolean ignoreNoValue,
                                                       java.lang.String targetDatasource,
                                                       java.lang.String resultGridName,
                                                       boolean deleteExistResultDataset)

        Performs a grid algebraic operation expression.

        Specified by:
        executeMathAnalystExpression in interface SpatialAnalystProvider
        Parameters:
        expression - A custom grid algebraic operation expression.
        extractRegion - User-specified valid calculation area. If it is null, calculate entire region. If the datasets are not inconformity, use the intersection to calculate.
        isZip - Whether to compress the result dataset. true means compression.
        ignoreNoValue - Whether to ignore the no-value grid data. true means ignore; otherwise, false.
        targetDatasource - The specified datasource used for storing result dataset.
        resultGridName - The specified result dataset.
        deleteExistResultDataset - Whether to delete the existing result dataset.
        Returns:
        The analysis result.

      • kernelDensity

        public DatasetSpatialAnalystResult kernelDensity(DensityAnalystParameterInput inputParam,
                                        java.lang.String sourceDatasetTag,
                                        java.lang.String fieldName,
                                        java.lang.String targetDatasource,
                                        java.lang.String resultGridName,
                                        boolean deleteExistResultDataset)
        Description copied from interface: SpatialAnalystProvider

        Performs kernel density analysis on point dataset or line dataset. Return the result grid dataset.

        Specified by:
        kernelDensity in interface SpatialAnalystProvider
        Parameters:
        inputParam - The parameters needed in kernel density analysis.
        sourceDatasetTag - The point or line datasets identification used to perform kernel density analysis (datasetName@datasourceName).
        fieldName - The field name of the measured value used to perform the density analysis. The density analysis doesn't support text field.
        targetDatasource - The specified datasource used for storing result dataset.
        resultGridName - The specified result dataset.
        deleteExistResultDataset - Whether to delete the existing result dataset.
        Returns:
        The result of kernel density analysis.