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.metadata.acquisition;
033    
034    import java.util.Collection;
035    
036    import org.opengis.annotation.UML;
037    import org.opengis.metadata.Identifier;
038    import org.opengis.metadata.citation.Citation;
039    import org.opengis.util.InternationalString;
040    
041    import static org.opengis.annotation.Obligation.*;
042    import static org.opengis.annotation.Specification.*;
043    
044    
045    /**
046     * Designations for the measuring instruments.
047     *
048     * @author  Cédric Briançon (Geomatys)
049     * @version 3.0
050     * @since   2.3
051     *
052     * @navassoc - - - Citation
053     * @navassoc 1 - - Identifier
054     * @navassoc 1 - - Platform
055     */
056    @UML(identifier="MI_Instrument", specification=ISO_19115_2)
057    public interface Instrument {
058        /**
059         * Complete citation of the instrument.
060         *
061         * @return Complete citation of the instrument.
062         */
063        @UML(identifier="citation", obligation=OPTIONAL, specification=ISO_19115_2)
064        Collection<? extends Citation> getCitations();
065    
066        /**
067         * Unique identification of the instrument.
068         *
069         * @return Unique identification of the instrument.
070         */
071        @UML(identifier="identifier", obligation=MANDATORY, specification=ISO_19115_2)
072        Identifier getIdentifier();
073    
074        /**
075         * Name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.
076         *
077         * @return Type of instrument.
078         */
079        @UML(identifier="type", obligation=MANDATORY, specification=ISO_19115_2)
080        InternationalString getType();
081    
082        /**
083         * Textual description of the instrument.
084         *
085         * @return Textual description.
086         */
087        @UML(identifier="description", obligation=OPTIONAL, specification=ISO_19115_2)
088        InternationalString getDescription();
089    
090        /**
091         * Platform on which the instrument is mounted.
092         *
093         * @return Platform on which the instrument is mounted.
094         */
095        @UML(identifier="mountedOn", obligation=OPTIONAL, specification=ISO_19115_2)
096        Platform getMountedOn();
097    }