001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.referencing.cs;
033    
034    import org.opengis.referencing.IdentifiedObject;
035    import org.opengis.annotation.UML;
036    
037    import static org.opengis.annotation.Obligation.*;
038    import static org.opengis.annotation.Specification.*;
039    
040    
041    /**
042     * The set of coordinate system axes that spans a given coordinate space. A coordinate system (CS)
043     * is derived from a set of (mathematical) rules for specifying how coordinates in a given space
044     * are to be assigned to points. The coordinate values in a coordinate tuple shall be recorded in
045     * the order in which the coordinate system axes associations are recorded, whenever those
046     * coordinates use a coordinate reference system that uses this coordinate system.
047     *
048     * @author  Martin Desruisseaux (IRD)
049     * @version 3.0
050     * @since   1.0
051     *
052     * @see org.opengis.referencing.cs.CoordinateSystemAxis
053     * @see javax.measure.unit.Unit
054     * @see org.opengis.referencing.datum.Datum
055     * @see org.opengis.referencing.crs.CoordinateReferenceSystem
056     *
057     * @navassoc - - - CoordinateSystemAxis
058     */
059    @UML(identifier="CS_CoordinateSystem", specification=ISO_19111)
060    public interface CoordinateSystem extends IdentifiedObject {
061        /**
062         * Returns the dimension of the coordinate system.
063         *
064         * @return The dimension of the coordinate system.
065         */
066        int getDimension();
067    
068        /**
069         * Returns the axis for this coordinate system at the specified dimension.
070         * Each coordinate system must have at least one axis.
071         *
072         * @param  dimension The zero based index of axis.
073         * @return The axis at the specified dimension.
074         * @throws IndexOutOfBoundsException if {@code dimension} is out of bounds.
075         */
076        @UML(identifier="axis", obligation=MANDATORY, specification=ISO_19111)
077        CoordinateSystemAxis getAxis(int dimension) throws IndexOutOfBoundsException;
078    }