/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.sis.referencing.cs;
import java.util.Map;
import javax.measure.unit.Unit;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlRootElement;
import org.opengis.referencing.cs.EllipsoidalCS;
import org.opengis.referencing.cs.AxisDirection;
import org.opengis.referencing.cs.CoordinateSystemAxis;
import org.apache.sis.internal.referencing.AxisDirections;
import org.apache.sis.util.resources.Errors;
import org.apache.sis.measure.Units;
/**
* A 2- or 3-dimensional coordinate system for geodetic latitude and longitude, optionally with ellipsoidal height.
*
* <table class="sis"><tr>
* <th>Used with CRS</th>
* <th>Permitted axis names</th>
* </tr><tr>
* <td>{@linkplain org.apache.sis.referencing.crs.DefaultGeocentricCRS Geographic}</td>
* <td>“Geodetic latitude”, “Geodetic longitude”, “Ellipsoidal height” (if 3D)</td>
* </tr></table>
*
* {@section Immutability and thread safety}
* This class is immutable and thus thread-safe if the property <em>values</em> (not necessarily the map itself)
* and the {@link CoordinateSystemAxis} instances given to the constructor are also immutable. Unless otherwise
* noted in the javadoc, this condition holds if all components were created using only SIS factories and static
* constants.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @since 0.4 (derived from geotk-2.0)
* @version 0.4
* @module
*/
@XmlType(name = "EllipsoidalCSType")
@XmlRootElement(name = "EllipsoidalCS")
public class DefaultEllipsoidalCS extends AbstractCS implements EllipsoidalCS {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = -1452492488902329211L;
/**
* Constructs a new coordinate system in which every attributes are set to a null or empty value.
* <strong>This is not a valid object.</strong> This constructor is strictly reserved to JAXB,
* which will assign values to the fields using reflexion.
*/
private DefaultEllipsoidalCS() {
}
/**
* Creates a new coordinate system from an arbitrary number of axes. This constructor is for
* implementations of the {@link #createSameType(Map, CoordinateSystemAxis[])} method only,
* because it does not verify the number of axes.
*/
private DefaultEllipsoidalCS(final Map<String,?> properties, final CoordinateSystemAxis[] axes) {
super(properties, axes);
}
/**
* Constructs a two-dimensional coordinate system from a set of properties.
* The properties map is given unchanged to the
* {@linkplain AbstractCS#AbstractCS(Map,CoordinateSystemAxis[]) super-class constructor}.
* The following table is a reminder of main (not all) properties:
*
* <table class="sis">
* <tr>
* <th>Property name</th>
* <th>Value type</th>
* <th>Returned by</th>
* </tr>
* <tr>
* <td>{@value org.opengis.referencing.IdentifiedObject#NAME_KEY}</td>
* <td>{@link org.opengis.referencing.ReferenceIdentifier} or {@link String}</td>
* <td>{@link #getName()}</td>
* </tr>
* <tr>
* <td>{@value org.opengis.referencing.IdentifiedObject#ALIAS_KEY}</td>
* <td>{@link org.opengis.util.GenericName} or {@link CharSequence} (optionally as array)</td>
* <td>{@link #getAlias()}</td>
* </tr>
* <tr>
* <td>{@value org.opengis.referencing.IdentifiedObject#IDENTIFIERS_KEY}</td>
* <td>{@link org.opengis.referencing.ReferenceIdentifier} (optionally as array)</td>
* <td>{@link #getIdentifiers()}</td>
* </tr>
* <tr>
* <td>{@value org.opengis.referencing.IdentifiedObject#REMARKS_KEY}</td>
* <td>{@link org.opengis.util.InternationalString} or {@link String}</td>
* <td>{@link #getRemarks()}</td>
* </tr>
* </table>
*
* @param properties The properties to be given to the identified object.
* @param axis0 The first axis.
* @param axis1 The second axis.
*/
public DefaultEllipsoidalCS(final Map<String,?> properties,
final CoordinateSystemAxis axis0,
final CoordinateSystemAxis axis1)
{
super(properties, axis0, axis1);
for (int i=0; i<2; i++) {
final AxisDirection direction = super.getAxis(i).getDirection();
if (AxisDirections.isVertical(direction)) {
throw new IllegalArgumentException(Errors.format(
Errors.Keys.IllegalAxisDirection_2, "EllipdoicalCS (2D)", direction));
}
}
}
/**
* Constructs a three-dimensional coordinate system from a set of properties.
* The properties map is given unchanged to the
* {@linkplain AbstractCS#AbstractCS(Map,CoordinateSystemAxis[]) super-class constructor}.
*
* @param properties The properties to be given to the identified object.
* @param axis0 The first axis.
* @param axis1 The second axis.
* @param axis2 The third axis.
*/
public DefaultEllipsoidalCS(final Map<String,?> properties,
final CoordinateSystemAxis axis0,
final CoordinateSystemAxis axis1,
final CoordinateSystemAxis axis2)
{
super(properties, axis0, axis1, axis2);
}
/**
* Creates a new coordinate system with the same values than the specified one.
* This copy constructor provides a way to convert an arbitrary implementation into a SIS one
* or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API.
*
* <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p>
*
* @param cs The coordinate system to copy.
*
* @see #castOrCopy(EllipsoidalCS)
*/
protected DefaultEllipsoidalCS(final EllipsoidalCS cs) {
super(cs);
}
/**
* Returns a SIS coordinate system implementation with the same values than the given arbitrary implementation.
* If the given object is {@code null}, then this method returns {@code null}.
* Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged.
* Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.
*
* @param object The object to get as a SIS implementation, or {@code null} if none.
* @return A SIS implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*/
public static DefaultEllipsoidalCS castOrCopy(final EllipsoidalCS object) {
return (object == null) || (object instanceof DefaultEllipsoidalCS)
? (DefaultEllipsoidalCS) object : new DefaultEllipsoidalCS(object);
}
/**
* Returns {@code VALID} if the given argument values are allowed for this coordinate system,
* or an {@code INVALID_*} error code otherwise. This method is invoked at construction time.
*
* <p>The current implementation accepts only the following directions:
* {@link AxisDirection#NORTH NORTH}, {@link AxisDirection#SOUTH SOUTH},
* {@link AxisDirection#EAST EAST}, {@link AxisDirection#WEST WEST},
* {@link AxisDirection#UP UP} and {@link AxisDirection#DOWN DOWN}.
* The units shall be angular, except the vertical ones which shall be linear.</p>
*/
@Override
final int validateAxis(AxisDirection direction, final Unit<?> unit) {
direction = AxisDirections.absolute(direction);
final boolean isVertical = AxisDirection.UP.equals(direction);
if (!isVertical && !AxisDirection.NORTH.equals(direction) && !AxisDirection.EAST.equals(direction)) {
return INVALID_DIRECTION;
}
if (!(isVertical ? Units.isLinear(unit) : Units.isAngular(unit))) {
return INVALID_UNIT;
}
return VALID;
}
/**
* Returns the GeoAPI interface implemented by this class.
* The SIS implementation returns {@code EllipsoidalCS.class}.
*
* <div class="note"><b>Note for implementors:</b>
* Subclasses usually do not need to override this method since GeoAPI does not define {@code EllipsoidalCS}
* sub-interface. Overriding possibility is left mostly for implementors who wish to extend GeoAPI with their
* own set of interfaces.</div>
*
* @return {@code EllipsoidalCS.class} or a user-defined sub-interface.
*/
@Override
public Class<? extends EllipsoidalCS> getInterface() {
return EllipsoidalCS.class;
}
/**
* {@inheritDoc}
*
* @return {@inheritDoc}
*/
@Override
public DefaultEllipsoidalCS forConvention(final AxesConvention convention) {
return (DefaultEllipsoidalCS) super.forConvention(convention);
}
/**
* Returns a coordinate system of the same class than this CS but with different axes.
*/
@Override
final AbstractCS createSameType(final Map<String,?> properties, final CoordinateSystemAxis[] axes) {
return new DefaultEllipsoidalCS(properties, axes);
}
}