001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2009-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.operation;
033    
034    import org.opengis.metadata.citation.Citation;
035    import org.opengis.util.InternationalString;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.*;
040    
041    
042    /**
043     * Specification of the coordinate operation method formula.
044     *
045     * @author  Martin Desruisseaux (Geomatys)
046     * @version 3.0
047     * @since   2.3
048     */
049    @UML(identifier="CC_Formula", specification=ISO_19111)
050    public interface Formula {
051        /**
052         * Formula(s) or procedure used by the operation method.
053         *
054         * @return The formula used by the operation method, or {@code null} if none.
055         *
056         * @condition Only one of {@code getFormula()} and {@code getCitation()} shall be supplied.
057         */
058        @UML(identifier="formula", obligation=CONDITIONAL, specification=ISO_19111)
059        InternationalString getFormula();
060    
061        /**
062         * Reference to a publication giving the formula(s) or procedure used by the
063         * coordinate operation method.
064         *
065         * @return Reference to a publication giving the formula, or {@code null} if none.
066         *
067         * @condition Only one of {@code getFormula()} and {@code getCitation()} shall be supplied.
068         */
069        @UML(identifier="formulaCitation", obligation=CONDITIONAL, specification=ISO_19111)
070        Citation getCitation();
071    }