com.vividsolutions.jts.geom.Dimension Maven / Gradle / Ivy
The newest version!
/*
* The JTS Topology Suite is a collection of Java classes that
* implement the fundamental operations required to validate a given
* geo-spatial data set to a known topological specification.
*
* Copyright (C) 2001 Vivid Solutions
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* For more information, contact:
*
* Vivid Solutions
* Suite #1A
* 2328 Government Street
* Victoria BC V8T 5G5
* Canada
*
* (250)385-6040
* www.vividsolutions.com
*/
package com.vividsolutions.jts.geom;
/**
* 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 {@link #DONTCARE} meaning "any dimension".
* These constants are used as the entries in {@link IntersectionMatrix}s.
*
* @version 1.7
*/
public class Dimension {
/**
* Dimension value of a point (0).
*/
public final static int P = 0;
/**
* Dimension value of a curve (1).
*/
public final static int L = 1;
/**
* Dimension value of a surface (2).
*/
public final static int A = 2;
/**
* Dimension value of the empty geometry (-1).
*/
public final static int FALSE = -1;
/**
* Dimension value of non-empty geometries (= {P, L, A}).
*/
public final static int TRUE = -2;
/**
* Dimension value for any dimension (= {FALSE, TRUE}).
*/
public final static int DONTCARE = -3;
/**
* Symbol for the FALSE pattern matrix entry
*/
public final static char SYM_FALSE = 'F';
/**
* Symbol for the TRUE pattern matrix entry
*/
public final static char SYM_TRUE = 'T';
/**
* Symbol for the DONTCARE pattern matrix entry
*/
public final static char SYM_DONTCARE = '*';
/**
* Symbol for the P (dimension 0) pattern matrix entry
*/
public final static char SYM_P = '0';
/**
* Symbol for the L (dimension 1) pattern matrix entry
*/
public final static char SYM_L = '1';
/**
* Symbol for the A (dimension 2) pattern matrix entry
*/
public final static char SYM_A = '2';
/**
* Converts the dimension value to a dimension symbol, for example, TRUE => 'T'
* .
*
*@param dimensionValue a number that can be stored in the IntersectionMatrix
* . Possible values are {TRUE, FALSE, DONTCARE, 0, 1, 2}.
*@return a character for use in the string representation of
* an IntersectionMatrix. Possible values are {T, F, * , 0, 1, 2}
* .
*/
public static char toDimensionSymbol(int dimensionValue) {
switch (dimensionValue) {
case FALSE:
return SYM_FALSE;
case TRUE:
return SYM_TRUE;
case DONTCARE:
return SYM_DONTCARE;
case P:
return SYM_P;
case L:
return SYM_L;
case A:
return SYM_A;
}
throw new IllegalArgumentException("Unknown dimension value: " + dimensionValue);
}
/**
* Converts the dimension symbol to a dimension value, for example, '*' => DONTCARE
* .
*
*@param dimensionSymbol a character for use in the string representation of
* an IntersectionMatrix. Possible values are {T, F, * , 0, 1, 2}
* .
*@return a number that can be stored in the IntersectionMatrix
* . Possible values are {TRUE, FALSE, DONTCARE, 0, 1, 2}.
*/
public static int toDimensionValue(char dimensionSymbol) {
switch (Character.toUpperCase(dimensionSymbol)) {
case SYM_FALSE:
return FALSE;
case SYM_TRUE:
return TRUE;
case SYM_DONTCARE:
return DONTCARE;
case SYM_P:
return P;
case SYM_L:
return L;
case SYM_A:
return A;
}
throw new IllegalArgumentException("Unknown dimension symbol: " + dimensionSymbol);
}
}