Package org.locationtech.jts.geom

Class Dimension

  • public class Dimension
extends Object
    Provides constants representing the dimensions of a point, a curve and a surface. Also provides constants representing the dimensions of the empty geometry and non-empty geometries, and the wildcard constant DONTCARE meaning "any dimension". These constants are used as the entries in IntersectionMatrixs.
    Version:
    1.7

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int A
      Dimension value of a surface (2).
      static int DONTCARE
      Dimension value for any dimension (= {FALSE, TRUE}).
      static int FALSE
      Dimension value of the empty geometry (-1).
      static int L
      Dimension value of a curve (1).
      static int P
      Dimension value of a point (0).
      static char SYM_A
      Symbol for the A (dimension 2) pattern matrix entry
      static char SYM_DONTCARE
      Symbol for the DONTCARE pattern matrix entry
      static char SYM_FALSE
      Symbol for the FALSE pattern matrix entry
      static char SYM_L
      Symbol for the L (dimension 1) pattern matrix entry
      static char SYM_P
      Symbol for the P (dimension 0) pattern matrix entry
      static char SYM_TRUE
      Symbol for the TRUE pattern matrix entry
      static int TRUE
      Dimension value of non-empty geometries (= {P, L, A}).

    • Constructor Summary

      Constructors 
      Constructor Description
      Dimension()  

    • Field Detail

      • FALSE

        public static final int FALSE
        Dimension value of the empty geometry (-1).
        See Also:
        Constant Field Values

      • TRUE

        public static final int TRUE
        Dimension value of non-empty geometries (= {P, L, A}).
        See Also:
        Constant Field Values

      • DONTCARE

        public static final int DONTCARE
        Dimension value for any dimension (= {FALSE, TRUE}).
        See Also:
        Constant Field Values

      • SYM_FALSE

        public static final char SYM_FALSE
        Symbol for the FALSE pattern matrix entry
        See Also:
        Constant Field Values

      • SYM_TRUE

        public static final char SYM_TRUE
        Symbol for the TRUE pattern matrix entry
        See Also:
        Constant Field Values

      • SYM_DONTCARE

        public static final char SYM_DONTCARE
        Symbol for the DONTCARE pattern matrix entry
        See Also:
        Constant Field Values

      • SYM_P

        public static final char SYM_P
        Symbol for the P (dimension 0) pattern matrix entry
        See Also:
        Constant Field Values

      • SYM_L

        public static final char SYM_L
        Symbol for the L (dimension 1) pattern matrix entry
        See Also:
        Constant Field Values

      • SYM_A

        public static final char SYM_A
        Symbol for the A (dimension 2) pattern matrix entry
        See Also:
        Constant Field Values

    • Constructor Detail

      • Dimension

        public Dimension()

    • Method Detail

      • toDimensionSymbol

        public static char toDimensionSymbol​(int dimensionValue)
        Converts the dimension value to a dimension symbol, for example, TRUE => 'T' .
        Parameters:
        dimensionValue - a number that can be stored in the IntersectionMatrix . Possible values are {TRUE, FALSE, DONTCARE, 0, 1, 2}.
        Returns:
        a character for use in the string representation of an IntersectionMatrix. Possible values are {T, F, * , 0, 1, 2} .

      • toDimensionValue

        public static int toDimensionValue​(char dimensionSymbol)
        Converts the dimension symbol to a dimension value, for example, '*' => DONTCARE .
        Parameters:
        dimensionSymbol - a character for use in the string representation of an IntersectionMatrix. Possible values are {T, F, * , 0, 1, 2} .
        Returns:
        a number that can be stored in the IntersectionMatrix . Possible values are {TRUE, FALSE, DONTCARE, 0, 1, 2}.