Skip navigation links
com.supermap.analyst

Class BufferAnalystParameter

  • java.lang.Object
    • com.supermap.analyst.BufferAnalystParameter

  • public class BufferAnalystParameter
extends java.lang.Object
    The BufferAnalystParameter class which provides the necessary parameters for the buffer analyst.

    Note:

    • For line data, you can either set setEndType to BufferEndType.FLAT or BufferEndType.Round. The only left buffer or right buffer or the unequal radius buffer works if you set the flat end.
    • For point, line data, only the round end is available. The radius is set by setLeftDistance.
    • If the negative buffer radius for region data is set greater than the radius of a inscribed circle of the region data, the buffer zone generated has no meaning. Therefore, it is not suggested to do so.
    • buffer radius must large than 0, otherwise invalid.
    Example:
    See the sample of createBuffer() method.

    • Constructor Summary

      Constructors 
      Constructor and Description
      BufferAnalystParameter()
      Initializes a new instance of the BufferAnalystParameter class.
      BufferAnalystParameter(BufferAnalystParameter bufferAnalystParameter)
      Initializes a new instance of the BufferAnalystParameter class which is identical with the specified BufferAnalystParameter object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      BufferEndType getEndType()
      Returns the type of the end of the line buffer zone.
      java.lang.Object getLeftDistance()
      Gets the (left) buffer distance.
      BufferRadiusUnit getRadiusUnit()
      Get the unit for buffer analysis radius.
      java.lang.Object getRightDistance()
      Gets the (right) buffer distance.
      int getSemicircleLineSegment()
      Gets the count of segments of the semicircle line, that is, how many segments are used to simulate the semicircle line, the value must be greater than four.
      void setEndType(BufferEndType bufferEndType)
      Sets the type of the end of the line buffer zone.
      void setLeftDistance(java.lang.Object object)
      Sets the (left) buffer distance.
      void setRadiusUnit(BufferRadiusUnit bufferRadiusUnit)
      Sets the unit for buffer analysis radius.
      void setRightDistance(java.lang.Object object)
      Sets the (right) buffer distance.
      void setSemicircleLineSegment(int value)
      Sets the count of segments of the semicircle line, that is, how many segments are used to simulate the semicircle line, the value must be greater than four.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BufferAnalystParameter

        public BufferAnalystParameter()
        Initializes a new instance of the BufferAnalystParameter class.

      • BufferAnalystParameter

        public BufferAnalystParameter(BufferAnalystParameter bufferAnalystParameter)
        Initializes a new instance of the BufferAnalystParameter class which is identical with the specified BufferAnalystParameter object.
        Parameters:
        bufferAnalystParameter - The specified BufferAnalystParameter object.

    • Method Detail

      • getEndType

        public BufferEndType getEndType()
        Returns the type of the end of the line buffer zone. Two types are provided for the end of the line buffer zone, they are Round and Flat. For more information, please refer to the BufferEndType.
        Returns:
        Enumerates end types of the buffer.
        Default:
        The default value is ROUND.

      • setEndType

        public void setEndType(BufferEndType bufferEndType)
        Sets the type of the end of the line buffer zone. Two types are provided for the end of the line buffer zone, they are Round and Flat. For more information, please refer to the BufferEndType.
        Parameters:
        bufferEndType - the buffer end point type.

      • getRadiusUnit

        public BufferRadiusUnit getRadiusUnit()
        Get the unit for buffer analysis radius.
        Returns:
        The unit for buffer analysis radius.

      • setRadiusUnit

        public void setRadiusUnit(BufferRadiusUnit bufferRadiusUnit)
        Sets the unit for buffer analysis radius.
        Parameters:
        bufferRadiusUnit - The unit for buffer analysis radius.

      • getSemicircleLineSegment

        public int getSemicircleLineSegment()
        Gets the count of segments of the semicircle line, that is, how many segments are used to simulate the semicircle line, the value must be greater than four.
        Returns:
        The count of the segment.
        Default:
        The default value is 12.

      • setSemicircleLineSegment

        public void setSemicircleLineSegment(int value)
        Sets the count of segments of the semicircle line, that is, how many segments are used to simulate the semicircle line, the value must be greater than four.
        Parameters:
        value - The count of the segment.

      • getLeftDistance

        public java.lang.Object getLeftDistance()
        Gets the (left) buffer distance.
        Returns:
        The distance of the buffer zone.
        Default:
        The default value is null.

      • setLeftDistance

        public void setLeftDistance(java.lang.Object object)
        Sets the (left) buffer distance.

        The parameter can be numerical or string.

        1. If the parameter is the numerical value:

          2. It represents the distance of the buffer zone while creating buffer zones for point or line data.

          Negative values are allowed for region data, not point data.

        2. If the parameter is the character string:

          3. It must be a legal non-system field, you can only create buffer for the datasets or the recordsets.

          For point and region datasets, the parameter represents the field or the field arithmetic expression of the buffer distance. For point and region datasets, the parameter represents the field or the field arithmetic expression of the left buffer distance( e.g. filedName*8).

          For line datasets, the parameter represents the field expression for the left buffer distance. For line recordsets, the parameter represents the field for the left buffer distance.

        Parameters:
        object - the buffer distance. must large than 0, otherwise invalid and show errors.

      • getRightDistance

        public java.lang.Object getRightDistance()
        Gets the (right) buffer distance.
        Returns:
        The distance of the right buffer distance.
        Default:
        The default value is null.

      • setRightDistance

        public void setRightDistance(java.lang.Object object)
        Sets the (right) buffer distance.

        This parameter only supports line data. The parameter can be numerical or string.

        1. If the parameter is the numerical value:

          2. However for the line data it represents the distance of the left buffer zone of the line object.

        2. If the parameter is the character string:

          3. Only support line datasets or line recordsets, and it is needed to specify a legal non-system field.

          For line datasets, the parameter represents the field or the field arithmetic expression of the right buffer distance (e.g. filedName*8).

          For line recordsets, the parameter represents the field for the right buffer distance.

        Parameters:
        object - the right buffer distance. must large than 0, otherwise invalid and show errors.
Skip navigation links