/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2003-2005, Open Geospatial Consortium Inc.
*
* All Rights Reserved. http://www.opengis.org/legal/
*/
package org.opengis.referencing.cs;
import javax.measure.unit.Unit;
import org.opengis.referencing.AuthorityFactory;
import org.opengis.referencing.FactoryException;
import org.opengis.referencing.NoSuchAuthorityCodeException;
import org.opengis.annotation.UML;
import org.opengis.annotation.Extension;
import static org.opengis.annotation.Specification.*;
/**
* Creates {@linkplain CoordinateSystem coordinate systems} using authority codes. External authorities
* are used to manage definitions of objects used in this interface. The definitions of these objects are
* referenced using code strings. A commonly used authority is <A HREF="http://www.epsg.org">EPSG</A>,
* which is also used in the <A HREF="http://www.remotesensing.org/geotiff/geotiff.html">GeoTIFF</A>
* standard.
*
*
* @source $URL: http://svn.osgeo.org/geotools/branches/2.7.x/modules/library/opengis/src/main/java/org/opengis/referencing/cs/CSAuthorityFactory.java $
* @version <A HREF="http://www.opengis.org/docs/01-009.pdf">Implementation specification 1.0</A>
* @author Martin Desruisseaux (IRD)
* @since GeoAPI 1.0
*
* @see org.opengis.referencing.crs.CRSAuthorityFactory
* @see org.opengis.referencing.datum.DatumAuthorityFactory
*/
@Extension
public interface CSAuthorityFactory extends AuthorityFactory {
/**
* Returns an arbitrary {@linkplain CoordinateSystem coordinate system} from a code.
* If the coordinate system type is know at compile time, it is recommended to invoke
* the most precise method instead of this one (for example
* <code> {@linkplain #createCartesianCS createCartesianCS}(code) </code>
* instead of <code> createCoordinateSystem(code) </code> if the caller
* know he is asking for a {@linkplain CartesianCS cartesian coordinate system}).
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
CoordinateSystem createCoordinateSystem(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates a cartesian coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
CartesianCS createCartesianCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates a polar coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
PolarCS createPolarCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates a cylindrical coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
CylindricalCS createCylindricalCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates a spherical coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
SphericalCS createSphericalCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates an ellipsoidal coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
EllipsoidalCS createEllipsoidalCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates a vertical coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
VerticalCS createVerticalCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Creates a temporal coordinate system from a code.
*
* @param code Value allocated by authority.
* @return The coordinate system for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
TimeCS createTimeCS(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Returns a {@linkplain CoordinateSystemAxis coordinate system axis} from a code.
*
* @param code Value allocated by authority.
* @return The axis for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
CoordinateSystemAxis createCoordinateSystemAxis(String code)
throws NoSuchAuthorityCodeException, FactoryException;
/**
* Returns an {@linkplain Unit unit} from a code.
*
* @param code Value allocated by authority.
* @return The unit for the given code.
* @throws NoSuchAuthorityCodeException if the specified {@code code} was not found.
* @throws FactoryException if the object creation failed for some other reason.
*/
@UML(identifier="CS_CoordinateSystemAuthorityFactory.createLinearUnit, createAngularUnit", specification=OGC_01009)
Unit<?> createUnit(String code)
throws NoSuchAuthorityCodeException, FactoryException;
}