Skip navigation links
com.supermap.analyst.spatialanalyst

Class OverlayAnalystParameter

  • java.lang.Object
    • com.supermap.analyst.spatialanalyst.OverlayAnalystParameter

  • public class OverlayAnalystParameter
extends java.lang.Object
    The OverlayAnalystParameter class.

    The class mainly provides the output dataset field selection for overlay analysis. There are at least three datasets involved when performing the overlay analysis; they are the input dataset, the overlay dataset and the output dataset. The type of the input dataset (also called the first dataset in SuperMap GIS) can be point, line or region and the type of the overlay dataset (also called the second dataset in SuperMap GIS) should be region. The attribute information of the output dataset comes from the input dataset and the overlay datasets. This class provides an interface to select the fields of input dataset or the overlay dataset which are maintained in the output dataset.

    Example:
    See the sample of OverlayAnalyst.clip() method.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String[] getOperationRetainedFields()
      Gets the field names of overlay dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
      java.lang.String[] getSourceRetainedFields()
      Gets the field names of input dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
      double getTolerance()
      Gets the tolerance of the overlay analysis.
      void setOperationRetainedFields(java.lang.String[] value)
      Sets the field names of overlay dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
      void setSourceRetainedFields(java.lang.String[] value)
      Sets the field names of input dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
      void setTolerance(double value)
      Sets the tolerance of the overlay analysis.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OverlayAnalystParameter

        public OverlayAnalystParameter()
        The default no-arg constructor. Builds a new instance of the OverlayAnalystParameter class.

      • OverlayAnalystParameter

        public OverlayAnalystParameter(OverlayAnalystParameter overlayAnalystParameter)
        Initializes a instance of the OverlayAnalystParameter class which is identical with the specified OverlayAnalystParameter object.
        Parameters:
        overlayAnalystParameter - Specifies the overlay parameter object.

    • Method Detail

      • getSourceRetainedFields

        public java.lang.String[] getSourceRetainedFields()
        Gets the field names of input dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
        Returns:
        A collection of field names that need to be retained in a first dataset or set of records for overlay analysis.
        Default:
        The default value is empty for the String [] object.

      • setSourceRetainedFields

        public void setSourceRetainedFields(java.lang.String[] value)
        Sets the field names of input dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.

        Note: In the case of a clipping or erase operation, the non-system fields of the first dataset or recordset are all reserved.

        Parameters:
        value - A collection of field names that need to be retained in a first dataset or set of records for overlay analysis.

      • getOperationRetainedFields

        public java.lang.String[] getOperationRetainedFields()
        Gets the field names of overlay dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
        Returns:
        A collection of field names that need to be retained in a second dataset or set of records to be overlaid.
        Default:
        The default value is empty for the String [] object.

      • setOperationRetainedFields

        public void setOperationRetainedFields(java.lang.String[] value)
        Sets the field names of overlay dataset or the Recordset which are maintained in the output dataset when performing overlay analysis.
        Parameters:
        value - A collection of field names that need to be retained in a second dataset or set of records to be overlaid.

      • getTolerance

        public double getTolerance()
        Gets the tolerance of the overlay analysis.
        Returns:
        The tolerance of the overlay analysis.
        Default:
        The default value is 0.

      • setTolerance

        public void setTolerance(double value)
        Sets the tolerance of the overlay analysis.
        Parameters:
        value - The tolerance of the overlay analysis.
Skip navigation links