com.esri.core.geometry.SpatialReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of esri-geometry-api Show documentation
The Esri Geometry API for Java enables developers to write custom applications for analysis of spatial data.
There is a newer version: 2.2.4
/*
 Copyright 1995-2013 Esri

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts Dept
 380 New York Street
 Redlands, California, USA 92373

 email: [email protected]
 */

package com.esri.core.geometry;

import java.io.ObjectStreamException;
import java.io.Serializable;
import org.codehaus.jackson.JsonParser;
import org.codehaus.jackson.JsonToken;

import com.esri.core.geometry.SpatialReferenceSerializer;
import com.esri.core.geometry.VertexDescription;

/**
 * A class that represents the spatial reference for the geometry.
 */
public abstract class SpatialReference implements Serializable {
	// Note: We use writeReplace with SpatialReferenceSerializer. This field is
	// irrelevant. Needs to be removed after final.
	private static final long serialVersionUID = 2L;

	/**
	 * Creates an instance of the spatial reference based on the provided well
	 * known ID for the horizontal coordinate system.
	 * 
	 * @param wkid
	 *            The well-known ID.
	 * @return SpatialReference The spatial reference.
	 * @throws IllegalArgumentException
	 *             if wkid is not supported or does not exist.
	 */
	public static SpatialReference create(int wkid) {
		SpatialReferenceImpl spatRef = SpatialReferenceImpl.createImpl(wkid);
		return spatRef;
	}

	/**
	 * Creates an instance of the spatial reference based on the provided well
	 * known text representation for the horizontal coordinate system.
	 * 
	 * @param wktext
	 *            The well-known text string representation of spatial
	 *            reference.
	 * @return SpatialReference The spatial reference.
	 */
	public static SpatialReference create(String wktext) {
		return SpatialReferenceImpl.createImpl(wktext);
	}

	/**
	 * @return boolean Is spatial reference local?
	 */
	boolean isLocal() {
		return false;
	}

	/**
	 * Returns spatial reference from the JsonParser.
	 * 
	 * @param parser
	 *            The JSON parser.
	 * @return The spatial reference or null if there is no spatial reference
	 *         information, or the parser does not point to an object start.
	 * @throws Exception
	 *             if parsing has failed
	 */
	public static SpatialReference fromJson(JsonParser parser) throws Exception {
		int wkid = 0;
		String wkt = null;
		if (!JSONUtils.isObjectStart(parser))
			return null;

		while (parser.nextToken() != JsonToken.END_OBJECT) {
			String fieldName = parser.getCurrentName();
			parser.nextToken();
			if (parser.getCurrentToken() == JsonToken.VALUE_NULL) {
				continue;
			}

			if ("latestWkid".equals(fieldName)) {// get wkid
				wkid = parser.getIntValue();
			} else if ("wkid".equals(fieldName)) {// get wkid
				wkid = parser.getIntValue();
			} else if ("wkt".equals(fieldName)) {
				wkt = parser.getText();
			} else {
				parser.skipChildren();
			}
		}
		// END _OBJECT

		if (wkid > 0) // 1. Try to use wkid
		{
			try {
				return SpatialReference.create(wkid);
			} catch (IllegalArgumentException ex) {
				// if (wkt == null || wkt.length() == 0) //Here this will be our
				// default.
				// throw ex;
			}
		}

		if (wkt != null && wkt.length() != 0) // try to use wkt.
		{
			return SpatialReference.create(wkt);
		}

		return null;
	}

	/**
	 * Returns the well known ID for the horizontal coordinate system of the
	 * spatial reference.
	 * 
	 * @return wkid The well known ID.
	 */
	public abstract int getID();

	public abstract String getText();

	/**
	 * Returns the oldest value of the well known ID for the horizontal
	 * coordinate system of the spatial reference. This ID is used for JSON
	 * serialization. Not public.
	 */
	abstract int getOldID();

	/**
	 * Returns the latest value of the well known ID for the horizontal
	 * coordinate system of the spatial reference. This ID is used for JSON
	 * serialization. Not public.
	 */
	abstract int getLatestID();

	/**
	 * Get the XY tolerance of the spatial reference
	 * 
	 * @return The XY tolerance of the spatial reference as double.
	 */
	public double getTolerance() {
		return getTolerance(VertexDescription.Semantics.POSITION);
	}

	/**
	 * Get the XY tolerance of the spatial reference
	 * 
	 * @return The XY tolerance of the spatial reference as double.
	 */
	abstract double getTolerance(int semantics);

	Object writeReplace() throws ObjectStreamException {
		SpatialReferenceSerializer srSerializer = new SpatialReferenceSerializer();
		srSerializer.setSpatialReferenceByValue(this);
		return srSerializer;
	}
}