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.metadata.identification;
033    
034    import java.net.URI;
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     * Graphic that provides an illustration of the dataset (should include a legend for the graphic).
044     *
045     * @author  Martin Desruisseaux (IRD)
046     * @version 3.0
047     * @since   2.0
048     *
049     * @navassoc 1 - - URI
050     */
051    @UML(identifier="MD_BrowseGraphic", specification=ISO_19115)
052    public interface BrowseGraphic {
053        /**
054         * Name of the file that contains a graphic that provides an illustration of the dataset.
055         *
056         * @return File that contains a graphic that provides an illustration of the dataset.
057         */
058        @UML(identifier="fileName", obligation=MANDATORY, specification=ISO_19115)
059        URI getFileName();
060    
061        /**
062         * Text description of the illustration.
063         *
064         * @return Text description of the illustration, or {@code null}.
065         */
066        @UML(identifier="fileDescription", obligation=OPTIONAL, specification=ISO_19115)
067        InternationalString getFileDescription();
068    
069        /**
070         * Format in which the illustration is encoded.
071         * Examples: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.
072         * Raster formats are encouraged to use one of the names returned by
073         * {@link javax.imageio.ImageIO#getReaderFormatNames()}.
074         *
075         * @return Format in which the illustration is encoded, or {@code null}.
076         *
077         * @see javax.imageio.ImageIO#getReaderFormatNames()
078         */
079        @UML(identifier="fileType", obligation=OPTIONAL, specification=ISO_19115)
080        String getFileType();
081    }