Dimension.java

/*
 * 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;

/**
 * Constants representing the dimensions of a point, a curve and a surface.
 * Also, constants representing the dimensions of the empty geometry and
 * non-empty geometries, and a wildcard dimension meaning "any dimension".
 * 
 * @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;

	/**
	 * Converts the dimension value to a dimension symbol, for example,
	 * <code>TRUE => 'T'</code> .
	 * 
	 *@param dimensionValue
	 *            a number that can be stored in the
	 *            <code>IntersectionMatrix</code> . Possible values are
	 *            <code>{TRUE, FALSE, DONTCARE, 0, 1, 2}</code>.
	 *@return a character for use in the string representation of an
	 *         <code>IntersectionMatrix</code>. Possible values are
	 *         <code>{T, F, * , 0, 1, 2}</code> .
	 */
	public static char toDimensionSymbol(int dimensionValue) {
		switch (dimensionValue) {
		case FALSE:
			return 'F';
		case TRUE:
			return 'T';
		case DONTCARE:
			return '*';
		case P:
			return '0';
		case L:
			return '1';
		case A:
			return '2';
		}
		throw new IllegalArgumentException("Unknown dimension value: "
				+ dimensionValue);
	}

	/**
	 * Converts the dimension symbol to a dimension value, for example,
	 * <code>'*' => DONTCARE</code> .
	 * 
	 *@param dimensionSymbol
	 *            a character for use in the string representation of an
	 *            <code>IntersectionMatrix</code>. Possible values are
	 *            <code>{T, F, * , 0, 1, 2}</code> .
	 *@return a number that can be stored in the
	 *         <code>IntersectionMatrix</code> . Possible values are
	 *         <code>{TRUE, FALSE, DONTCARE, 0, 1, 2}</code>.
	 */
	public static int toDimensionValue(char dimensionSymbol) {
		switch (Character.toUpperCase(dimensionSymbol)) {
		case 'F':
			return FALSE;
		case 'T':
			return TRUE;
		case '*':
			return DONTCARE;
		case '0':
			return P;
		case '1':
			return L;
		case '2':
			return A;
		}
		throw new IllegalArgumentException("Unknown dimension symbol: "
				+ dimensionSymbol);
	}
}